Java Doc for IWorkbenchPage.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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:

• Unless a view explicitly allows for multiple instances in its plugin declaration there will be only one instance in a given workbench page.
• Only one editor can exist for each editor input within a page.

This interface is not intended to be implemented by clients.

Return the extension tracker for the workbench.

In most cases where this method is used the caller is tightly coupled to a particular action set.

If this page already has an editor open on the target input that editor is activated; otherwise, a new editor is opened.

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.

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.

In most cases where this method is used the caller is tightly coupled to a particular action set.

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

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

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

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

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.

This working set is never null, even if there are no working sets assigned to this page via IWorkbenchPage.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(); } }

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

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

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.

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

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

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.

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.

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.

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.

For more information on perspective change see setPerspective().

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.

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.

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.

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.

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.