org.eclipse.jface.text.contentassist
Class ContentAssistant

java.lang.Object
  |
  +--org.eclipse.jface.text.contentassist.ContentAssistant

All Implemented Interfaces:

IContentAssistant, IWidgetTokenKeeper

public class ContentAssistant

extends Object

implements IContentAssistant, IWidgetTokenKeeper

The standard implementation of the IContentAssistant interface. Usually, clients instantiate this class and configure it before using it.

Field Summary

Fields inherited from interface org.eclipse.jface.text.contentassist.IContentAssistant

CONTEXT_INFO_ABOVE, CONTEXT_INFO_BELOW, PROPOSAL_OVERLAY, PROPOSAL_REMOVE, PROPOSAL_STACKED

Constructor Summary

ContentAssistant()
Creates a new content assistant.

Method Summary

void	enableAutoActivation(boolean enabled) Enables the content assistant's auto activation mode.
void	enableAutoInsert(boolean enabled) Enables the content assistant's auto insertion mode.
IContentAssistProcessor	getContentAssistProcessor(String contentType) Returns the content assist processor to be used for the given content type.
void	install(ITextViewer textViewer) Installs content assist support on the given text viewer.
boolean	requestWidgetToken(IWidgetTokenOwner owner) The given widget token owner requests the widget token back from this token keeper.
void	setAutoActivationDelay(int delay) Sets the delay after which the content assistant is automatically invoked if the cursor is behind an auto activation character.
void	setContentAssistProcessor(IContentAssistProcessor processor, String contentType) Registers a given content assist processor for a particular content type.
void	setContextInformationPopupBackground(Color background) Sets the context information popup's background color.
void	setContextInformationPopupForeground(Color foreground) Sets the context information popup's foreground color.
void	setContextInformationPopupOrientation(int orientation) Sets the context information popup's orientation.
void	setContextSelectorBackground(Color background) Sets the context selector's background color.
void	setContextSelectorForeground(Color foreground) Sets the context selector's foreground color.
void	setInformationControlCreator(IInformationControlCreator creator) Sets the information control creator for the additional information control.
void	setProposalPopupOrientation(int orientation) Sets the proposal popups' orientation.
void	setProposalSelectorBackground(Color background) Sets the proposal selector's background color.
void	setProposalSelectorForeground(Color foreground) Sets the proposal's foreground color.
String	showContextInformation() Shows context information for the content at the viewer's cursor position.
String	showPossibleCompletions() Shows all possible completions of the content at the viewer's cursor position.
void	uninstall() Uninstalls content assist support from the text viewer it has previously be installed on.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentAssistant

public ContentAssistant()

Creates a new content assistant. The content assistant is not automatically activated, overlays the completion proposals with context information list if necessary, and shows the context information above the location at which it was activated. If auto activation will be enabled, without further configuration steps, this content assistant is activated after a 500 ms delay.

Method Detail

setContentAssistProcessor

public void setContentAssistProcessor(IContentAssistProcessor processor,
                                      String contentType)

Registers a given content assist processor for a particular content type. If there is already a processor registered for this type, the new processor is registered instead of the old one.

Parameters:

processor - the content assist processor to register, or null to remove an existing one

contentType - the content type under which to register

getContentAssistProcessor

public IContentAssistProcessor getContentAssistProcessor(String contentType)

Description copied from interface: IContentAssistant

Returns the content assist processor to be used for the given content type.

Specified by:

getContentAssistProcessor in interface IContentAssistant

Parameters:

contentType - the type of the content for which this content assistant is to be requested

Returns:

an instance content assist processor or null if none exists for the specified content type

enableAutoActivation

public void enableAutoActivation(boolean enabled)

Enables the content assistant's auto activation mode.

Parameters:

enabled - indicates whether auto activation is enabled or not

enableAutoInsert

public void enableAutoInsert(boolean enabled)

