|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.fieldassist.ContentProposalAdapter
org.eclipse.ui.fieldassist.ContentAssistCommandAdapter
ContentAssistCommandAdapter extends ContentProposalAdapter
to invoke
content proposals using a specified ICommand
.
The ability to specify a KeyStroke
that explicitly invokes content proposals is hidden by this class, and
instead the String id of a command is used. If no command id is specified by
the client, then the default workbench content assist command is used.
As of 3.3, ContentAssistCommandAdapter can be optionally configured to install the content assist decoration on its control.
This class is not intended to be subclassed.
Field Summary | |
---|---|
static String |
CONTENT_PROPOSAL_COMMAND
The command id used for content assist. |
Fields inherited from class org.eclipse.jface.fieldassist.ContentProposalAdapter |
---|
DEBUG, FILTER_CHARACTER, FILTER_CUMULATIVE, FILTER_NONE, PROPOSAL_IGNORE, PROPOSAL_INSERT, PROPOSAL_REPLACE |
Constructor Summary | |
---|---|
ContentAssistCommandAdapter(Control control,
IControlContentAdapter controlContentAdapter,
IContentProposalProvider proposalProvider,
String commandId,
char[] autoActivationCharacters)
Construct a content proposal adapter that can assist the user with choosing content for the field. |
|
ContentAssistCommandAdapter(Control control,
IControlContentAdapter controlContentAdapter,
IContentProposalProvider proposalProvider,
String commandId,
char[] autoActivationCharacters,
boolean installDecoration)
Construct a content proposal adapter that can assist the user with choosing content for the field. |
Method Summary | |
---|---|
String |
getCommandId()
Return the string command ID of the command used to invoke content assist. |
void |
setEnabled(boolean enabled)
Set the boolean flag that determines whether the adapter is enabled. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String CONTENT_PROPOSAL_COMMAND
"org.eclipse.ui.edit.text.contentAssist.proposals"
)
Constructor Detail |
public ContentAssistCommandAdapter(Control control, IControlContentAdapter controlContentAdapter, IContentProposalProvider proposalProvider, String commandId, char[] autoActivationCharacters)
control
- the control for which the adapter is providing content assist.
May not be null
.controlContentAdapter
- the IControlContentAdapter
used to obtain and
update the control's contents as proposals are accepted. May
not be null
.proposalProvider
- the IContentProposalProvider
used to obtain
content proposals for this control, or null
if
no content proposal is available.commandId
- the String id of the command that will invoke the content
assistant. If not supplied, the default value will be
"org.eclipse.ui.edit.text.contentAssist.proposals".autoActivationCharacters
- An array of characters that trigger auto-activation of content
proposal. If specified, these characters will trigger
auto-activation of the proposal popup, regardless of the
specified command id.public ContentAssistCommandAdapter(Control control, IControlContentAdapter controlContentAdapter, IContentProposalProvider proposalProvider, String commandId, char[] autoActivationCharacters, boolean installDecoration)
control
- the control for which the adapter is providing content assist.
May not be null
.controlContentAdapter
- the IControlContentAdapter
used to obtain and
update the control's contents as proposals are accepted. May
not be null
.proposalProvider
- the IContentProposalProvider
used to obtain
content proposals for this control, or null
if
no content proposal is available.commandId
- the String id of the command that will invoke the content
assistant. If not supplied, the default value will be
"org.eclipse.ui.edit.text.contentAssist.proposals".autoActivationCharacters
- An array of characters that trigger auto-activation of content
proposal. If specified, these characters will trigger
auto-activation of the proposal popup, regardless of the
specified command id.installDecoration
- A boolean that specifies whether a content assist control
decoration should be installed. The client is responsible for
ensuring that adequate space is reserved for the decoration.
Clients that want more fine-grained control of the
decoration's location or appearance should use
false
for this parameter, creating their own
ControlDecoration
and managing it directly.Method Detail |
public String getCommandId()
public void setEnabled(boolean enabled)
ContentProposalAdapter
setEnabled
in class ContentProposalAdapter
enabled
- true
if the adapter is enabled and responding
to user input, false
if it is ignoring user
input.
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.