Eclipse Platform
Release 3.7

org.eclipse.ui
Interface IWorkbenchPage

All Superinterfaces:
org.eclipse.ui.internal.ICompatibleWorkbenchPage, IPartService, ISelectionService

public interface IWorkbenchPage
extends IPartService, ISelectionService, org.eclipse.ui.internal.ICompatibleWorkbenchPage

A workbench page consists of an arrangement of views and editors intended to be presented together to the user in a single workbench window.

A page can contain 0 or more views and 0 or more editors. These views and editors are contained wholly within the page and are not shared with other pages. The layout and visible action set for the page is defined by a perspective.

The number of views and editors within a page is restricted to simplify part management for the user. In particular:

This interface is not intended to be implemented by clients.

See Also:
IPerspectiveDescriptor, IEditorPart, IViewPart
Restriction:
This interface is not intended to be implemented by clients.

Field Summary
static String CHANGE_ACTION_SET_HIDE
          Change event id when an action set is hidden in a perspective.
static String CHANGE_ACTION_SET_SHOW
          Change event id when an action set is shown in a perspective.
static String CHANGE_EDITOR_AREA_HIDE
          Change event id when the editor area is hidden in a perspective.
static String CHANGE_EDITOR_AREA_SHOW
          Change event id when the editor area is shown in a perspective.
static String CHANGE_EDITOR_CLOSE
          Change event id when one or more editors are closed in a perspective.
static String CHANGE_EDITOR_OPEN
          Change event id when one or more editors are opened in a perspective.
static String CHANGE_FAST_VIEW_ADD
          Change event id when a fast view is added in a perspective.
static String CHANGE_FAST_VIEW_REMOVE
          Change event id when a fast view is removed in a perspective.
static String CHANGE_RESET
          Change event id when the perspective is reset to its original state.
static String CHANGE_RESET_COMPLETE
          Change event id when the perspective has completed a reset to its original state.
static String CHANGE_VIEW_HIDE
          Change event id when one or more views are hidden in a perspective.
static String CHANGE_VIEW_SHOW
          Change event id when one or more views are shown in a perspective.
static String CHANGE_WORKING_SET_REPLACE
          Change event id when the page working set was replaced
static String CHANGE_WORKING_SETS_REPLACE
          Change event id when the page working set list was replaced
static String EDITOR_ID_ATTR
          Deprecated. in 3.0 since the notion of markers this is not generally applicable. Use the IDE-specific constant IDE.EDITOR_ID_ATTR.
static int MATCH_ID
          Editor opening match mode specifying that the editor id should be considered when matching against existing editors.
static int MATCH_INPUT
          Editor opening match mode specifying that the editor input should be considered when matching against existing editors.
static int MATCH_NONE
          Editor opening match mode specifying that no matching against existing editors should be done.
static int STATE_MAXIMIZED
          State of a view in a given page when the page is zoomed in on the view stack.
static int STATE_MINIMIZED
          State of a view in a given page when the view stack is minimized.
static int STATE_RESTORED
          State of a view in a given page when the view stack is in it's normal state.
static int VIEW_ACTIVATE
          Show view mode that indicates the view should be made visible and activated.
static int VIEW_CREATE
          Show view mode that indicates the view should be made created but not necessarily be made visible.
static int VIEW_VISIBLE
          Show view mode that indicates the view should be made visible.
 
