|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.fife.ui.autocomplete.AbstractCompletion org.fife.ui.autocomplete.BasicCompletion org.fife.ui.autocomplete.VariableCompletion org.fife.ui.autocomplete.FunctionCompletion
public class FunctionCompletion
A completion choice representing a function.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.fife.ui.autocomplete.ParameterizedCompletion |
---|
ParameterizedCompletion.Parameter |
Constructor Summary | |
---|---|
FunctionCompletion(CompletionProvider provider,
java.lang.String name,
java.lang.String returnType)
Constructor. |
Method Summary | |
---|---|
protected void |
addDefinitionString(java.lang.StringBuilder sb)
|
protected void |
addParameters(java.lang.StringBuilder sb)
Adds HTML describing the parameters to this function to a buffer. |
java.lang.String |
getDefinitionString()
Returns the "definition string" for this function completion. |
org.fife.ui.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 to this function. |
java.lang.String |
getReturnValueDescription()
Returns the description of the return value of this function. |
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. This can be used in a popup "description window." |
java.lang.String |
getToolTipText()
Returns the tool tip text to display for mouse hovers over this completion. |
void |
setParams(java.util.List<ParameterizedCompletion.Parameter> params)
Sets the parameters to this function. |
void |
setReturnValueDescription(java.lang.String desc)
Sets the description of the return value of this function. |
Methods inherited from class org.fife.ui.autocomplete.VariableCompletion |
---|
getDefinedIn, getName, getType, possiblyAddDefinedIn, possiblyAddDescription, setDefinedIn, toString |
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, setRelevance |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.fife.ui.autocomplete.Completion |
---|
compareTo, getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, getReplacementText |
Constructor Detail |
---|
public FunctionCompletion(CompletionProvider provider, java.lang.String name, java.lang.String returnType)
provider
- The parent provider.name
- The name of this function.returnType
- The return type of this function.Method Detail |
---|
protected void addDefinitionString(java.lang.StringBuilder sb)
addDefinitionString
in class VariableCompletion
protected void addParameters(java.lang.StringBuilder sb)
sb
- The buffer to append to.public java.lang.String getDefinitionString()
printf
" function, this would return
"int printf(const char *, ...)
".
getDefinitionString
in interface ParameterizedCompletion
getDefinitionString
in class VariableCompletion
public org.fife.ui.autocomplete.ParameterizedCompletionInsertionInfo getInsertionInfo(javax.swing.text.JTextComponent tc, boolean replaceTabsWithSpaces)
getInsertionInfo
in interface ParameterizedCompletion
public ParameterizedCompletion.Parameter getParam(int index)
ParameterizedCompletion.Parameter
.
getParam
in interface ParameterizedCompletion
index
- The index of the parameter to retrieve.
ParameterizedCompletion.getParamCount()
public int getParamCount()
getParamCount
in interface ParameterizedCompletion
getParam(int)
public boolean getShowParameterToolTip()
getShowParameterToolTip
in interface ParameterizedCompletion
public java.lang.String getReturnValueDescription()
null
if there is none.setReturnValueDescription(String)
public java.lang.String getSummary()
getSummary
in interface Completion
getSummary
in class VariableCompletion
null
if there is no description for this
completion.public java.lang.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 VariableCompletion
null
if
none.public void setParams(java.util.List<ParameterizedCompletion.Parameter> params)
params
- The parameters. This should be a list of
ParameterizedCompletion.Parameter
s.getParam(int)
,
getParamCount()
public void setReturnValueDescription(java.lang.String desc)
desc
- The description.getReturnValueDescription()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |