public class VariableCompletion extends BasicCompletion
This completion type uses its shortDescription property as part of
its summary returned by getSummary()
; for this reason, it may be
a little longer (even much longer), if desired, than what is recommended
for BasicCompletions (where the shortDescription is used
in toString()
for ListCellRenderers).
Constructor and Description |
---|
VariableCompletion(CompletionProvider provider,
String name,
String type)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addDefinitionString(StringBuilder sb) |
String |
getDefinedIn()
Returns where this variable is defined.
|
String |
getDefinitionString() |
String |
getName()
Returns the name of this variable.
|
String |
getSummary()
Returns the description of this auto-complete choice.
|
String |
getToolTipText()
Returns the tool tip text to display for mouse hovers over this
completion.
|
String |
getType()
Returns the type of this variable.
|
protected void |
possiblyAddDefinedIn(StringBuilder sb)
Adds some HTML describing where this variable is defined, if this
information is known.
|
protected boolean |
possiblyAddDescription(StringBuilder sb)
Adds the description text as HTML to a buffer, if a description is
defined.
|
void |
setDefinedIn(String definedIn)
Sets where this variable is defined.
|
String |
toString()
Overridden to return the name of the variable being completed.
|
getReplacementText, getShortDescription, setShortDescription, setSummary
compareTo, getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, setRelevance
public VariableCompletion(CompletionProvider provider, String name, String type)
provider
- The parent provider.name
- The name of this variable.type
- The type of this variable (e.g. "int
",
"String
", etc.).protected void addDefinitionString(StringBuilder sb)
public String getDefinitionString()
public String getDefinedIn()
setDefinedIn(String)
public String getName()
public String getSummary()
getSummary
in interface Completion
getSummary
in class BasicCompletion
null
if there is no description for this
completion.public String getToolTipText()
Note that for this functionality to be enabled, a
JTextComponent must be registered with the
ToolTipManager, and the text component must know to search
for this value. In the case of an
RSyntaxTextArea, this
can be done with a org.fife.ui.rtextarea.ToolTipSupplier that
calls into
CompletionProvider.getCompletionsAt(JTextComponent, java.awt.Point)
.
getToolTipText
in interface Completion
getToolTipText
in class AbstractCompletion
null
if
none.public String getType()
protected void possiblyAddDefinedIn(StringBuilder sb)
sb
- The buffer to append to.protected boolean possiblyAddDescription(StringBuilder sb)
sb
- The buffer to append to.public void setDefinedIn(String definedIn)
definedIn
- Where this variable is defined.getDefinedIn()
public String toString()
toString
in class BasicCompletion