| org.eclipse.ui.application.IWorkbenchConfigurer
All known Subclasses: org.eclipse.ui.internal.WorkbenchConfigurer,
| IWorkbenchConfigurer | | public interface IWorkbenchConfigurer (Code) | | Interface providing special access for configuring the workbench.
Note that these objects are only available to the main application
(the plug-in that creates and owns the workbench).
This interface is not intended to be implemented by clients.
See Also: WorkbenchAdvisor.initialize
since:
3.0 |
| Field Summary | |
| final public static int | RESTORE_CODE_EXIT
Restore status code indicating that the saved state
could not be restored, and that the application
must exit immediately without modifying any previously
saved workbench state. | | final public static int | RESTORE_CODE_RESET
Restore status code indicating that the saved state
could not be restored, but that startup should continue
with a reset state. |
| Method Summary | |
| public void | declareImage(String symbolicName, ImageDescriptor descriptor, boolean shared)
Declares a workbench image. | | public void | emergencyClose()
Forces the workbench to close due to an emergency. | | public boolean | emergencyClosing()
Returns whether the workbench is being closed due to an emergency.
When this method returns true, the workbench is in dire
straights and cannot continue. | | public Object | getData(String key)
Returns the data associated with the workbench at the given key. | | public boolean | getExitOnLastWindowClose()
Returns true if the workbench should exit when the last
window is closed, false if the window should just be
closed, leaving the workbench (and its event loop) running.
If true, the last window's state is saved before closing,
so that it will be restored in the next session. | | public boolean | getSaveAndRestore()
Returns whether the workbench state should be saved on close and
restored on subsequent open. | | public IWorkbenchWindowConfigurer | getWindowConfigurer(IWorkbenchWindow window)
Returns an object that can be used to configure the given window. | | public IWorkbench | getWorkbench()
Returns the underlying workbench. | | public WindowManager | getWorkbenchWindowManager()
Returns the workbench window manager. | | public void | openFirstTimeWindow()
Opens the first time window, using the default perspective and
default page input. | | public IStatus | restoreState()
Restores the workbench state saved from the previous session, if any.
This includes any open windows and their open perspectives, open views
and editors, layout information, and any customizations to the open
perspectives. | | public IWorkbenchWindowConfigurer | restoreWorkbenchWindow(IMemento memento)
Restores a workbench window from the given memento. | | public void | setData(String key, Object data)
Sets the data associated with the workbench at the given key. | | public void | setExitOnLastWindowClose(boolean enabled)
Sets whether the workbench should exit when the last window is closed, or
whether the window should just be closed, leaving the workbench (and its
event loop) running. | | public void | setSaveAndRestore(boolean enabled)
Sets whether the workbench state should be saved on close and
restored on subsequent open. |
| RESTORE_CODE_EXIT | | final public static int RESTORE_CODE_EXIT(Code) | | Restore status code indicating that the saved state
could not be restored, and that the application
must exit immediately without modifying any previously
saved workbench state.
|
| RESTORE_CODE_RESET | | final public static int RESTORE_CODE_RESET(Code) | | Restore status code indicating that the saved state
could not be restored, but that startup should continue
with a reset state.
See Also: IWorkbenchConfigurer.restoreState |
| declareImage | | public void declareImage(String symbolicName, ImageDescriptor descriptor, boolean shared)(Code) | | Declares a workbench image.
The workbench remembers the given image descriptor under the given name,
and makes the image available to plug-ins via
IWorkbench.getSharedImages IWorkbench.getSharedImages() .
For "shared" images, the workbench remembers the image descriptor and
will manages the image object create from it; clients retrieve "shared"
images via
org.eclipse.ui.ISharedImages.getImage ISharedImages.getImage() .
For the other, "non-shared" images, the workbench remembers only the
image descriptor; clients retrieve the image descriptor via
org.eclipse.ui.ISharedImages.getImageDescriptorISharedImages.getImageDescriptor() and are entirely
responsible for managing the image objects they create from it.
(This is made confusing by the historical fact that the API interface
is called "ISharedImages".)
Parameters:
symbolicName - the symbolic name of the image
Parameters:
descriptor - the image descriptor
Parameters:
shared - true if this is a shared image, andfalse if this is not a shared image
See Also: org.eclipse.ui.ISharedImages.getImage
See Also: org.eclipse.ui.ISharedImages.getImageDescriptor |
| emergencyClose | | public void emergencyClose()(Code) | | Forces the workbench to close due to an emergency. This method should
only be called when the workbench is in dire straights and cannot
continue, and cannot even risk a normal workbench close (think "out of
memory" or "unable to create shell"). When this method is called, an
abbreviated workbench shutdown sequence is performed (less critical
steps may be skipped). The workbench advisor is still called; however,
it must not attempt to communicate with the user. While an emergency
close is in progress, emergencyClosing returns
true. Workbench advisor methods should always check this
flag before communicating with the user.
See Also: IWorkbenchConfigurer.emergencyClosing |
| emergencyClosing | | public boolean emergencyClosing()(Code) | | Returns whether the workbench is being closed due to an emergency.
When this method returns true, the workbench is in dire
straights and cannot continue. Indeed, things are so bad that we cannot
even risk a normal workbench close. Workbench advisor methods should
always check this flag before attempting to communicate with the user.
true if the workbench is in the process of beingclosed under emergency conditions, and false otherwise |
| getData | | public Object getData(String key)(Code) | | Returns the data associated with the workbench at the given key.
Parameters:
key - the key the data, or null if there is no data at the givenkey |
| getExitOnLastWindowClose | | public boolean getExitOnLastWindowClose()(Code) | | Returns true if the workbench should exit when the last
window is closed, false if the window should just be
closed, leaving the workbench (and its event loop) running.
If true, the last window's state is saved before closing,
so that it will be restored in the next session. This applies only if
IWorkbenchConfigurer.getSaveAndRestore() returns true ).
If false, the window is simply closed, losing its state.
If the workbench is left running, it can be closed using
IWorkbench.close , or a new window can be opened using
IWorkbench.openWorkbenchWindow(StringIAdaptable) .
The initial value is true.
true if the workbench will exit when the lastwindow is closed, false if the window should justbe closed
since:
3.1 |
| getSaveAndRestore | | public boolean getSaveAndRestore()(Code) | | Returns whether the workbench state should be saved on close and
restored on subsequent open.
The initial value is false.
true to save and restore workbench state, orfalse to forget current workbench state on close. |
| getWorkbench | | public IWorkbench getWorkbench()(Code) | | Returns the underlying workbench.
the workbench |
| getWorkbenchWindowManager | | public WindowManager getWorkbenchWindowManager()(Code) | | Returns the workbench window manager.
the workbench window managerNote:IWorkbenchWindow is implemented using JFace's Window (and therefore uses WindowManager), but this is an implementation detail |
| openFirstTimeWindow | | public void openFirstTimeWindow()(Code) | | Opens the first time window, using the default perspective and
default page input.
This is typically called from the advisor's openWindows()
method.
See Also: WorkbenchAdvisor.openWindows |
| setData | | public void setData(String key, Object data)(Code) | | Sets the data associated with the workbench at the given key.
Parameters:
key - the key
Parameters:
data - the data, or null to delete existing data |
| setExitOnLastWindowClose | | public void setExitOnLastWindowClose(boolean enabled)(Code) | | Sets whether the workbench should exit when the last window is closed, or
whether the window should just be closed, leaving the workbench (and its
event loop) running.
For more details, see
IWorkbenchConfigurer.getExitOnLastWindowClose() .
Parameters:
enabled - true if the workbench should exit when the lastwindow is closed, false if the window shouldjust be closed
since:
3.1 |
| setSaveAndRestore | | public void setSaveAndRestore(boolean enabled)(Code) | | Sets whether the workbench state should be saved on close and
restored on subsequent open.
Parameters:
enabled - true to save and restore workbench state, orfalse to forget current workbench state on close. |
|
|