com.fr.design.gui.autocomplete

类 AutoCompletion

java.lang.Object

com.fr.design.gui.autocomplete.AutoCompletion

public class AutoCompletion
extends java.lang.Object

Adds auto-completion to a text component. Provides a popup window with a list of auto-complete choices on a given keystroke, such as Crtrl+Space.

Depending on the CompletionProvider installed, the following auto-completion features may be enabled:

• An auto-complete choices list made visible via e.g. Ctrl+Space
• A "description" window displayed alongside the choices list that provides documentation on the currently selected completion choice (as seen in Eclipse and NetBeans).
• Parameter assistance. If this is enabled, if the user enters a "parameterized" completion, such as a method or a function, then they will receive a tool tip describing the arguments they have to enter to the completion. Also, the arguments can be navigated via tab and shift+tab (a la Eclipse and NetBeans).

版本:

1.0

作者:

Robert Futrell

构造器概要

构造器

构造器和说明
AutoCompletion(CompletionProvider provider) Constructor.

方法概要

方法

限定符和类型	方法和说明
void	doCompletion() Displays the popup window.
int	getAutoActivationDelay() Returns the delay between when the user types a character and when the code completion popup should automatically appear (if applicable).
CompletionProvider	getCompletionProvider() Returns the completion provider.
static javax.swing.KeyStroke	getDefaultTriggerKey() Returns the default auto-complete "trigger key" for this OS.
ExternalURLHandler	getExternalURLHandler() Returns the handler to use when an external URL is clicked in the description window.
static LinkRedirector	getLinkRedirector() Returns the link redirector, if any.
javax.swing.ListCellRenderer	getListCellRenderer() Returns the default list cell renderer used when a completion provider does not supply its own.
javax.swing.ListCellRenderer	getParamChoicesRenderer() Returns the renderer to use for Completions in the optional parameter choices popup window (displayed when a ParameterizedCompletion is code-completed).
protected java.lang.String	getReplacementText(Completion c, javax.swing.text.Document doc, int start, int len) Returns the text to replace with in the document.
static AutoCompletionStyleContext	getStyleContext() Returns the style context describing how auto-completion related highlights in the editor are rendered.
javax.swing.text.JTextComponent	getTextComponent() Returns the text component for which auto-completion is enabled.
javax.swing.KeyStroke	getTriggerKey() Returns the "trigger key" used for auto-complete.
boolean	hideChildWindows() Hides any child windows being displayed by the auto-completion system.
protected void	insertCompletion(Completion c) Inserts a completion.
protected void	insertCompletion(Completion c, boolean typedParamListStartChar) Inserts a completion.
void	install(javax.swing.text.JTextComponent c) Installs this auto-completion on a text component.
boolean	isAutoActivationEnabled() Returns whether auto-activation is enabled (that is, whether the completion popup will automatically appear after a delay when the user types an appropriate character).
boolean	isAutoCompleteEnabled() Returns whether auto-completion is enabled.
boolean	isAutoCompleteSingleChoices() Returns whether, if a single auto-complete choice is available, it should be automatically inserted, without displaying the popup menu.
boolean	isParameterAssistanceEnabled() Returns whether parameter assistance is enabled.
boolean	isPopupVisible() Returns whether the completion popup window is visible.
boolean	isShowDescWindow() Returns whether the "description window" should be shown alongside the completion window.
protected int	refreshPopupWindow() Refreshes the popup window.
void	setAutoActivationDelay(int ms) Sets the delay between when the user types a character and when the code completion popup should automatically appear (if applicable).
void	setAutoActivationEnabled(boolean enabled) Toggles whether auto-activation is enabled.
void	setAutoCompleteEnabled(boolean enabled) Sets whether auto-completion is enabled.
void	setAutoCompleteSingleChoices(boolean autoComplete) Sets whether, if a single auto-complete choice is available, it should be automatically inserted, without displaying the popup menu.
void	setChoicesWindowSize(int w, int h) Sets the size of the completion choices window.
void	setCompletionProvider(CompletionProvider provider) Sets the completion provider being used.
void	setDescriptionWindowSize(int w, int h) Sets the size of the description window.
void	setExternalURLHandler(ExternalURLHandler handler) Sets the handler to use when an external URL is clicked in the description window.
static void	setLinkRedirector(LinkRedirector linkRedirector) Sets the redirector for external URL's found in code completion documentation.
void	setListCellRenderer(javax.swing.ListCellRenderer renderer) Sets the default list cell renderer to use when a completion provider does not supply its own.
void	setParamChoicesRenderer(javax.swing.ListCellRenderer r) Sets the renderer to use for Completions in the optional parameter choices popup window (displayed when a ParameterizedCompletion is code-completed).
void	setParameterAssistanceEnabled(boolean enabled) Sets whether parameter assistance is enabled.
void	setShowDescWindow(boolean show) Sets whether the "description window" should be shown beside the completion window.
void	setTriggerKey(javax.swing.KeyStroke ks) Sets the keystroke that should be used to trigger the auto-complete popup window.
void	uninstall() Uninstalls this auto-completion from its text component.

