Eclipse Platform
Release 3.2

Package org.eclipse.jface.fieldassist

Provides support for classes that help communicate proper content for dialogs and wizards.

See:
          Description

Interface Summary
IContentProposal IContentProposal describes a content proposal to be shown.
IContentProposalListener This interface is used to listen to notifications from a ContentProposalAdapter.
IContentProposalProvider IContentProposalProvider provides an array of IContentProposals that are appropriate for a textual dialog field, given the field's current content and the current cursor position.
IControlContentAdapter This interface is used to set and retrieve text content from an arbitrary control.
IControlCreator This interface is used to create a control with a specific parent and style bits.
 

Class Summary
ComboContentAdapter An IControlContentAdapter for SWT Combo controls.
ContentProposalAdapter ContentProposalAdapter can be used to attach content proposal behavior to a control.
DecoratedField DecoratedField manages image decorations around a control.
FieldAssistColors FieldAssistColors defines protocol for retrieving colors that can be used to provide visual cues with fields.
FieldDecoration FieldDecoration is a simple data structure class for specifying a decoration for a field.
FieldDecorationRegistry FieldDecorationRegistry is a common registry used to define shared field decorations within an application.
SimpleContentProposalProvider SimpleContentProposalProvider is a class designed to map a static list of Strings to content proposals.
TextContentAdapter An IControlContentAdapter for SWT Text controls.
TextControlCreator An IControlCreator for SWT Text controls.
 

Package org.eclipse.jface.fieldassist Description

Provides support for classes that help communicate proper content for dialogs and wizards.

Package Specification

This package provides classes that can be used to guide a dialog user through choosing appropriate content for fields in a dialog or wizard.

A ContentProposalAdapter can be attached to an arbitrary control to provide a popup showing content proposals. These proposals appear when the defined assist keystroke is invoked. The ContentProposalAdapter manages the creation, hiding, and showing of the proposal popup, as well as the proper handling of key events between the adapted control and its popup.

DecoratedField can be used to decorate controls with images that communicate information about the control's content. Decorations can be used to show additional information about a field, such as its status, or a cue that shows availability of content proposals. Decorations are defined in pre-defined locations relative to the control, and can be set up to show at all times, or only when the control has focus. Decorated fields manage the creation of the field's control, since a specialized layout is used to manage the decorations around the control. However, clients supply an object that will create the correct class of control. Other than using the field to manage the decorations themselves, clients are expected to interact directly with the control. Decorations can optionally show descriptive text when the user hovers over them.

Note: None of the classes in this package maintain global state.


Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.