Method Summary
 void activate(IWorkbenchPart part)
          Activates the given part.
 void addPropertyChangeListener(IPropertyChangeListener listener)
          Deprecated. client should register listeners on the instance of IWorkingSetManager returned by IWorkbench.getWorkingSetManager() instead.
 void bringToTop(IWorkbenchPart part)
          Moves the given part forward in the Z order of this page so as to make it visible, without changing which part has focus.
 boolean close()
          Closes this workbench page.
 boolean closeAllEditors(boolean save)
          Closes all of the editors belonging to this workbench page.
 void closeAllPerspectives(boolean saveEditors, boolean closePage)
          Closes all perspectives in this page.
 boolean closeEditor(IEditorPart editor, boolean save)
          Closes the given editor.
 boolean closeEditors(IEditorReference[] editorRefs, boolean save)
          Closes the given Array of editor references.
 void closePerspective(IPerspectiveDescriptor desc, boolean saveParts, boolean closePage)
          Closes the specified perspective in this page.
 IEditorPart findEditor(IEditorInput input)
          Returns the editor with the specified input.
 IEditorReference[] findEditors(IEditorInput input, String editorId, int matchFlags)
          Returns an array of editor references that match the given input and/or editor id, as specified by the given match flags.
 IViewPart findView(String viewId)
          Returns the view in this page with the specified id.
 IViewReference findViewReference(String viewId)
          Returns the view reference with the specified id.
 IViewReference findViewReference(String viewId, String secondaryId)
          Returns the view reference with the specified id and secondary id.
 IEditorPart getActiveEditor()
          Returns the active editor open in this page.
 IWorkingSet getAggregateWorkingSet()
          Return a working set that contains all of the elements contained in the array of working sets provided by getWorkingSets().
 IEditorPart[] getDirtyEditors()
          Returns a list of dirty editors in this page.
 IEditorReference[] getEditorReferences()
          Returns an array of references to open editors in this page.
 int getEditorReuseThreshold()
          Deprecated.  
 IEditorPart[] getEditors()
          Deprecated. Clients are encouraged to use getEditorReferences() instead. Calling this method has the side effect of restoring all the editors in the page which can cause plug-in activation.
 IExtensionTracker getExtensionTracker()
           Return the extension tracker for the workbench.
 IAdaptable getInput()
          Returns the input for this page.
 String getLabel()
          Returns the page label.
 INavigationHistory getNavigationHistory()
          Returns the navigation history which manages a list of entries keeping the history of places (positions, selection and editors) the user visited making it easier to the user to move back and forward without losing context.
 String[] getNewWizardShortcuts()
          Returns the new wizard shortcuts associated with the current perspective.
 IPerspectiveDescriptor[] getOpenPerspectives()
          Returns the descriptors for the perspectives that are open in this page, in the order in which they were opened.
 int getPartState(IWorkbenchPartReference ref)
          Returns the maximized/minimized/restored state of the given part reference.
 IPerspectiveDescriptor getPerspective()
          Returns the current perspective descriptor for this page, or null if there is no current perspective.
 String[] getPerspectiveShortcuts()
          Returns the perspective shortcuts associated with the current perspective.
 IWorkbenchPartReference getReference(IWorkbenchPart part)
          Find the part reference for the given part.
 String[] getShowViewShortcuts()
          Returns the show view shortcuts associated with the current perspective.
 IPerspectiveDescriptor[] getSortedPerspectives()
          Returns the descriptors for the perspectives that are open in this page, in the order in which they were activated (oldest first).
 IViewReference[] getViewReferences()
          Returns a list of the reference to views visible on this page.
 IViewPart[] getViews()
          Deprecated. Clients are encouraged to use getViewReferences() instead. Calling this method has the side effect of restoring all the views in the page which can cause plug-in activation.
 IViewPart[] getViewStack(IViewPart part)
          Returns an array of IViewParts that are stacked with the given part.
 IWorkbenchWindow getWorkbenchWindow()
          Returns the workbench window of this page.
 IWorkingSet getWorkingSet()
          Deprecated. individual views should store a working set if needed
 IWorkingSet[] getWorkingSets()
          Return the visible working sets for this page.
 void hideActionSet(String actionSetID)
          Hides an action set in this page.
 void hideEditor(IEditorReference ref)
          Remove an open editor, turn it into a non-participating editor.
 void hideView(IViewPart view)
          Hides the given view.
 void hideView(IViewReference view)
          Hides the given view that belongs to the reference, if any.
 boolean isEditorAreaVisible()
          Returns whether the page's current perspective is showing the editor area.
 boolean isEditorPinned(IEditorPart editor)
          Returns true if the editor is pinned and should not be reused.
 boolean isPageZoomed()
          Returns the page "zoomed" state.
 boolean isPartVisible(IWorkbenchPart part)
          Returns whether the specified part is visible.
 IEditorPart openEditor(IEditorInput input, String editorId)
          Opens an editor on the given input.
 IEditorPart openEditor(IEditorInput input, String editorId, boolean activate)
          Opens an editor on the given input.
 IEditorPart openEditor(IEditorInput input, String editorId, boolean activate, int matchFlags)
          Opens an editor on the given input.
 IEditorReference[] openEditors(IEditorInput[] inputs, String[] editorIDs, int matchFlags)
          Opens editors for the given inputs.
 void removePropertyChangeListener(IPropertyChangeListener listener)
          Removes the property change listener.
 void resetPerspective()
          Changes the visible views, their layout, and the visible action sets within the page to match the current perspective descriptor.
 void reuseEditor(IReusableEditor editor, IEditorInput input)
          Reuses the specified editor by setting its new input.
 boolean saveAllEditors(boolean confirm)
          Saves the contents of all dirty editors belonging to this workbench page.
 boolean saveEditor(IEditorPart editor, boolean confirm)
          Saves the contents of the given editor if dirty.
 void savePerspective()
          Saves the visible views, their layout, and the visible action sets for this page to the current perspective descriptor.
 void savePerspectiveAs(IPerspectiveDescriptor perspective)
          Saves the visible views, their layout, and the visible action sets for this page to the given perspective descriptor.
 void setEditorAreaVisible(boolean showEditorArea)
          Show or hide the editor area for the page's active perspective.
 void setEditorReuseThreshold(int openEditors)
          Deprecated. use IPageLayout.setEditorReuseThreshold(int openEditors) instead.
 void setPartState(IWorkbenchPartReference ref, int state)
          Set the state of the given part reference.
 void setPerspective(IPerspectiveDescriptor perspective)
          Changes the visible views, their layout, and the visible action sets within the page to match the given perspective descriptor.
 void setWorkingSets(IWorkingSet[] sets)
          Set the working sets for this page.
 void showActionSet(String actionSetID)
          Shows an action set in this page.
 void showEditor(IEditorReference ref)
          Add back an open but non-participating editor
 IViewPart showView(String viewId)
          Shows the view identified by the given view id in this page and gives it focus.
 IViewPart showView(String viewId, String secondaryId, int mode)
          Shows a view in this page with the given id and secondary id.
 void toggleZoom(IWorkbenchPartReference ref)
          Zoom the page in on a part.
 void zoomOut()
          Zooms out the zoomed-in part.
 
Methods inherited from interface org.eclipse.ui.IPartService
addPartListener, addPartListener, getActivePart, getActivePartReference, removePartListener, removePartListener
 
Methods inherited from interface org.eclipse.ui.ISelectionService
addPostSelectionListener, addPostSelectionListener, addSelectionListener, addSelectionListener, getSelection, getSelection, removePostSelectionListener, removePostSelectionListener, removeSelectionListener, removeSelectionListener
 

Field Detail

EDITOR_ID_ATTR

static final String EDITOR_ID_ATTR
Deprecated. in 3.0 since the notion of markers this is not generally applicable. Use the IDE-specific constant IDE.EDITOR_ID_ATTR.
An optional attribute within a workspace marker (IMarker) which identifies the preferred editor type to be opened when openEditor is called.

See Also:
openEditor(IEditorInput, String), openEditor(IEditorInput, String, boolean), Constant Field Values

CHANGE_RESET

static final String CHANGE_RESET
Change event id when the perspective is reset to its original state.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_RESET_COMPLETE

static final String CHANGE_RESET_COMPLETE
Change event id when the perspective has completed a reset to its original state.

Since:
3.0
See Also:
IPerspectiveListener, Constant Field Values

CHANGE_VIEW_SHOW

static final String CHANGE_VIEW_SHOW
Change event id when one or more views are shown in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_VIEW_HIDE

static final String CHANGE_VIEW_HIDE
Change event id when one or more views are hidden in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_EDITOR_OPEN

static final String CHANGE_EDITOR_OPEN
Change event id when one or more editors are opened in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_EDITOR_CLOSE

static final String CHANGE_EDITOR_CLOSE
Change event id when one or more editors are closed in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_EDITOR_AREA_SHOW

static final String CHANGE_EDITOR_AREA_SHOW
Change event id when the editor area is shown in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_EDITOR_AREA_HIDE

static final String CHANGE_EDITOR_AREA_HIDE
Change event id when the editor area is hidden in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_ACTION_SET_SHOW

static final String CHANGE_ACTION_SET_SHOW
Change event id when an action set is shown in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_ACTION_SET_HIDE

static final String CHANGE_ACTION_SET_HIDE
Change event id when an action set is hidden in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_FAST_VIEW_ADD

static final String CHANGE_FAST_VIEW_ADD
Change event id when a fast view is added in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_FAST_VIEW_REMOVE

static final String CHANGE_FAST_VIEW_REMOVE
Change event id when a fast view is removed in a perspective.

See Also:
IPerspectiveListener, Constant Field Values

CHANGE_WORKING_SET_REPLACE

static final String CHANGE_WORKING_SET_REPLACE
Change event id when the page working set was replaced

See Also:
IPropertyChangeListener, Constant Field Values

CHANGE_WORKING_SETS_REPLACE

static final String CHANGE_WORKING_SETS_REPLACE
Change event id when the page working set list was replaced

Since:
3.2
See Also:
IPropertyChangeListener, Constant Field Values

VIEW_ACTIVATE

static final int VIEW_ACTIVATE
Show view mode that indicates the view should be made visible and activated. Use of this mode has the same effect as calling showView(String).

Since:
3.0
See Also:
Constant Field Values

VIEW_VISIBLE

static final int VIEW_VISIBLE
Show view mode that indicates the view should be made visible. If the view is opened in the container that contains the active view then this has the same effect as VIEW_CREATE.

Since:
3.0
See Also:
Constant Field Values

VIEW_CREATE

static final int VIEW_CREATE
Show view mode that indicates the view should be made created but not necessarily be made visible. It will only be made visible in the event that it is opened in its own container. In other words, only if it is not stacked with another view.

Since:
3.0
See Also:
Constant Field Values

MATCH_NONE

static final int MATCH_NONE
Editor opening match mode specifying that no matching against existing editors should be done.

Since:
3.2
See Also:
Constant Field Values

MATCH_INPUT

static final int MATCH_INPUT
Editor opening match mode specifying that the editor input should be considered when matching against existing editors.

Since:
3.2
See Also:
Constant Field Values

MATCH_ID

