Package org.fife.ui.autocomplete
Class VariableCompletion
- java.lang.Object
-
- org.fife.ui.autocomplete.AbstractCompletion
-
- org.fife.ui.autocomplete.BasicCompletion
-
- org.fife.ui.autocomplete.VariableCompletion
-
- All Implemented Interfaces:
java.lang.Comparable<Completion>
,Completion
- Direct Known Subclasses:
FunctionCompletion
public class VariableCompletion extends BasicCompletion
A completion for a variable (or constant) in a programming language.This completion type uses its
shortDescription
property as part of its summary returned bygetSummary()
; for this reason, it may be a little longer (even much longer), if desired, than what is recommended forBasicCompletion
s (where theshortDescription
is used intoString()
forListCellRenderers
).- Version:
- 1.0
-
-
Constructor Summary
Constructors Constructor Description VariableCompletion(CompletionProvider provider, java.lang.String name, java.lang.String type)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addDefinitionString(java.lang.StringBuilder sb)
java.lang.String
getDefinedIn()
Returns where this variable is defined.java.lang.String
getDefinitionString()
Return the definition of this variable completion.java.lang.String
getName()
Returns the name of this variable.java.lang.String
getSummary()
Returns the description of this auto-complete choice.java.lang.String
getToolTipText()
Returns the tool tip text to display for mouse hovers over this completion.java.lang.String
getType()
Returns the type of this variable.protected void
possiblyAddDefinedIn(java.lang.StringBuilder sb)
Adds some HTML describing where this variable is defined, if this information is known.protected boolean
possiblyAddDescription(java.lang.StringBuilder sb)
Adds the description text as HTML to a buffer, if a description is defined.void
setDefinedIn(java.lang.String definedIn)
Sets where this variable is defined.java.lang.String
toString()
Overridden to return the name of the variable being completed.-
Methods inherited from class org.fife.ui.autocomplete.BasicCompletion
getReplacementText, getShortDescription, setShortDescription, setSummary
-
Methods inherited from class org.fife.ui.autocomplete.AbstractCompletion
compareTo, getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, setIcon, setRelevance
-
-
-
-
Constructor Detail
-
VariableCompletion
public VariableCompletion(CompletionProvider provider, java.lang.String name, java.lang.String type)
Constructor.- Parameters:
provider
- The parent provider.name
- The name of this variable.type
- The type of this variable (e.g. "int
", "String
", etc.).
-
-
Method Detail
-
addDefinitionString
protected void addDefinitionString(java.lang.StringBuilder sb)
-
getDefinitionString
public java.lang.String getDefinitionString()
Return the definition of this variable completion.- Returns:
- The definition string.
-
getDefinedIn
public java.lang.String getDefinedIn()
Returns where this variable is defined.- Returns:
- Where this variable is defined.
- See Also:
setDefinedIn(String)
-
getName
public java.lang.String getName()
Returns the name of this variable.- Returns:
- The name.
-
getSummary
public java.lang.String getSummary()
Description copied from interface:Completion
Returns the description of this auto-complete choice. This can be used in a popup "description window."- Specified by:
getSummary
in interfaceCompletion
- Overrides:
getSummary
in classBasicCompletion
- Returns:
- This item's description. This should be HTML. It may be
null
if there is no description for this completion.
-
getToolTipText
public java.lang.String getToolTipText()
Returns the tool tip text to display for mouse hovers over this completion.Note that for this functionality to be enabled, a
JTextComponent
must be registered with theToolTipManager
, and the text component must know to search for this value. In the case of an RSyntaxTextArea, this can be done with aorg.fife.ui.rtextarea.ToolTipSupplier
that calls intoCompletionProvider.getCompletionsAt(JTextComponent, java.awt.Point)
.- Specified by:
getToolTipText
in interfaceCompletion
- Overrides:
getToolTipText
in classAbstractCompletion
- Returns:
- The tool tip text for this completion, or
null
if none.
-
getType
public java.lang.String getType()
Returns the type of this variable.- Returns:
- The type.
-
possiblyAddDefinedIn
protected void possiblyAddDefinedIn(java.lang.StringBuilder sb)
Adds some HTML describing where this variable is defined, if this information is known.- Parameters:
sb
- The buffer to append to.
-
possiblyAddDescription
protected boolean possiblyAddDescription(java.lang.StringBuilder sb)
Adds the description text as HTML to a buffer, if a description is defined.- Parameters:
sb
- The buffer to append to.- Returns:
- Whether there was a description to add.
-
setDefinedIn
public void setDefinedIn(java.lang.String definedIn)
Sets where this variable is defined.- Parameters:
definedIn
- Where this variable is defined.- See Also:
getDefinedIn()
-
toString
public java.lang.String toString()
Overridden to return the name of the variable being completed.- Overrides:
toString
in classBasicCompletion
- Returns:
- A string representation of this completion.
-
-