Package org.eclipse.jface.fieldassist
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. Implementors of IControlContentAdapter
allow the adapter to set and retrieve the contents of the supplied control.
An AutoCompleteField
configures a ContentProposalAdapter
in a manner
that supports automatic field completion popups that filter based on the control's
contents.
ControlDecoration
can be used to decorate an arbitrary control with
an image that communicates 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. It is up to the client to ensure there is enough
space allocated to render the control decoration. Decorations can optionally show
descriptive text when the user hovers over them.
DecoratedField
can also be used to decorate a control. The main difference
is that decorated fields reserve space for multiple decorations in particular
locations around the control. To do this, the field manages the creation of the
field's control, using a specialized layout to ensure there is adequate space
reserved for decorations around the control. Other than using the field to manage
the decorations themselves, clients are expected to interact
directly with the control.
Note: None of the classes in this package maintain global state.
-
Interface Summary Interface Description IContentProposal IContentProposal describes a content proposal to be shown.IContentProposalListener This interface is used to listen to notifications from aContentProposalAdapter
.IContentProposalListener2 This interface is used to listen to additional notifications from aContentProposalAdapter
.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.IControlContentAdapter2 This interface is used by aContentProposalAdapter
in order to retrieve and set the selection range in a control.IControlCreator Deprecated. As of 3.3, clients should useControlDecoration
instead ofDecoratedField
. -
Class Summary Class Description AutoCompleteField AutoCompleteField is a class which attempts to auto-complete a user's keystrokes by activating a popup that filters a list of proposals according to the content typed by the user.ComboContentAdapter AnIControlContentAdapter
for SWT Combo controls.ContentProposal A default implementation ofIContentProposal
that allows clients to specify a content proposal using simple constructors.ContentProposalAdapter ContentProposalAdapter can be used to attach content proposal behavior to a control.ControlDecoration ControlDecoration renders an image decoration near a control.DecoratedField Deprecated. As of 3.3, clients should useControlDecoration
instead.FieldAssistColors Deprecated. As of 3.3, this class is no longer necessary.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 AnIControlContentAdapter
for SWT Text controls.TextControlCreator Deprecated. As of 3.3, clients should useControlDecoration
instead ofDecoratedField
.