static final int MATCH_ID
Editor opening match mode specifying that the editor id should be considered when matching against existing editors.

Since:
3.2
See Also:
Constant Field Values

STATE_MINIMIZED

static final int STATE_MINIMIZED
State of a view in a given page when the view stack is minimized.

Since:
3.2
See Also:
Constant Field Values

STATE_MAXIMIZED

static final int STATE_MAXIMIZED
State of a view in a given page when the page is zoomed in on the view stack.

Since:
3.2
See Also:
Constant Field Values

STATE_RESTORED

static final int STATE_RESTORED
State of a view in a given page when the view stack is in it's normal state.

Since:
3.2
See Also:
Constant Field Values
Method Detail

activate

void activate(IWorkbenchPart part)
Activates the given part. The part will be brought to the front and given focus. The part must belong to this page.

Parameters:
part - the part to activate

addPropertyChangeListener

void addPropertyChangeListener(IPropertyChangeListener listener)
Deprecated. client should register listeners on the instance of IWorkingSetManager returned by IWorkbench.getWorkingSetManager() instead.

Adds a property change listener.

Parameters:
listener - the property change listener to add
Since:
2.0

bringToTop

void bringToTop(IWorkbenchPart part)
Moves the given part forward in the Z order of this page so as to make it visible, without changing which part has focus. The part must belong to this page.

Parameters:
part - the part to bring forward

close

boolean close()
Closes this workbench page. If this page is the active one, this honor is passed along to one of the window's other pages if possible.

If the page has an open editor with unsaved content, the user will be given the opportunity to save it.

Returns:
true if the page was successfully closed, and false if it is still open

closeAllEditors

boolean closeAllEditors(boolean save)
Closes all of the editors belonging to this workbench page.

If the page has open editors with unsaved content and save is true, the user will be given the opportunity to save them.

Parameters:
save -
Returns:
true if all editors were successfully closed, and false if at least one is still open

closeEditors

boolean closeEditors(IEditorReference[] editorRefs,
                     boolean save)
Closes the given Array of editor references. The editors must belong to this workbench page.

If any of the editors have unsaved content and save is true, the user will be given the opportunity to save them.

Parameters:
editorRefs - the editors to close
save - true to save the editor contents if required (recommended), and false to discard any unsaved changes
Returns:
true if the editors were successfully closed, and false if the editors are still open
Since:
3.0

closeEditor

boolean closeEditor(IEditorPart editor,
                    boolean save)
Closes the given editor. The editor must belong to this workbench page.

If the editor has unsaved content and save is true, the user will be given the opportunity to save it.

Parameters:
editor - the editor to close
save - true to save the editor contents if required (recommended), and false to discard any unsaved changes
Returns:
true if the editor was successfully closed, and false if the editor is still open

findView

IViewPart findView(String viewId)
Returns the view in this page with the specified id. There is at most one view in the page with the specified id.

Parameters:
viewId - the id of the view extension to use
Returns:
the view, or null if none is found

findViewReference

IViewReference findViewReference(String viewId)
Returns the view reference with the specified id.

Parameters:
viewId - the id of the view extension to use
Returns:
the view reference, or null if none is found
Since:
3.0

findViewReference

IViewReference findViewReference(String viewId,
                                 String secondaryId)
Returns the view reference with the specified id and secondary id.

Parameters:
viewId - the id of the view extension to use
secondaryId - the secondary id to use, or null for no secondary id
Returns:
the view reference, or null if none is found
Since:
3.0

getActiveEditor

IEditorPart getActiveEditor()
Returns the active editor open in this page.

This is the visible editor on the page, or, if there is more than one visible editor, this is the one most recently brought to top.

Returns:
the active editor, or null if no editor is active

findEditor

IEditorPart findEditor(IEditorInput input)
Returns the editor with the specified input. Returns null if there is no opened editor with that input.

Parameters:
input - the editor input
Returns:
an editor with input equals to input

findEditors

IEditorReference[] findEditors(IEditorInput input,
                               String editorId,
                               int matchFlags)
Returns an array of editor references that match the given input and/or editor id, as specified by the given match flags. Returns an empty array if there are no matching editors, or if matchFlags is MATCH_NONE.

Parameters:
input - the editor input, or null if MATCH_INPUT is not specified in matchFlags
editorId - the editor id, or null if MATCH_ID is not specified in matchFlags
matchFlags - a bit mask consisting of zero or more of the MATCH_* constants OR-ed together
Returns:
the references for the matching editors
Since:
3.2
See Also:
MATCH_NONE, MATCH_INPUT, MATCH_ID

getEditors

IEditorPart[] getEditors()
Deprecated. Clients are encouraged to use getEditorReferences() instead. Calling this method has the side effect of restoring all the editors in the page which can cause plug-in activation.

Returns a list of the editors open in this page.

Note that each page has its own editors; editors are never shared between pages.

Returns:
a list of open editors

getEditorReferences

IEditorReference[] getEditorReferences()
Returns an array of references to open editors in this page.

Note that each page has its own editors; editors are never shared between pages.

Returns:
a list of open editors

getDirtyEditors

IEditorPart[] getDirtyEditors()
Returns a list of dirty editors in this page.

Returns:
a list of dirty editors

getInput

IAdaptable getInput()
Returns the input for this page.

Returns:
the input for this page, or null if none

getLabel

String getLabel()
Returns the page label. This will be a unique identifier within the containing workbench window.

Returns:
the page label

getPerspective

IPerspectiveDescriptor getPerspective()
Returns the current perspective descriptor for this page, or null if there is no current perspective.

Returns:
the current perspective descriptor or null
See Also:
setPerspective(org.eclipse.ui.IPerspectiveDescriptor), savePerspective()

getViewReferences

IViewReference[] getViewReferences()
Returns a list of the reference to views visible on this page.

Note that each page has its own views; views are never shared between pages.

Returns:
a list of references to visible views

getViews

IViewPart[] getViews()
Deprecated. Clients are encouraged to use getViewReferences() instead. Calling this method has the side effect of restoring all the views in the page which can cause plug-in activation.

Returns a list of the views visible on this page.

Note that each page has its own views; views are never shared between pages.

Returns:
a list of visible views

getWorkbenchWindow

IWorkbenchWindow getWorkbenchWindow()
Returns the workbench window of this page.

Returns:
the workbench window

getWorkingSet

IWorkingSet getWorkingSet()
Deprecated. individual views should store a working set if needed

Returns the working set of this page.

Returns:
the working set of this page.
Since:
2.0

hideActionSet

void hideActionSet(String actionSetID)
Hides an action set in this page.

In most cases where this method is used the caller is tightly coupled to a particular action set. They define it in the registry and may make it visible in certain scenarios by calling showActionSet. A static variable is often used to identify the action set id in caller code.

Parameters:
actionSetID - the action set to hide

hideView

void hideView(IViewPart view)
Hides the given view. The view must belong to this page.

Parameters:
view - the view to hide

hideView

void hideView(IViewReference view)
Hides the given view that belongs to the reference, if any.

Parameters:
view - the references whos view is to be hidden
Since:
3.0

isPartVisible

boolean isPartVisible(IWorkbenchPart part)
Returns whether the specified part is visible.

Parameters:
part - the part to test
Returns:
boolean true if part is visible

isEditorAreaVisible

boolean isEditorAreaVisible()
Returns whether the page's current perspective is showing the editor area.

Returns:
true when editor area visible, false otherwise

reuseEditor

void reuseEditor(IReusableEditor editor,
                 IEditorInput input)
Reuses the specified editor by setting its new input.

Parameters:
editor - the editor to be reused
input - the new input for the reusable editor

openEditor

IEditorPart openEditor(IEditorInput input,
                       String editorId)
                       throws PartInitException
Opens an editor on the given input.

If this page already has an editor open on the target input that editor is activated; otherwise, a new editor is opened. Two editor inputs, input1 and input2, are considered the same if

 input1.equals(input2) == true
 
.

The editor type is determined by mapping editorId to an editor extension registered with the workbench. An editor id is passed rather than an editor object to prevent the accidental creation of more than one editor for the same input. It also guarantees a consistent lifecycle for editors, regardless of whether they are created by the user or restored from saved data.

Parameters:
input - the editor input
editorId - the id of the editor extension to use
Returns:
an open and active editor, or null if an external editor was opened
Throws:
PartInitException - if the editor could not be created or initialized

openEditor

IEditorPart openEditor(IEditorInput input,
                       String editorId,
                       boolean activate)
                       throws PartInitException
Opens an editor on the given input.

If this page already has an editor open on the target input that editor is brought to the front; otherwise, a new editor is opened. Two editor inputs are considered the same if they equal. See Object.equals(Object) and IEditorInput. If activate == true the editor will be activated.

The editor type is determined by mapping editorId to an editor extension registered with the workbench. An editor id is passed rather than an editor object to prevent the accidental creation of more than one editor for the same input. It also guarantees a consistent lifecycle for editors, regardless of whether they are created by the user or restored from saved data.

Parameters:
input - the editor input
editorId - the id of the editor extension to use
activate - if true the editor will be activated
Returns:
an open editor, or null if an external editor was opened
Throws:
PartInitException - if the editor could not be created or initialized

openEditor

IEditorPart openEditor(IEditorInput input,
                       String editorId,
                       boolean activate,
                       int matchFlags)
                       throws PartInitException
Opens an editor on the given input.

If this page already has an editor open that matches the given input and/or editor id (as specified by the matchFlags argument), that editor is brought to the front; otherwise, a new editor is opened. Two editor inputs are considered the same if they equal. See Object.equals(Object) and IEditorInput. If activate == true the editor will be activated.

The editor type is determined by mapping editorId to an editor extension registered with the workbench. An editor id is passed rather than an editor object to prevent the accidental creation of more than one editor for the same input. It also guarantees a consistent lifecycle for editors, regardless of whether they are created by the user or restored from saved data.

Parameters:
input - the editor input
editorId - the id of the editor extension to use
activate - if true the editor will be activated
matchFlags - a bit mask consisting of zero or more of the MATCH_* constants OR-ed together
Returns:
an open editor, or null if an external editor was opened
Throws:
PartInitException - if the editor could not be created or initialized
Since:
3.2
See Also:
MATCH_NONE, MATCH_INPUT, MATCH_ID

removePropertyChangeListener

void removePropertyChangeListener(IPropertyChangeListener listener)
Removes the property change listener.

Parameters:
listener - the property change listener to remove
Since:
2.0

resetPerspective

void resetPerspective()
Changes the visible views, their layout, and the visible action sets within the page to match the current perspective descriptor. This is a rearrangement of components and not a replacement. The contents of the current perspective descriptor are unaffected.

For more information on perspective change see setPerspective().


saveAllEditors

boolean saveAllEditors(boolean confirm)
Saves the contents of all dirty editors belonging to this workbench page. If there are no dirty editors this method returns without effect.

If confirm is true the user is prompted to confirm the command.

Note that as of 3.2, this method also saves views that implement ISaveablePart and are dirty.

Parameters:
confirm - true to ask the user before saving unsaved changes (recommended), and false to save unsaved changes without asking
Returns:
true if the command succeeded, and false if the operation was canceled by the user or an error occurred while saving

saveEditor

boolean saveEditor(IEditorPart editor,
                   boolean confirm)
Saves the contents of the given editor if dirty. If not, this method returns without effect.

If confirm is true the user is prompted to confirm the command. Otherwise, the save happens without prompt.

The editor must belong to this workbench page.

Parameters:
editor - the editor to close
confirm - true to ask the user before saving unsaved changes (recommended), and false to save unsaved changes without asking
Returns:
true if the command succeeded, and false if the editor was not saved

savePerspective

void savePerspective()
Saves the visible views, their layout, and the visible action sets for this page to the current perspective descriptor. The contents of the current perspective descriptor are overwritten.


savePerspectiveAs

void savePerspectiveAs(IPerspectiveDescriptor perspective)
Saves the visible views, their layout, and the visible action sets for this page to the given perspective descriptor. The contents of the given perspective descriptor are overwritten and it is made the current one for this page.

Parameters:
perspective - the perspective descriptor to save to

setEditorAreaVisible

void setEditorAreaVisible(boolean showEditorArea)
Show or hide the editor area for the page's active perspective.

Parameters:
showEditorArea - true to show the editor area, false to hide the editor area

setPerspective

void setPerspective(IPerspectiveDescriptor perspective)
Changes the visible views, their layout, and the visible action sets within the page to match the given perspective descriptor. This is a rearrangement of components and not a replacement. The contents of the old perspective descriptor are unaffected.

When a perspective change occurs the old perspective is deactivated (hidden) and cached for future reference. Then the new perspective is activated (shown). The views within the page are shared by all existing perspectives to make it easy for the user to switch between one perspective and another quickly without loss of context.

During activation the action sets are modified. If an action set is specified in the new perspective which is not visible in the old one it will be created. If an old action set is not specified in the new perspective it will be disposed.

The visible views and their layout within the page also change. If a view is specified in the new perspective which is not visible in the old one a new instance of the view will be created. If an old view is not specified in the new perspective it will be hidden. This view may reappear if the user selects it from the View menu or if they switch to a perspective (which may be the old one) where the view is visible.

The open editors are not modified by this method.

Parameters:
perspective - the perspective descriptor

showActionSet

void showActionSet(String actionSetID)
Shows an action set in this page.

In most cases where this method is used the caller is tightly coupled to a particular action set. They define it in the registry and may make it visible in certain scenarios by calling showActionSet. A static variable is often used to identify the action set id in caller code.

Parameters:
actionSetID - the action set to show

showView

IViewPart showView(String viewId)
                   throws PartInitException
Shows the view identified by the given view id in this page and gives it focus. If there is a view identified by the given view id (and with no secondary id) already open in this page, it is given focus.

Parameters:
viewId - the id of the view extension to use
Returns:
the shown view
Throws:
PartInitException - if the view could not be initialized

showView

IViewPart showView(String viewId,
                   String secondaryId,
                   int mode)
                   throws PartInitException
Shows a view in this page with the given id and secondary id. The behaviour of this method varies based on the supplied mode. If VIEW_ACTIVATE is supplied, the view is given focus. If VIEW_VISIBLE is supplied, then it is made visible but not given focus. Finally, if VIEW_CREATE is supplied the view is created and will only be made visible if it is not created in a folder that already contains visible views.

