|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPageLayout
A page layout defines the initial layout for a page in a workbench org.eclipse.jface.window.
This interface is not intended to be implemented by clients.
When the workbench needs to create a new page, it uses a perspective to
creates a new page layout with a single editor area. This layout is then
passed to client code (implementation of
IPerspectiveFactory.createInitialLayout
) where
additional views can be added, using the existing editor area as the initial
point of reference.
Example of populating a layout with standard workbench views:
IPageLayout layout = ... // Get the editor area. String editorArea = layout.getEditorArea(); // Top left: Resource Navigator view and Bookmarks view placeholder IFolderLayout topLeft = layout.createFolder("topLeft", IPageLayout.LEFT, 0.25f, editorArea); topLeft.addView(IPageLayout.ID_RES_NAV); topLeft.addPlaceholder(IPageLayout.ID_BOOKMARKS); // Bottom left: Outline view and Property Sheet view IFolderLayout bottomLeft = layout.createFolder("bottomLeft", IPageLayout.BOTTOM, 0.50f, "topLeft"); bottomLeft.addView(IPageLayout.ID_OUTLINE); bottomLeft.addView(IPageLayout.ID_PROP_SHEET); // Bottom right: Task List view layout.addView(IPageLayout.ID_TASK_LIST, IPageLayout.BOTTOM, 0.66f, editorArea);
Field Summary | |
---|---|
static int |
BOTTOM
Relationship constant indicating a part should be placed below its relative. |
static float |
DEFAULT_FASTVIEW_RATIO
The default fast view ratio width. |
static float |
DEFAULT_VIEW_RATIO
The default view ratio width for regular (non-fast) views. |
static java.lang.String |
ID_BOOKMARKS
The view id for the workbench's Bookmark Navigator standard component. |
static java.lang.String |
ID_EDITOR_AREA
The part id for the workbench's editor area. |
static java.lang.String |
ID_NAVIGATE_ACTION_SET
Id of the navigate action set. |
static java.lang.String |
ID_OUTLINE
The view id for the workbench's Content Outline standard component. |
static java.lang.String |
ID_PROBLEM_VIEW
The view id for the workbench's Problems View standard component. |
static java.lang.String |
ID_PROP_SHEET
The view id for the workbench's Property Sheet standard component. |
static java.lang.String |
ID_RES_NAV
The view id for the workbench's Resource Navigator standard component. |
static java.lang.String |
ID_TASK_LIST
The view id for the workbench's Task List standard component. |
static float |
INVALID_RATIO
A variable used to represent invalid ratios. |
static int |
LEFT
Relationship constant indicating a part should be placed to the left of its relative. |
static float |
NULL_RATIO
A variable used to represent a ratio which has not been specified. |
static float |
RATIO_MAX
Maximum acceptable ratio value when adding a view |
static float |
RATIO_MIN
Minimum acceptable ratio value when adding a view |
static int |
RIGHT
Relationship constant indicating a part should be placed to the right of its relative. |
static int |
TOP
Relationship constant indicating a part should be placed above its relative. |
Method Summary | |
---|---|
void |
addActionSet(java.lang.String actionSetId)
Adds an action set with the given id to this page layout. |
void |
addFastView(java.lang.String id)
Adds the view with the given id to the page layout as a fast view. |
void |
addFastView(java.lang.String id,
float ratio)
Adds the view with the given id to the page layout as a fast view with the given width ratio. |
void |
addNewWizardShortcut(java.lang.String id)
Adds a new wizard shortcut to the page layout. |
void |
addPerspectiveShortcut(java.lang.String id)
Adds a perspective shortcut to the page layout. |
void |
addPlaceholder(java.lang.String viewId,
int relationship,
float ratio,
java.lang.String refId)
Adds a placeholder for a view with the given id to this page layout. |
void |
addShowInPart(java.lang.String id)
Adds an item to the Show In prompter. |
void |
addShowViewShortcut(java.lang.String id)
Adds a show view shortcut to the page layout. |
void |
addStandaloneView(java.lang.String viewId,
boolean showTitle,
int relationship,
float ratio,
java.lang.String refId)
Adds a standalone view with the given id to this page layout. |
void |
addView(java.lang.String viewId,
int relationship,
float ratio,
java.lang.String refId)
Adds a view with the given id to this page layout. |
IFolderLayout |
createFolder(java.lang.String folderId,
int relationship,
float ratio,
java.lang.String refId)
Creates and adds a new folder with the given id to this page layout. |
IPlaceholderFolderLayout |
createPlaceholderFolder(java.lang.String folderId,
int relationship,
float ratio,
java.lang.String refId)
Creates and adds a placeholder for a new folder with the given id to this page layout. |
java.lang.String |
getEditorArea()
Returns the special identifier for the editor area in this page layout. |
int |
getEditorReuseThreshold()
Deprecated. this always returns -1 as of Eclipse 2.1 |
IViewLayout |
getViewLayout(java.lang.String viewId)
Returns the layout for the view or placeholder with the given id in this page layout. |
boolean |
isEditorAreaVisible()
Returns whether the page's layout will show the editor area. |
boolean |
isFixed()
Returns true if this layout is fixed, false if not. |
void |
setEditorAreaVisible(boolean showEditorArea)
Show or hide the editor area for the page's layout. |
void |
setEditorReuseThreshold(int openEditors)
Deprecated. this method has no effect, as of Eclipse 2.1 |
void |
setFixed(boolean isFixed)
Sets whether this layout is fixed. |
Field Detail |
---|
static final java.lang.String ID_EDITOR_AREA
static final java.lang.String ID_RES_NAV
static final java.lang.String ID_PROP_SHEET
static final java.lang.String ID_OUTLINE
static final java.lang.String ID_BOOKMARKS
static final java.lang.String ID_PROBLEM_VIEW
static final java.lang.String ID_TASK_LIST
static final java.lang.String ID_NAVIGATE_ACTION_SET
"org.eclipse.ui.NavigateActionSet"
)
static final int LEFT
static final int RIGHT
static final int TOP
static final int BOTTOM
static final float RATIO_MIN
static final float RATIO_MAX
static final float DEFAULT_FASTVIEW_RATIO
static final float DEFAULT_VIEW_RATIO
static final float INVALID_RATIO
static final float NULL_RATIO
Method Detail |
---|
void addActionSet(java.lang.String actionSetId)
"org.eclipse.ui.actionSet"
).
actionSetId
- the action set idvoid addFastView(java.lang.String id)
"org.eclipse.ui.views"
).
id
- the id of the view to be addedvoid addFastView(java.lang.String id, float ratio)
"org.eclipse.ui.views"
).
id
- the id of the view to be addedratio
- the percentage of the workbench the fast view will covervoid addNewWizardShortcut(java.lang.String id)
"org.eclipse.ui.newWizards"
).
id
- the wizard idvoid addPerspectiveShortcut(java.lang.String id)
"org.eclipse.ui.perspectives"
).
id
- the perspective idvoid addPlaceholder(java.lang.String viewId, int relationship, float ratio, java.lang.String refId)
"org.eclipse.ui.views"
).
viewId
- the view idrelationship
- the position relative to the reference part;
one of TOP
, BOTTOM
, LEFT
,
or RIGHT
ratio
- a ratio specifying how to divide the space currently occupied by the reference part,
in the range 0.05f
to 0.95f
.
Values outside this range will be clipped to facilitate direct manipulation.
For a vertical split, the part on top gets the specified ratio of the current space
and the part on bottom gets the rest.
Likewise, for a horizontal split, the part at left gets the specified ratio of the current space
and the part at right gets the rest.refId
- the id of the reference part; either a view id, a folder id,
or the special editor area id returned by getEditorArea
void addShowInPart(java.lang.String id)
"org.eclipse.ui.views"
).
id
- the view idvoid addShowViewShortcut(java.lang.String id)
"org.eclipse.ui.views"
).
id
- the view idvoid addView(java.lang.String viewId, int relationship, float ratio, java.lang.String refId)
"org.eclipse.ui.views"
).
viewId
- the view idrelationship
- the position relative to the reference part;
one of TOP
, BOTTOM
, LEFT
,
or RIGHT
ratio
- a ratio specifying how to divide the space currently occupied by the reference part,
in the range 0.05f
to 0.95f
.
Values outside this range will be clipped to facilitate direct manipulation.
For a vertical split, the part on top gets the specified ratio of the current space
and the part on bottom gets the rest.
Likewise, for a horizontal split, the part at left gets the specified ratio of the current space
and the part at right gets the rest.refId
- the id of the reference part; either a view id, a folder id,
or the special editor area id returned by getEditorArea
IFolderLayout createFolder(java.lang.String folderId, int relationship, float ratio, java.lang.String refId)
folderId
- the id for the new folder. This must be unique within
the layout to avoid collision with other parts.relationship
- the position relative to the reference part;
one of TOP
, BOTTOM
, LEFT
,
or RIGHT
ratio
- a ratio specifying how to divide the space currently occupied by the reference part,
in the range 0.05f
to 0.95f
.
Values outside this range will be clipped to facilitate direct manipulation.
For a vertical split, the part on top gets the specified ratio of the current space
and the part on bottom gets the rest.
Likewise, for a horizontal split, the part at left gets the specified ratio of the current space
and the part at right gets the rest.refId
- the id of the reference part; either a view id, a folder id,
or the special editor area id returned by getEditorArea
IPlaceholderFolderLayout createPlaceholderFolder(java.lang.String folderId, int relationship, float ratio, java.lang.String refId)
folderId
- the id for the new folder. This must be unique within
the layout to avoid collision with other parts.relationship
- the position relative to the reference part;
one of TOP
, BOTTOM
, LEFT
,
or RIGHT
ratio
- a ratio specifying how to divide the space currently occupied by the reference part,
in the range 0.05f
to 0.95f
.
Values outside this range will be clipped to facilitate direct manipulation.
For a vertical split, the part on top gets the specified ratio of the current space
and the part on bottom gets the rest.
Likewise, for a horizontal split, the part at left gets the specified ratio of the current space
and the part at right gets the rest.refId
- the id of the reference part; either a view id, a folder id,
or the special editor area id returned by getEditorArea
java.lang.String getEditorArea()
ID_EDITOR_AREA
.
The editor area is automatically added to each layout before anything else. It should be used as the point of reference when adding views to a layout.
boolean isEditorAreaVisible()
true
when editor area visible, false
otherwisevoid setEditorAreaVisible(boolean showEditorArea)
showEditorArea
- true
to show the editor area, false
to hide the editor areaint getEditorReuseThreshold()
void setEditorReuseThreshold(int openEditors)
openEditors
- the number of open editorsvoid setFixed(boolean isFixed)
isFixed
- true
if this layout is fixed, false
if notboolean isFixed()
true
if this layout is fixed, false
if not.
In a fixed layout, layout parts cannot be moved or zoomed, and the initial
set of views cannot be closed.
The default is false
.
true
if this layout is fixed, false
if not.IViewLayout getViewLayout(java.lang.String viewId)
null
if the specified view or placeholder is unknown to the layout.
viewId
- the view id
null
void addStandaloneView(java.lang.String viewId, boolean showTitle, int relationship, float ratio, java.lang.String refId)
The id must name a view contributed to the workbench's view extension point
(named "org.eclipse.ui.views"
).
viewId
- the view idshowTitle
- true
to show the title and related controls,
false
to hide themrelationship
- the position relative to the reference part;
one of TOP
, BOTTOM
, LEFT
,
or RIGHT
ratio
- a ratio specifying how to divide the space currently occupied by the reference part,
in the range 0.05f
to 0.95f
.
Values outside this range will be clipped to facilitate direct manipulation.
For a vertical split, the part on top gets the specified ratio of the current space
and the part on bottom gets the rest.
Likewise, for a horizontal split, the part at left gets the specified ratio of the current space
and the part at right gets the rest.refId
- the id of the reference part; either a view id, a folder id,
or the special editor area id returned by getEditorArea
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |