|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A page layout defines the initial layout for a perspective within a page in a workbench window.
This interface is not intended to be implemented by clients.
When a perspective is opened, it creates a new page layout with a single editor area.
This layout is then passed to the perspective factory (implementation of
IPerspectiveFactory.createInitialLayout(IPageLayout)
) where
additional views and other content can be added, using the existing editor area as
the initial point of reference.
In some cases, multiple instances of a particular view may need to be added
to the same layout. These are disambiguated using a secondary id.
In layout methods taking a view id, the id can have the compound form:
primaryId [':' secondaryId].
If a secondary id is given, the view must allow multiple instances by
having specified allowMultiple="true"
in its extension.
View placeholders may also have a secondary id.
Wildcards are permitted in placeholder ids (but not regular view ids). '*' matches any substring, '?' matches any single character. Wildcards can be specified for the primary id, the secondary id, or both. For example, the placeholder "someView:*" will match any occurrence of the view that has primary id "someView" and that also has some non-null secondary id. Note that this placeholder will not match the view if it has no secondary id, since the compound id in this case is simply "someView".
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 String |
ID_BOOKMARKS
The view id for the workbench's Bookmark Navigator standard component. |
static String |
ID_EDITOR_AREA
The part id for the workbench's editor area. |
static String |
ID_NAVIGATE_ACTION_SET
Id of the navigate action set. |
static String |
ID_OUTLINE
The view id for the workbench's Content Outline standard component. |
static String |
ID_PROBLEM_VIEW
The view id for the workbench's Problems View standard component. |
static String |
ID_PROP_SHEET
The view id for the workbench's Property Sheet standard component. |
static String |
ID_RES_NAV
The view id for the workbench's Resource Navigator standard component. |
static 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(String actionSetId)
Adds an action set with the given id to this page layout. |
void |
addFastView(String viewId)
Adds the view with the given compound id to the page layout as a fast view. |
void |
addFastView(String viewId,
float ratio)
Adds the view with the given compound id to the page layout as a fast view with the given width ratio. |
void |
addNewWizardShortcut(String id)
Adds a new wizard shortcut to the page layout. |
void |
addPerspectiveShortcut(String id)
Adds a perspective shortcut to the page layout. |
void |
addPlaceholder(String viewId,
int relationship,
float ratio,
String refId)
Adds a view placeholder to this page layout. |
void |
addShowInPart(String id)
Adds an item to the Show In prompter. |
void |
addShowViewShortcut(String id)
Adds a show view shortcut to the page layout. |
void |
addStandaloneView(String viewId,
boolean showTitle,
int relationship,
float ratio,
String refId)
Adds a standalone view with the given compound id to this page layout. |
void |
addView(String viewId,
int relationship,
float ratio,
String refId)
Adds a view with the given compound id to this page layout. |
IFolderLayout |
createFolder(String folderId,
int relationship,
float ratio,
String refId)
Creates and adds a new folder with the given id to this page layout. |
IPlaceholderFolderLayout |
createPlaceholderFolder(String folderId,
int relationship,
float ratio,
String refId)
Creates and adds a placeholder for a new folder with the given id to this page layout. |
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(String id)
Returns the layout for the view or placeholder with the given compound 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 |
public static final String ID_EDITOR_AREA
public static final String ID_RES_NAV
public static final String ID_PROP_SHEET
public static final String ID_OUTLINE
public static final String ID_BOOKMARKS
public static final String ID_PROBLEM_VIEW
public static final String ID_TASK_LIST
public static final String ID_NAVIGATE_ACTION_SET
"org.eclipse.ui.NavigateActionSet"
)
public static final int LEFT
public static final int RIGHT
public static final int TOP
public static final int BOTTOM
public static final float RATIO_MIN
public static final float RATIO_MAX
public static final float DEFAULT_FASTVIEW_RATIO
public static final float DEFAULT_VIEW_RATIO
public static final float INVALID_RATIO
public static final float NULL_RATIO
Method Detail |
public void addActionSet(String actionSetId)
"org.eclipse.ui.actionSet"
).
actionSetId
- the action set idpublic void addFastView(String viewId)
IPageLayout
type documentation for more details about compound ids.
The primary id must name a view contributed to the workbench's view extension
point (named "org.eclipse.ui.views"
).
viewId
- the compound id of the view to be addedpublic void addFastView(String viewId, float ratio)
IPageLayout
type documentation for more details about compound ids.
The primary id must name a view contributed to the workbench's view extension
point (named "org.eclipse.ui.views"
).
viewId
- the compound id of the view to be addedratio
- the percentage of the workbench the fast view will coverpublic void addNewWizardShortcut(String id)
"org.eclipse.ui.newWizards"
).
id
- the wizard idpublic void addPerspectiveShortcut(String id)
"org.eclipse.ui.perspectives"
).
id
- the perspective idpublic void addPlaceholder(String viewId, int relationship, float ratio, String refId)
IPageLayout
type documentation for more details about compound ids.
If the placeholder contains wildcards, it remains in the layout, otherwise
it is replaced by the view.
If the primary id of the placeholder has no wildcards, it must refer to a view
contributed to the workbench's view extension point
(named "org.eclipse.ui.views"
).
viewId
- the compound view id (wildcards allowed)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
public void addShowInPart(String id)
"org.eclipse.ui.views"
).
id
- the view idpublic void addShowViewShortcut(String id)
"org.eclipse.ui.views"
).
id
- the view idpublic void addView(String viewId, int relationship, float ratio, String refId)
IPageLayout
type documentation for more details about compound ids.
The primary id must name a view contributed to the workbench's view extension point
(named "org.eclipse.ui.views"
).
viewId
- the compound 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
public IFolderLayout createFolder(String folderId, int relationship, float ratio, 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
public IPlaceholderFolderLayout createPlaceholderFolder(String folderId, int relationship, float ratio, 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
public 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.
public boolean isEditorAreaVisible()
true
when editor area visible, false
otherwisepublic void setEditorAreaVisible(boolean showEditorArea)
showEditorArea
- true
to show the editor area, false
to hide the editor areapublic int getEditorReuseThreshold()
public void setEditorReuseThreshold(int openEditors)
openEditors
- the number of open editorspublic void setFixed(boolean isFixed)
isFixed
- true
if this layout is fixed, false
if notpublic boolean 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.public IViewLayout getViewLayout(String id)
IPageLayout
type documentation for more details about compound ids.
Returns null
if the specified view or placeholder is unknown to the layout.
id
- the compound view id or placeholder
null
public void addStandaloneView(String viewId, boolean showTitle, int relationship, float ratio, String refId)
IPageLayout
type documentation for more details about compound ids.
A standalone view cannot be docked together with other views.
A standalone view's title can optionally be hidden. If hidden,
then any controls typically shown with the title (such as the close button)
are also hidden. Any contributions or other content from the view itself
are always shown (e.g. toolbar or view menu contributions, content description).
The id must name a view contributed to the workbench's view extension point
(named "org.eclipse.ui.views"
).
viewId
- the compound 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
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.