ui

Package Specification

Application programming interfaces for interaction with the Eclipse console.

Package Specification

The Eclipse platform UI console plug-in provides a set of classes and interfaces to facilitate the creation and display of consoles in the ConsoleView. This package contains a generic abstract console (AbstractConsole) that provides some basic functionality as well as two complete implementations of consoles that may be subclassed.

The class TextConsole supports regular expression matching and hyperlinks. Clients must provide their own document partitioner.

IOConsole extends TextConsole and provides support for creating consoles based upon input and output streams via the use of IOConsoleOutputStream and IOConsoleInputStream. IOConsole is not an abstract class, it may be used as is or subclassed.

A console manager (IConsoleManager) manages all active consoles, and provides notification of consoles which are added and removed. Consoles are displayed in a page book view. Each console implementation is reponsible for creating its page (IPageBookView), which provides freedom of presentation to the console implementation. A single console may be displayed simultaneously in multiple console views, in different workbench windows.

Application programming interfaces for Eclipse console specific actions.

Package Specification

This package provides a set of actions related to the Eclipse console.

Clients are allowed to instantiate classes from this package. The classes are not intended to be subclassed.

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

This package contains the API for customizing the welcome content and presentation. It defines two extension points. The org.eclipse.ui.intro.config extension point provides the ability to take full control of welcome and customize all aspects of it. The org.eclipse.ui.intro.configExtension extension point provides the ability to extend another plug-in's welcome configuration and modify it. For example, org.eclipse.ui.intro.config could be use to completely redefine the structure of the welcome content and org.eclipse.ui.intro.configExtension could be used to provide a new theme to an existing welcome configuration.

Package Specification

This package only contains one class, org.eclipse.ui.intro.universal.ExtensionFactory. It provides product developers the ability to add a preference page to customize the welcome layout and generate an introData.xml file to be included in their final product. The class should only be reference from a plugin.xml file. For example usage see org.eclipse.platform/plugin.xml. The preference page is included in the Eclipse SDK and can be found under "General -> Welcome".