从类继承的方法 java.lang.Object

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

构造器详细资料

AutoCompletion

public AutoCompletion(CompletionProvider provider)

Constructor.

参数:

provider - The completion provider. This cannot be null.

方法详细资料

doCompletion

public void doCompletion()

Displays the popup window. Hosting applications can call this method to programmatically begin an auto-completion operation.

getAutoActivationDelay

public int getAutoActivationDelay()

Returns the delay between when the user types a character and when the code completion popup should automatically appear (if applicable).

返回:

The delay, in milliseconds.

另请参阅:

setAutoActivationDelay(int)

isAutoCompleteSingleChoices

public boolean isAutoCompleteSingleChoices()

Returns whether, if a single auto-complete choice is available, it should be automatically inserted, without displaying the popup menu.

返回:

Whether to auto-complete single choices.

另请参阅:

setAutoCompleteSingleChoices(boolean)

getCompletionProvider

public CompletionProvider getCompletionProvider()

Returns the completion provider.

返回:

The completion provider.

getDefaultTriggerKey

public static javax.swing.KeyStroke getDefaultTriggerKey()

Returns the default auto-complete "trigger key" for this OS. For Windows, for example, it is Ctrl+Space.

返回:

The default auto-complete trigger key.

getExternalURLHandler

public ExternalURLHandler getExternalURLHandler()

Returns the handler to use when an external URL is clicked in the description window.

返回:

The handler.

另请参阅:

setExternalURLHandler(ExternalURLHandler), getLinkRedirector()

getLinkRedirector

public static LinkRedirector getLinkRedirector()

Returns the link redirector, if any.

返回:

The link redirector, or null if none.

另请参阅:

setLinkRedirector(LinkRedirector)

getListCellRenderer

public javax.swing.ListCellRenderer getListCellRenderer()

Returns the default list cell renderer used when a completion provider does not supply its own.

返回:

The default list cell renderer.

另请参阅:

setListCellRenderer(ListCellRenderer)

getParamChoicesRenderer

public javax.swing.ListCellRenderer getParamChoicesRenderer()

Returns the renderer to use for Completions in the optional parameter choices popup window (displayed when a ParameterizedCompletion is code-completed). If this returns null, a default renderer is used.

返回:

The renderer to use.

另请参阅:

setParamChoicesRenderer(ListCellRenderer), isParameterAssistanceEnabled()

getReplacementText

protected java.lang.String getReplacementText(Completion c,
                                  javax.swing.text.Document doc,
                                  int start,
                                  int len)

Returns the text to replace with in the document. This is a "last-chance" hook for subclasses to make special modifications to the completion text inserted. The default implementation simply returns c.getReplacementText(). You usually will not need to modify this method.