This allows multiple instances of a particular view to be created. They are disambiguated using the secondary id. If a secondary id is given, the view must allow multiple instances by having specified allowMultiple="true" in its extension.

Parameters:
viewId - the id of the view extension to use
secondaryId - the secondary id to use, or null for no secondary id
mode - the activation mode. Must be VIEW_ACTIVATE, VIEW_VISIBLE or VIEW_CREATE
Returns:
a view
Throws:
PartInitException - if the view could not be initialized
IllegalArgumentException - if the supplied mode is not valid
Since:
3.0

isEditorPinned

boolean isEditorPinned(IEditorPart editor)
Returns true if the editor is pinned and should not be reused.

Parameters:
editor - the editor to test
Returns:
boolean whether the editor is pinned

getEditorReuseThreshold

int getEditorReuseThreshold()
Deprecated. 

Returns the number of open editors before reusing editors.

Returns:
a int

setEditorReuseThreshold

void setEditorReuseThreshold(int openEditors)
Deprecated. use IPageLayout.setEditorReuseThreshold(int openEditors) instead.

Set the number of open editors before reusing editors. If < 0 the user preference settings will be used.

Parameters:
openEditors - the threshold

getNavigationHistory

INavigationHistory getNavigationHistory()
Returns the navigation history which manages a list of entries keeping the history of places (positions, selection and editors) the user visited making it easier to the user to move back and forward without losing context.

Returns:
the navigation history
Since:
2.1

getViewStack

IViewPart[] getViewStack(IViewPart part)
Returns an array of IViewParts that are stacked with the given part.

Parameters:
part - the part to test
Returns:
the parts that are stacked with this part, including the part in question. null is returned if the part does not belong to this page.
Since:
3.0

getNewWizardShortcuts

String[] getNewWizardShortcuts()
Returns the new wizard shortcuts associated with the current perspective. Returns an empty array if there is no current perspective.

Returns:
an array of wizard identifiers
Since:
3.1
See Also:
IPageLayout.addNewWizardShortcut(String)

getPerspectiveShortcuts

String[] getPerspectiveShortcuts()
Returns the perspective shortcuts associated with the current perspective. Returns an empty array if there is no current perspective.

Returns:
an array of perspective identifiers
Since:
3.1
See Also:
IPageLayout.addPerspectiveShortcut(String)

getShowViewShortcuts

String[] getShowViewShortcuts()
Returns the show view shortcuts associated with the current perspective. Returns an empty array if there is no current perspective.

Returns:
an array of view identifiers
Since:
3.1
See Also:
IPageLayout.addShowViewShortcut(String)

getOpenPerspectives

IPerspectiveDescriptor[] getOpenPerspectives()
Returns the descriptors for the perspectives that are open in this page, in the order in which they were opened.

Returns:
the open perspective descriptors, in order of opening
Since:
3.1

getSortedPerspectives

IPerspectiveDescriptor[] getSortedPerspectives()
Returns the descriptors for the perspectives that are open in this page, in the order in which they were activated (oldest first).

Returns:
the open perspective descriptors, in order of activation
Since:
3.1

closePerspective

void closePerspective(IPerspectiveDescriptor desc,
                      boolean saveParts,
                      boolean closePage)
Closes the specified perspective in this page. If the last perspective in this page is closed, then all editors are closed. Views that are not shown in other perspectives are closed as well. If saveParts is true, the user will be prompted to save any unsaved changes for parts that are being closed. The page itself is closed if closePage is true.

Parameters:
desc - the descriptor of the perspective to be closed
saveParts - whether the page's parts should be saved if closed
closePage - whether the page itself should be closed if last perspective
Since:
3.1

closeAllPerspectives

void closeAllPerspectives(boolean saveEditors,
                          boolean closePage)
Closes all perspectives in this page. All editors are closed, prompting to save any unsaved changes if saveEditors is true. The page itself is closed if closePage is true.

Parameters:
saveEditors - whether the page's editors should be saved
closePage - whether the page itself should be closed
Since:
3.1

getExtensionTracker

IExtensionTracker getExtensionTracker()

Return the extension tracker for the workbench. This tracker may be used by plug-ins to ensure responsiveness to changes to the plug-in registry.

The tracker at this level of the workbench is typically used to track elements that only exist over the lifespan of a page. For example, ViewPart objects fall into this category.

Returns:
the extension tracker
Since:
3.1
See Also:
IWorkbench.getExtensionTracker(), IWorkbenchWindow.getExtensionTracker()

getWorkingSets

IWorkingSet[] getWorkingSets()
Return the visible working sets for this page. Please note that this array is not filtered by activities. Clients should attempt to ensure that any use of this method is consistant with the currently enabled activity set.

Returns:
the visible working sets for this page
Since:
3.2
See Also:
IWorkbench.getActivitySupport()

setWorkingSets

void setWorkingSets(IWorkingSet[] sets)
Set the working sets for this page. Any duplicate entries will be removed from the array by this method.

