com.fr.design.gui.autocomplete

类 TemplateCompletion

java.lang.Object

com.fr.design.gui.autocomplete.AbstractCompletion

com.fr.design.gui.autocomplete.TemplateCompletion

所有已实现的接口:

Completion, ParameterizedCompletion, java.lang.Comparable<Completion>

public class TemplateCompletion
extends AbstractCompletion
implements ParameterizedCompletion

A completion made up of a template with arbitrary parameters that the user can tab through and fill in. This completion type is useful for inserting common boilerplate code, such as for-loops.

The format of a template is similar to those in Eclipse. The following example would be the format for a for-loop template:

 for (int ${i} = 0; ${i} < ${array}.length; ${i}++) {
    ${cursor}
 }
 

In the above example, the first ${i} is a parameter for the user to type into; all the other ${i} instances are automatically changed to what the user types in the first one. The parameter named ${cursor} is the "ending position" of the template. It's where the caret moves after it cycles through all other parameters. If the user types into it, template mode terminates. If more than one ${cursor} parameter is specified, behavior is undefined.

Two dollar signs in a row ("$$") will be evaluated as a single dollar sign. Otherwise, the template parsing is pretty straightforward and fault-tolerant.

Leading whitespace is automatically added to lines if the template spans more than one line, and if used with a text component using a PlainDocument, tabs will be converted to spaces if requested.

版本:

1.0

作者:

Robert Futrell

嵌套类概要

从接口继承的嵌套类/接口 com.fr.design.gui.autocomplete.ParameterizedCompletion

ParameterizedCompletion.Parameter

构造器概要

构造器

构造器和说明
TemplateCompletion(CompletionProvider provider, java.lang.String inputText, java.lang.String definitionString, java.lang.String template)
TemplateCompletion(CompletionProvider provider, java.lang.String inputText, java.lang.String definitionString, java.lang.String template, java.lang.String shortDescription, java.lang.String summary)

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getDefinitionString() Returns the "definition string" for this completion.
java.lang.String	getInputText() Returns the text the user has to (start) typing for this completion to be offered.
com.fr.design.gui.autocomplete.ParameterizedCompletionInsertionInfo	getInsertionInfo(javax.swing.text.JTextComponent tc, boolean replaceTabsWithSpaces)
ParameterizedCompletion.Parameter	getParam(int index) Returns the specified ParameterizedCompletion.Parameter.
int	getParamCount() Returns the number of parameters this completion takes.
java.lang.String	getReplacementText() Returns null; template completions insert all of their text via getInsertionInfo().
java.lang.String	getShortDescription()
boolean	getShowParameterToolTip() Returns whether a tool tip displaying assistance for each parameter while it is being edited is appropriate for this completion.
java.lang.String	getSummary() Returns the description of this auto-complete choice.
java.lang.String	toString() Returns a string representation of this completion.

从类继承的方法 com.fr.design.gui.autocomplete.AbstractCompletion

compareTo, getAlreadyEntered, getIcon, getProvider, getRelevance, getToolTipText, setRelevance

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

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

从接口继承的方法 com.fr.design.gui.autocomplete.Completion

compareTo, getAlreadyEntered, getIcon, getProvider, getRelevance, getToolTipText

构造器详细资料

TemplateCompletion

public TemplateCompletion(CompletionProvider provider,
                  java.lang.String inputText,
                  java.lang.String definitionString,
                  java.lang.String template)

TemplateCompletion

public TemplateCompletion(CompletionProvider provider,
                  java.lang.String inputText,
                  java.lang.String definitionString,
                  java.lang.String template,
                  java.lang.String shortDescription,
                  java.lang.String summary)

方法详细资料

getInputText

public java.lang.String getInputText()

从类复制的说明: AbstractCompletion

Returns the text the user has to (start) typing for this completion to be offered. The default implementation simply returns Completion.getReplacementText().

指定者:

getInputText 在接口中 Completion

覆盖:

getInputText 在类中 AbstractCompletion

返回:

The text the user has to (start) typing for this completion.

另请参阅:

Completion.getReplacementText()

getReplacementText

public java.lang.String getReplacementText()

Returns null; template completions insert all of their text via getInsertionInfo().

指定者:

getReplacementText 在接口中 Completion

返回:

null always.

另请参阅:

Completion.getInputText()

getSummary

public java.lang.String getSummary()

从接口复制的说明: Completion

Returns the description of this auto-complete choice. This can be used in a popup "description window."

指定者:

getSummary 在接口中 Completion

返回:

This item's description. This should be HTML. It may be null if there is no description for this completion.

getDefinitionString

public java.lang.String getDefinitionString()

从接口复制的说明: ParameterizedCompletion

Returns the "definition string" for this completion. For example, for the C "printf" function, this would return "int printf(const char *, ...)".

指定者:

getDefinitionString 在接口中 ParameterizedCompletion

返回:

The definition string.

getShortDescription

public java.lang.String getShortDescription()

getShowParameterToolTip

public boolean getShowParameterToolTip()

Returns whether a tool tip displaying assistance for each parameter while it is being edited is appropriate for this completion.

指定者:

getShowParameterToolTip 在接口中 ParameterizedCompletion

返回:

Whether the tool tip is appropriate to display.

getInsertionInfo

public com.fr.design.gui.autocomplete.ParameterizedCompletionInsertionInfo getInsertionInfo(javax.swing.text.JTextComponent tc,
                                                                                   boolean replaceTabsWithSpaces)

指定者:

getInsertionInfo 在接口中 ParameterizedCompletion

getParam

public ParameterizedCompletion.Parameter getParam(int index)

Returns the specified ParameterizedCompletion.Parameter.

指定者:

getParam 在接口中 ParameterizedCompletion

参数:

index - The index of the parameter to retrieve.

返回:

The parameter.

另请参阅:

ParameterizedCompletion.getParamCount()

getParamCount

public int getParamCount()

Returns the number of parameters this completion takes.

指定者:

getParamCount 在接口中 ParameterizedCompletion

返回:

The number of parameters this completion takes.

另请参阅:

ParameterizedCompletion.getParam(int)

toString

public java.lang.String toString()

从类复制的说明: AbstractCompletion

Returns a string representation of this completion. The default implementation returns AbstractCompletion.getInputText().

覆盖:

toString 在类中 AbstractCompletion

返回:

A string representation of this completion.