参数:

c - The completion being inserted.

doc - The document being modified.

start - The start of the text being replaced.

len - The length of the text being replaced.

返回:

The text to replace with.

isShowDescWindow

public boolean isShowDescWindow()

Returns whether the "description window" should be shown alongside the completion window.

返回:

Whether the description window should be shown.

另请参阅:

setShowDescWindow(boolean)

getStyleContext

public static AutoCompletionStyleContext getStyleContext()

Returns the style context describing how auto-completion related highlights in the editor are rendered.

返回:

The style context.

getTextComponent

public javax.swing.text.JTextComponent getTextComponent()

Returns the text component for which auto-completion is enabled.

返回:

The text component, or null if this AutoCompletion is not installed on any text component.

另请参阅:

install(JTextComponent)

getTriggerKey

public javax.swing.KeyStroke getTriggerKey()

Returns the "trigger key" used for auto-complete.

返回:

The trigger key.

另请参阅:

setTriggerKey(KeyStroke)

hideChildWindows

public boolean hideChildWindows()

Hides any child windows being displayed by the auto-completion system.

返回:

Whether any windows were visible.

insertCompletion

protected final void insertCompletion(Completion c)

Inserts a completion. Any time a code completion event occurs, the actual text insertion happens through this method.

参数:

c - A completion to insert. This cannot be null.

insertCompletion

protected void insertCompletion(Completion c,
                    boolean typedParamListStartChar)

Inserts a completion. Any time a code completion event occurs, the actual text insertion happens through this method.

参数:

c - A completion to insert. This cannot be null.

typedParamListStartChar - Whether the parameterized completion start character was typed (typically '(').

install

public void install(javax.swing.text.JTextComponent c)

Installs this auto-completion on a text component. If this AutoCompletion is already installed on another text component, it is uninstalled first.

参数:

c - The text component.

另请参阅:

uninstall()

isAutoActivationEnabled

public boolean isAutoActivationEnabled()

Returns whether auto-activation is enabled (that is, whether the completion popup will automatically appear after a delay when the user types an appropriate character). Note that this parameter will be ignored if auto-completion is disabled.

返回:

Whether auto-activation is enabled.

另请参阅:

setAutoActivationEnabled(boolean), getAutoActivationDelay(), isAutoCompleteEnabled()

isAutoCompleteEnabled

public boolean isAutoCompleteEnabled()

Returns whether auto-completion is enabled.

返回:

Whether auto-completion is enabled.

另请参阅:

setAutoCompleteEnabled(boolean)

isParameterAssistanceEnabled

public boolean isParameterAssistanceEnabled()

Returns whether parameter assistance is enabled.

返回:

Whether parameter assistance is enabled.

另请参阅:

setParameterAssistanceEnabled(boolean)

isPopupVisible

public boolean isPopupVisible()

Returns whether the completion popup window is visible.

返回:

Whether the completion popup window is visible.

refreshPopupWindow

protected int refreshPopupWindow()

Refreshes the popup window. First, this method gets the possible completions for the current caret position. If there are none, and the popup is visible, it is hidden. If there are some completions and the popup is hidden, it is made visible and made to display the completions. If there are some completions and the popup is visible, its list is updated to the current set of completions.

返回:

The current line number of the caret.

setAutoActivationDelay

public void setAutoActivationDelay(int ms)

Sets the delay between when the user types a character and when the code completion popup should automatically appear (if applicable).

参数:

ms - The delay, in milliseconds. This should be greater than zero.

另请参阅:

getAutoActivationDelay()

setAutoActivationEnabled

public void setAutoActivationEnabled(boolean enabled)

Toggles whether auto-activation is enabled. Note that auto-activation also depends on auto-completion itself being enabled.

参数:

enabled - Whether auto-activation is enabled.

另请参阅:

isAutoActivationEnabled(), setAutoActivationDelay(int)