Parameters:
sets - the new working sets for this page. The array may be empty, but no element in the array may be null.
Since:
3.2

getAggregateWorkingSet

IWorkingSet getAggregateWorkingSet()
Return a working set that contains all of the elements contained in the array of working sets provided by getWorkingSets(). Should this array or the underlying elements in any of the working sets change this set will be updated.

This working set is never null, even if there are no working sets assigned to this page via setWorkingSets(IWorkingSet[]). It is recommended that any client that uses this API be aware of this and act accordingly. Specifically, it is recommended that any client utilizing this or any other IWorkingSet whose IWorkingSet.isAggregateWorkingSet() returns true act as if they are not using any working set if the set is empty. These clients should also maintain an awareness of the contents of aggregate working sets and toggle this behavior should the contents of the aggregate either become empty or non-empty.

Example:
Here we have pseudocode showing how some workingset utilizing component could react to changes in aggregate working sets.
private IWorkingSet myWorkingSet; IPropertyChangeListener workingSetListener = new IPropertyChangeListener() { public void propertyChange(PropertyChangeEvent event) { if (isMyCurrentWorkingSet(event)) { if (isEmptyAggregate(myWorkingSet)) { showNoSet(); } else { showSet(); } } } }; public void setWorkingSet(IWorkingSet newSet) { myWorkingSet = newSet; if (myWorkingSet == null || isEmptyAggregate(myWorkingSet)){ showNoSet(); } else { showSet(); } }

Returns:
the aggregate working set for this page, this implements IAggregateWorkingSet
Since:
3.2
See Also:
IAggregateWorkingSet

isPageZoomed

boolean isPageZoomed()
Returns the page "zoomed" state.

Returns:
true if the page is zoomed in the workbench window, false otherwise.
Since:
3.2

zoomOut

void zoomOut()
Zooms out the zoomed-in part. If the page does not have a zoomed part, it does nothing.

Since:
3.2

toggleZoom

void toggleZoom(IWorkbenchPartReference ref)
Zoom the page in on a part. If the part is already in zoom then zoom out.

Parameters:
ref - the workbench part to zoom in on. Must not be null.
Since:
3.2

getPartState

int getPartState(IWorkbenchPartReference ref)
Returns the maximized/minimized/restored state of the given part reference.

Parameters:
ref - the workbench part to query. Must not be null.
Returns:
one of the STATE_* contants.
Since:
3.2

setPartState

void setPartState(IWorkbenchPartReference ref,
                  int state)
Set the state of the given part reference. Setting the state of one part can effect the state of other parts.

Parameters:
ref - the workbench part reference. Must not be null.
state - one of the STATE_* constants.
Since:
3.2

getReference

IWorkbenchPartReference getReference(IWorkbenchPart part)
Find the part reference for the given part. A convenience method to quickly go from part to part reference.

Parameters:
part - The part to search for. It can be null.
Returns:
The reference for the given part, or null if no reference can be found.
Since:
3.2

showEditor

void showEditor(IEditorReference ref)
Add back an open but non-participating editor

Parameters:
ref - the editor to re-add. Must be an editor removed using #hideEditor(IEditorReference), must not have been closed, and must not be null.
Since:
3.5
See Also:
hideEditor(IEditorReference)

hideEditor

void hideEditor(IEditorReference ref)
Remove an open editor, turn it into a non-participating editor.

A non-participating editor will not be returned in the list of open editors (getEditorReferences()) and will not be visible in the editor area. However, it will continue to participate in the save lifecycle and may still be closed by some workbench close events.

Behaviour for hiding and showing editors from multiple stacks is not defined (and unsupported) at this time.

Parameters:
ref - the editor reference to remove. It must be a current open editor belonging to this page, and must not be null.
Since:
3.5
See Also:
showEditor(IEditorReference)

openEditors

IEditorReference[] openEditors(IEditorInput[] inputs,
                               String[] editorIDs,
                               int matchFlags)
                               throws MultiPartInitException
Opens editors for the given inputs. Only the editor constructed for the first input gets activated.

The editor type is determined by mapping editorIDs to an editor extension registered with the workbench. An editor id is passed rather than an editor object to prevent the accidental creation of more than one editor for the same input. It also guarantees a consistent lifecycle for editors, regardless of whether they are created by the user or restored from saved data.

The length of the input array and editor ID arrays must be the same. The editors are opened using pairs of { input[i], editorIDs[i] }.

Parameters:
inputs - the editor inputs
editorIDs - the IDs of the editor extensions to use, in the order of inputs
matchFlags - a bit mask consisting of zero or more of the MATCH_* constants OR-ed together
Returns:
references to the editors constructed for the inputs. The editors corresponding to those reference might not be materialized.
Throws:
MultiPartInitException - if at least one editor could not be created or initialized
Since:
3.5
See Also:
MATCH_NONE, MATCH_INPUT, MATCH_ID

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.