WorkbenchConfigurer

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> ui >> [ internal overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.ui.internal.WorkbenchConfigurer

SOURCE |

Download org.eclipse.ui.internal.WorkbenchConfigurer

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.internal
Class WorkbenchConfigurer

java.lang.Object
  org.eclipse.ui.internal.WorkbenchConfigurer

All Implemented Interfaces:: org.eclipse.ui.application.IWorkbenchConfigurer

public final class WorkbenchConfigurer
extends java.lang.Object
implements org.eclipse.ui.application.IWorkbenchConfigurer

Internal class 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 class is not intended to be instantiated or subclassed by clients.

Since:: 3.0

Field Summary

private java.util.Map extraData
          Table to hold arbitrary key-data settings (key type: String, value type: Object).

private boolean isEmergencyClosing
          Indicates whether the workbench is being force to close.

private boolean saveAndRestore
          Indicates whether workbench state should be saved on close and restored on subsequent open.

Fields inherited from interface org.eclipse.ui.application.IWorkbenchConfigurer

RESTORE_CODE_EXIT, RESTORE_CODE_RESET

Constructor Summary

(package private) WorkbenchConfigurer()
          Creates a new workbench configurer.

Method Summary

void declareImage(java.lang.String symbolicName, org.eclipse.jface.resource.ImageDescriptor descriptor, boolean shared)
          Declares a workbench image.

void emergencyClose()
          Forces the workbench to close due to an emergency.

boolean emergencyClosing()
          Returns whether the workbench is being closed due to an emergency.

java.lang.Object getData(java.lang.String key)
          Returns the data associated with the workbench at the given key.

boolean getSaveAndRestore()
          Returns whether the workbench state should be saved on close and restored on subsequent open.

org.eclipse.ui.application.IWorkbenchWindowConfigurer getWindowConfigurer(org.eclipse.ui.IWorkbenchWindow window)
          Returns an object that can be used to configure the given window.

org.eclipse.ui.IWorkbench getWorkbench()
          Returns the underlying workbench.

org.eclipse.jface.window.WindowManager getWorkbenchWindowManager()
          Returns the workbench window manager.

void openFirstTimeWindow()
          Opens the first time window, using the default perspective and default page input.

org.eclipse.core.runtime.IStatus restoreState()
          Restores the workbench state saved from the previous session, if any.

void setData(java.lang.String key, java.lang.Object data)
          Sets the data associated with the workbench at the given key.

void setSaveAndRestore(boolean enabled)
          Sets whether the workbench state should be saved on close and restored on subsequent open.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

extraData

private java.util.Map extraData

Table to hold arbitrary key-data settings (key type: String, value type: Object).

See Also:: setData(java.lang.String, java.lang.Object) 55

saveAndRestore

private boolean saveAndRestore

Indicates whether workbench state should be saved on close and restored on subsequent open.

isEmergencyClosing

private boolean isEmergencyClosing

Indicates whether the workbench is being force to close. During an emergency close, no interaction with the user should be done.

Constructor Detail

WorkbenchConfigurer

WorkbenchConfigurer()

Creates a new workbench configurer.

This method is declared package-private. Clients are passed an instance only via WorkbenchAdvisor.initialize

Method Detail