setAutoCompleteEnabled

public void setAutoCompleteEnabled(boolean enabled)

Sets whether auto-completion is enabled.

参数:

enabled - Whether auto-completion is enabled.

另请参阅:

isAutoCompleteEnabled()

setAutoCompleteSingleChoices

public void setAutoCompleteSingleChoices(boolean autoComplete)

Sets whether, if a single auto-complete choice is available, it should be automatically inserted, without displaying the popup menu.

参数:

autoComplete - Whether to auto-complete single choices.

另请参阅:

isAutoCompleteSingleChoices()

setCompletionProvider

public void setCompletionProvider(CompletionProvider provider)

Sets the completion provider being used.

参数:

provider - The new completion provider. This cannot be null.

抛出:

java.lang.IllegalArgumentException - If provider is null.

setChoicesWindowSize

public void setChoicesWindowSize(int w,
                        int h)

Sets the size of the completion choices window.

参数:

w - The new width.

h - The new height.

另请参阅:

setDescriptionWindowSize(int, int)

setDescriptionWindowSize

public void setDescriptionWindowSize(int w,
                            int h)

Sets the size of the description window.

参数:

w - The new width.

h - The new height.

另请参阅:

setChoicesWindowSize(int, int)

setExternalURLHandler

public void setExternalURLHandler(ExternalURLHandler handler)

Sets the handler to use when an external URL is clicked in the description window. This handler can perform some action, such as open the URL in a web browser. The default implementation will open the URL in a browser, but only if running in Java 6. If you want browser support for Java 5 and below, or otherwise want to respond to hyperlink clicks, you will have to install your own handler to do so.

参数:

handler - The new handler.

另请参阅:

getExternalURLHandler()

setLinkRedirector

public static void setLinkRedirector(LinkRedirector linkRedirector)

Sets the redirector for external URL's found in code completion documentation. When a non-local link in completion popups is clicked, this redirector is given the chance to modify the URL fetched and displayed.

参数:

linkRedirector - The link redirector, or null for none.

另请参阅:

getLinkRedirector()

setListCellRenderer

public void setListCellRenderer(javax.swing.ListCellRenderer renderer)

Sets the default list cell renderer to use when a completion provider does not supply its own.

参数:

renderer - The renderer to use. If this is null, a default renderer is used.

另请参阅:

getListCellRenderer()

setParamChoicesRenderer

public void setParamChoicesRenderer(javax.swing.ListCellRenderer r)

Sets the renderer to use for Completions in the optional parameter choices popup window (displayed when a ParameterizedCompletion is code-completed). If this isn't set, a default renderer is used.

参数:

r - The renderer to use.

另请参阅:

getParamChoicesRenderer(), setParameterAssistanceEnabled(boolean)

setParameterAssistanceEnabled

public void setParameterAssistanceEnabled(boolean enabled)

Sets whether parameter assistance is enabled. If parameter assistance is enabled, and a "parameterized" completion (such as a function or method) is inserted, the user will get "assistance" in inserting the parameters in the form of a popup window with documentation and easy tabbing through the arguments (as seen in Eclipse and NetBeans).

参数:

enabled - Whether parameter assistance should be enabled.

另请参阅:

isParameterAssistanceEnabled()

setShowDescWindow

public void setShowDescWindow(boolean show)

Sets whether the "description window" should be shown beside the completion window.

参数:

show - Whether to show the description window.

另请参阅:

isShowDescWindow()

setTriggerKey

public void setTriggerKey(javax.swing.KeyStroke ks)

Sets the keystroke that should be used to trigger the auto-complete popup window.

参数:

ks - The keystroke.

抛出:

java.lang.IllegalArgumentException - If ks is null.

另请参阅:

getTriggerKey()

uninstall

public void uninstall()

Uninstalls this auto-completion from its text component. If it is not installed on any text component, nothing happens.

另请参阅:

install(JTextComponent)