Package org.eclipse.jface.contentassist
Class AbstractControlContentAssistSubjectAdapter
java.lang.Object
org.eclipse.jface.contentassist.AbstractControlContentAssistSubjectAdapter
- All Implemented Interfaces:
IContentAssistSubjectControl
- Direct Known Subclasses:
ComboContentAssistSubjectAdapter
,TextContentAssistSubjectAdapter
@Deprecated
public abstract class AbstractControlContentAssistSubjectAdapter
extends Object
implements IContentAssistSubjectControl
Deprecated.
As of 3.2, replaced by Platform UI's field assist support
An
AbstractControlContentAssistSubjectAdapter
delegates assistance requests from a
content assistant
to a Control
.
A visual feedback can be configured via setContentAssistCueProvider(ILabelProvider)
.- Since:
- 3.0
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addKeyListener
(KeyListener keyListener) Deprecated.Adds the listener to the collection of listeners who will be notified when keys are pressed and released on the system keyboard, by sending it one of the messages defined in theKeyListener
interface.boolean
appendVerifyKeyListener
(VerifyKeyListener verifyKeyListener) Deprecated.If supported, appends a verify key listener to the viewer's list of verify key listeners.abstract Control
Deprecated.Returns the control of this content assist subject control.Deprecated.Returns the line delimiter used for entering new lines by key down or paste operation.boolean
prependVerifyKeyListener
(VerifyKeyListener verifyKeyListener) Deprecated.If supported, inserts the verify key listener at the beginning of this content assist subject's list of verify key listeners.void
removeKeyListener
(KeyListener keyListener) Deprecated.Removes the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard.void
removeVerifyKeyListener
(VerifyKeyListener verifyKeyListener) Deprecated.Removes the verify key listener from this content assist subject control's list of verify key listeners.void
setContentAssistCueProvider
(ILabelProvider labelProvider) Deprecated.Sets the visual feedback provider for content assist.void
setEventConsumer
(IEventConsumer eventConsumer) Deprecated.If supported, registers an event consumer with this content assist subject.boolean
Deprecated.Tests whether a verify key listener can be added either usingprependVerifyKeyListener
orIContentAssistSubjectControl.appendVerifyKeyListener(VerifyKeyListener)
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.jface.contentassist.IContentAssistSubjectControl
addSelectionListener, getCaretOffset, getDocument, getLineHeight, getLocationAtOffset, getSelectedRange, getWidgetSelectionRange, removeSelectionListener, revealRange, setSelectedRange
-
Field Details
-
DEBUG
protected static final boolean DEBUGDeprecated.
-
-
Constructor Details
-
AbstractControlContentAssistSubjectAdapter
public AbstractControlContentAssistSubjectAdapter()Deprecated.Creates a newAbstractControlContentAssistSubjectAdapter
.
-
-
Method Details
-
getControl
Deprecated.Description copied from interface:IContentAssistSubjectControl
Returns the control of this content assist subject control.- Specified by:
getControl
in interfaceIContentAssistSubjectControl
- Returns:
- the control of this content assist subject control
-
addKeyListener
Deprecated.Description copied from interface:IContentAssistSubjectControl
Adds the listener to the collection of listeners who will be notified when keys are pressed and released on the system keyboard, by sending it one of the messages defined in theKeyListener
interface.- Specified by:
addKeyListener
in interfaceIContentAssistSubjectControl
- Parameters:
keyListener
- the listener which should be notified- See Also:
-
removeKeyListener
Deprecated.Description copied from interface:IContentAssistSubjectControl
Removes the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard.- Specified by:
removeKeyListener
in interfaceIContentAssistSubjectControl
- Parameters:
keyListener
- the listener which should be notified- See Also:
-
supportsVerifyKeyListener
public boolean supportsVerifyKeyListener()Deprecated.Description copied from interface:IContentAssistSubjectControl
Tests whether a verify key listener can be added either usingprependVerifyKeyListener
orIContentAssistSubjectControl.appendVerifyKeyListener(VerifyKeyListener)
.- Specified by:
supportsVerifyKeyListener
in interfaceIContentAssistSubjectControl
- Returns:
true
if adding verify key listeners is supported
-
appendVerifyKeyListener
Deprecated.Description copied from interface:IContentAssistSubjectControl
If supported, appends a verify key listener to the viewer's list of verify key listeners. If the listener is already registered with the viewer this call moves the listener to the end of the list.Note: This content assist subject control may not support appending a verify listener, in which case
false
will be returned. If this content assist subject control only supportsaddVerifyKeyListener
then this method can be used butprependVerifyKeyListener
must returnfalse
.- Specified by:
appendVerifyKeyListener
in interfaceIContentAssistSubjectControl
- Parameters:
verifyKeyListener
- the listener to be added- Returns:
true
if the listener was added
-
prependVerifyKeyListener
Deprecated.Description copied from interface:IContentAssistSubjectControl
If supported, inserts the verify key listener at the beginning of this content assist subject's list of verify key listeners. If the listener is already registered with the viewer this call moves the listener to the beginning of the list.Note: This content assist subject control may not support prepending a verify listener, in which case
false
will be returned. However,IContentAssistSubjectControl.appendVerifyKeyListener(VerifyKeyListener)
might work.- Specified by:
prependVerifyKeyListener
in interfaceIContentAssistSubjectControl
- Parameters:
verifyKeyListener
- the listener to be inserted- Returns:
true
if the listener was added
-
removeVerifyKeyListener
Deprecated.Description copied from interface:IContentAssistSubjectControl
Removes the verify key listener from this content assist subject control's list of verify key listeners. If the listener is not registered, this call has no effect.- Specified by:
removeVerifyKeyListener
in interfaceIContentAssistSubjectControl
- Parameters:
verifyKeyListener
- the listener to be removed
-
setEventConsumer
Deprecated.Description copied from interface:IContentAssistSubjectControl
If supported, registers an event consumer with this content assist subject.- Specified by:
setEventConsumer
in interfaceIContentAssistSubjectControl
- Parameters:
eventConsumer
- the content assist subject control's event consumer.null
is a valid argument.
-
getLineDelimiter
Deprecated.Description copied from interface:IContentAssistSubjectControl
Returns the line delimiter used for entering new lines by key down or paste operation.- Specified by:
getLineDelimiter
in interfaceIContentAssistSubjectControl
- Returns:
- line delimiter used for entering new lines by key down or paste operation
-
setContentAssistCueProvider
Deprecated.Sets the visual feedback provider for content assist. The givenILabelProvider
methods are called withgetControl()
as argument.getImage(Object)
provides the visual cue image. The image can maximally be 5 pixels wide and 8 pixels high. IfgetImage(Object)
returnsnull
, a default image is used.getText(Object)
provides the hover info text. It is shown when hovering over the cue image or the adaptedControl
. No info text is shown ifgetText(Object)
returnsnull
.
The given
ILabelProvider
becomes owned by theAbstractControlContentAssistSubjectAdapter
, i.e. it gets disposed when the adaptedControl
is disposed or when anotherILabelProvider
is set.- Parameters:
labelProvider
- aILabelProvider
, ornull
if no visual feedback should be shown
-