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 supportAnAbstractControlContentAssistSubjectAdapterdelegates assistance requests from a content assistant to aControl. A visual feedback can be configured viasetContentAssistCueProvider(ILabelProvider).- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description protected static booleanDEBUGDeprecated.
-
Constructor Summary
Constructors Constructor Description AbstractControlContentAssistSubjectAdapter()Deprecated.Creates a newAbstractControlContentAssistSubjectAdapter.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddKeyListener(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 theKeyListenerinterface.booleanappendVerifyKeyListener(VerifyKeyListener verifyKeyListener)Deprecated.If supported, appends a verify key listener to the viewer's list of verify key listeners.abstract ControlgetControl()Deprecated.Returns the control of this content assist subject control.StringgetLineDelimiter()Deprecated.Returns the line delimiter used for entering new lines by key down or paste operation.booleanprependVerifyKeyListener(VerifyKeyListener verifyKeyListener)Deprecated.If supported, inserts the verify key listener at the beginning of this content assist subject's list of verify key listeners.voidremoveKeyListener(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.voidremoveVerifyKeyListener(VerifyKeyListener verifyKeyListener)Deprecated.Removes the verify key listener from this content assist subject control's list of verify key listeners.voidsetContentAssistCueProvider(ILabelProvider labelProvider)Deprecated.Sets the visual feedback provider for content assist.voidsetEventConsumer(IEventConsumer eventConsumer)Deprecated.If supported, registers an event consumer with this content assist subject.booleansupportsVerifyKeyListener()Deprecated.Tests whether a verify key listener can be added either usingprependVerifyKeyListenerorIContentAssistSubjectControl.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
-
-
-
-
Constructor Detail
-
AbstractControlContentAssistSubjectAdapter
public AbstractControlContentAssistSubjectAdapter()
Deprecated.Creates a newAbstractControlContentAssistSubjectAdapter.
-
-
Method Detail
-
getControl
public abstract Control getControl()
Deprecated.Description copied from interface:IContentAssistSubjectControlReturns the control of this content assist subject control.- Specified by:
getControlin interfaceIContentAssistSubjectControl- Returns:
- the control of this content assist subject control
-
addKeyListener
public void addKeyListener(KeyListener keyListener)
Deprecated.Description copied from interface:IContentAssistSubjectControlAdds 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 theKeyListenerinterface.- Specified by:
addKeyListenerin interfaceIContentAssistSubjectControl- Parameters:
keyListener- the listener which should be notified- See Also:
KeyListener,IContentAssistSubjectControl.removeKeyListener(KeyListener)
-
removeKeyListener
public void removeKeyListener(KeyListener keyListener)
Deprecated.Description copied from interface:IContentAssistSubjectControlRemoves the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard.- Specified by:
removeKeyListenerin interfaceIContentAssistSubjectControl- Parameters:
keyListener- the listener which should be notified- See Also:
KeyListener,IContentAssistSubjectControl.addKeyListener(KeyListener)
-
supportsVerifyKeyListener
public boolean supportsVerifyKeyListener()
Deprecated.Description copied from interface:IContentAssistSubjectControlTests whether a verify key listener can be added either usingprependVerifyKeyListenerorIContentAssistSubjectControl.appendVerifyKeyListener(VerifyKeyListener).- Specified by:
supportsVerifyKeyListenerin interfaceIContentAssistSubjectControl- Returns:
trueif adding verify key listeners is supported
-
appendVerifyKeyListener
public boolean appendVerifyKeyListener(VerifyKeyListener verifyKeyListener)
Deprecated.Description copied from interface:IContentAssistSubjectControlIf 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
falsewill be returned. If this content assist subject control only supportsaddVerifyKeyListenerthen this method can be used butprependVerifyKeyListenermust returnfalse.- Specified by:
appendVerifyKeyListenerin interfaceIContentAssistSubjectControl- Parameters:
verifyKeyListener- the listener to be added- Returns:
trueif the listener was added
-
prependVerifyKeyListener
public boolean prependVerifyKeyListener(VerifyKeyListener verifyKeyListener)
Deprecated.Description copied from interface:IContentAssistSubjectControlIf 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
falsewill be returned. However,IContentAssistSubjectControl.appendVerifyKeyListener(VerifyKeyListener)might work.- Specified by:
prependVerifyKeyListenerin interfaceIContentAssistSubjectControl- Parameters:
verifyKeyListener- the listener to be inserted- Returns:
trueif the listener was added
-
removeVerifyKeyListener
public void removeVerifyKeyListener(VerifyKeyListener verifyKeyListener)
Deprecated.Description copied from interface:IContentAssistSubjectControlRemoves 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:
removeVerifyKeyListenerin interfaceIContentAssistSubjectControl- Parameters:
verifyKeyListener- the listener to be removed
-
setEventConsumer
public void setEventConsumer(IEventConsumer eventConsumer)
Deprecated.Description copied from interface:IContentAssistSubjectControlIf supported, registers an event consumer with this content assist subject.- Specified by:
setEventConsumerin interfaceIContentAssistSubjectControl- Parameters:
eventConsumer- the content assist subject control's event consumer.nullis a valid argument.
-
getLineDelimiter
public String getLineDelimiter()
Deprecated.Description copied from interface:IContentAssistSubjectControlReturns the line delimiter used for entering new lines by key down or paste operation.- Specified by:
getLineDelimiterin interfaceIContentAssistSubjectControl- Returns:
- line delimiter used for entering new lines by key down or paste operation
-
setContentAssistCueProvider
public void setContentAssistCueProvider(ILabelProvider labelProvider)
Deprecated.Sets the visual feedback provider for content assist. The givenILabelProvidermethods 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
ILabelProviderbecomes owned by theAbstractControlContentAssistSubjectAdapter, i.e. it gets disposed when the adaptedControlis disposed or when anotherILabelProvideris set.- Parameters:
labelProvider- aILabelProvider, ornullif no visual feedback should be shown
-
-