Enables the content assistant's auto insertion mode. If enabled, the content assistant inserts a proposal automatically if it is the only proposal. In the case of ambiguities, the user must make the choice.

Parameters:

enabled - indicates whether auto insertion is enabled or not

Since:

2.0

setAutoActivationDelay

public void setAutoActivationDelay(int delay)

Sets the delay after which the content assistant is automatically invoked if the cursor is behind an auto activation character.

Parameters:

delay - the auto activation delay

setProposalPopupOrientation

public void setProposalPopupOrientation(int orientation)

Sets the proposal popups' orientation. The following values may be used:

• PROPOSAL_OVERLAY

  proposal popup windows should overlay each other

• PROPOSAL_REMOVE

  any currently shown proposal popup should be closed

• PROPOSAL_STACKED

  proposal popup windows should be vertical stacked, with no overlap, beneath the line containing the current cursor location

Parameters:

orientation - the popup's orientation

setContextInformationPopupOrientation

public void setContextInformationPopupOrientation(int orientation)

Sets the context information popup's orientation. The following values may be used:

• CONTEXT_ABOVE

  context information popup should always appear above the line containing the current cursor location

• CONTEXT_BELOW

  context information popup should always appear below the line containing the current cursor location

Parameters:

orientation - the popup's orientation

setContextInformationPopupBackground

public void setContextInformationPopupBackground(Color background)

Sets the context information popup's background color.

Parameters:

background - the background color

setContextInformationPopupForeground

public void setContextInformationPopupForeground(Color foreground)

Sets the context information popup's foreground color.

Parameters:

foreground - the foreground color

Since:

2.0

setProposalSelectorBackground

public void setProposalSelectorBackground(Color background)

Sets the proposal selector's background color.

Parameters:

background - the background color

Since:

2.0

setProposalSelectorForeground

public void setProposalSelectorForeground(Color foreground)

Sets the proposal's foreground color.

Parameters:

foreground - the foreground color

Since:

2.0

setContextSelectorBackground

public void setContextSelectorBackground(Color background)

Sets the context selector's background color.

Parameters:

background - the background color

Since:

2.0

setContextSelectorForeground

public void setContextSelectorForeground(Color foreground)

Sets the context selector's foreground color.

Parameters:

foreground - the foreground color

Since:

2.0

setInformationControlCreator

public void setInformationControlCreator(IInformationControlCreator creator)

Sets the information control creator for the additional information control.

Parameters:

creator - the information control creator for the additional information control

Since:

2.0

install

public void install(ITextViewer textViewer)

Description copied from interface: IContentAssistant

Installs content assist support on the given text viewer.

Specified by:

install in interface IContentAssistant

Parameters:

textViewer - the text viewer on which content assist will work

uninstall

public void uninstall()

Description copied from interface: IContentAssistant

Uninstalls content assist support from the text viewer it has previously be installed on.

Specified by:

uninstall in interface IContentAssistant

showPossibleCompletions

public String showPossibleCompletions()

Description copied from interface: IContentAssistant

Shows all possible completions of the content at the viewer's cursor position.

Specified by:

showPossibleCompletions in interface IContentAssistant

Returns:

an optional error message if no proposals can be computed

showContextInformation

public String showContextInformation()

Description copied from interface: IContentAssistant

Shows context information for the content at the viewer's cursor position.

Specified by:

showContextInformation in interface IContentAssistant

Returns:

an optional error message if no context information can be computed

requestWidgetToken

public boolean requestWidgetToken(IWidgetTokenOwner owner)

Description copied from interface: IWidgetTokenKeeper

The given widget token owner requests the widget token back from this token keeper. Returns true if the token is released by this token keeper. Note, the keeper must not call releaseWidgetToken(IWidgetTokenKeeper) explicitly.

Specified by:

requestWidgetToken in interface IWidgetTokenKeeper

Parameters:

owner - the token owner

Returns:

true if token has been released false otherwise