Eclipse Platform
Release 3.2

org.eclipse.ui.fieldassist
Class ContentAssistCommandAdapter

java.lang.Object
  extended byorg.eclipse.jface.fieldassist.ContentProposalAdapter
      extended byorg.eclipse.ui.fieldassist.ContentAssistCommandAdapter

public class ContentAssistCommandAdapter
extends ContentProposalAdapter

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.

This class is not intended to be subclassed.

Since:
3.2

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.
 
Method Summary
 String getCommandId()
          Return the string command ID of the command used to invoke content assist.
 
Methods inherited from class org.eclipse.jface.fieldassist.ContentProposalAdapter
addContentProposalListener, getAutoActivationCharacters, getAutoActivationDelay, getContentProposalProvider, getControl, getControlContentAdapter, getFilterStyle, getLabelProvider, getPopupSize, getPropagateKeys, getProposalAcceptanceStyle, isEnabled, openProposalPopup, setAutoActivationCharacters, setAutoActivationDelay, setContentProposalProvider, setEnabled, setFilterStyle, setLabelProvider, setPopupSize, setPropagateKeys, setProposalAcceptanceStyle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTENT_PROPOSAL_COMMAND

public static final String CONTENT_PROPOSAL_COMMAND
The command id used for content assist. (value "org.eclipse.ui.edit.text.contentAssist.proposals")

See Also:
Constant Field Values
Constructor Detail

ContentAssistCommandAdapter

public 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.

Parameters:
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.
Method Detail

getCommandId

public String getCommandId()
Return the string command ID of the command used to invoke content assist.

Returns:
the command ID of the command that invokes content assist.

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.