ui workbench

Package Specification

The PlatformUI class provides access to a single workbench.  A workbench is the root object for the UI and has one or more workbench windows.  Each workbench window has a collection of workbench pages, only one of which is active and visible to the end user.  Each workbench page has a collection of workbench parts.  A page's parts are arranged (tiled or stacked) for presentation on the screen.  Within a page and its parts the user can interact with and modify a model (typically resources in a workspace).   There are two kinds of workbench parts: views and editors.  An editor is typically used to edit or browse a document or input object.  A view is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor.

The platform creates a workbench when the workbench plug-in is activated.  Since this happens at most once during the life of the running platform, there is only one workbench instance. Due to its singular nature, it is commonly referred to as the workbench.

Within a workbench the user will interact with many different resource types.  Because different tools are required for each, the workbench defines a number of extension points which allow for the integration of new tools.  There are extension points for views, editors, action sets, import wizards, export wizards, etc.
 

Package Specification

Package Specification

Action which leads to resource modification should take advantage of the WorkspaceModifyOperation classes.  These classes are used to defer events which typically occur as a result of workspace changes (such as the firing of resource deltas, performance of autobuilds, etc.) until the outermost operation has successfully completed.  This deferral leads to an optimized, faster execution of resource modification because fewer deltas and autobuilds are performed.

Package Specification

Package Specification

Classes for branding support.

Package Specification

This package has API to public branding and product constants. These constants are used when branding RCP applications.

Package Specification

Provides support for retrieving information on Commands from the workbench.

Package Specification

Most of org.eclipse.ui.commands.* is depracated in favour of org.eclipse.core.commands, but the ICommandService and associated classes are used to access the workbench view of org.eclipse.core.commands. getService(ICommandService.class) can be used to get the ICommandService from the workbench, workbench window, or part site.

Package Specification

Provides support for integrating contexts into the Eclipse workbench.

Package Specification

This package provides the classes required to integrate contexts into the Eclipse workbench.

To use the context integration, the method getAdapter is called on the Eclipse workbench, with the argument IContextService.class. This will return an instance of IContextService.

Package Specification

Package Specification

Package Specification

Provides support for integrating handlers into the Eclipse workbench.

Package Specification

This package provides the classes required to integrate handlers into the Eclipse workbench.

To use the handler integration, the method getAdapter is called on the Eclipse workbench, with the argument IHandlerService.class. This will return an instance of IHandlerService.

Package Specification

Package Specification

This package provides classes that can be used to ...

Package Specification

Provides support for integrating keys into the Eclipse workbench.

Package Specification

This package provides the classes required to integrate keys into the Eclipse workbench.

To use the key integration, the method getAdapter is called on the Eclipse workbench, with the argument IBindingService.class. This will return an instance of IBindingService.

Package Specification

Package Specification

Package Specification

Package Specification

Classes for contributing presentations to eclipse.

Package Specification

This package has the presentation API support, for customizing the presentation of stacks for view and editors.

Package Specification

Classes for service support.

Package Specification

This package has the base service support API. IServiceLocator is used to retrieve any of the services contributed to the workbench, workbench window, or part site.

Package Specification

Package Specification

Package Specification

Classes for testing support.

Package Specification

This package has some test support objects.

Package Specification

Templates

Packages

• org.eclipse.jface.text.templates
• org.eclipse.ui.workbench.texteditor.templates
• org.eclipse.ui.editors.templates

Introduction

if (${name} instanceof ${type}) {
    ${type} ${new_name} = (${type})${name};
    ${cursor}
}

Classes

• Template a template consists of name, context type identifier, and a pattern.
• TemplateTranslator and TemplateBuffer are used to parse the template grammar and don't need to be used usually.
• A TemplateProposal can be offered in content assist, possibly created by a subclass of TemplateCompletionProcessor.
• TemplateStore and ContextTypeRegistry manage a set of templates within a plug-in and offer ways to store them in the preferences or externally in XML streams via a TemplateReaderWriter.
  
• ContributionTemplateStore and ContributionContextTypeRegistry add awareness for the org.eclipse.ui.editors.templates extension point.
• TemplatePreferencePage allows the user to access the templates within a TemplateStore.

Example

Package Specification

Package Specification

Package Specification