org.fife.ui.autocomplete
Interface ParameterizedCompletion

All Superinterfaces:
java.lang.Comparable<Completion>, Completion
All Known Implementing Classes:
FunctionCompletion, TemplateCompletion

public interface ParameterizedCompletion
extends Completion

A completion option that takes parameters, such as a function or method.

Version:
1.0
Author:
Robert Futrell

Nested Class Summary
static class ParameterizedCompletion.Parameter
          A parameter passed to a parameterized Completion.
 
Method Summary
 java.lang.String getDefinitionString()
          Returns the "definition string" for this 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 this completion takes.
 boolean getShowParameterToolTip()
          Returns whether a tool tip displaying assistance for each parameter while it is being edited is appropriate for this completion.
 
Methods inherited from interface org.fife.ui.autocomplete.Completion
compareTo, getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, getReplacementText, getSummary, getToolTipText
 

Method Detail

getDefinitionString

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

Returns:
The definition string.

getParam

ParameterizedCompletion.Parameter getParam(int index)
Returns the specified ParameterizedCompletion.Parameter.

Parameters:
index - The index of the parameter to retrieve.
Returns:
The parameter.
See Also:
getParamCount()

getParamCount

int getParamCount()
Returns the number of parameters this completion takes.

Returns:
The number of parameters this completion takes.
See Also:
getParam(int)

getInsertionInfo

org.fife.ui.autocomplete.ParameterizedCompletionInsertionInfo getInsertionInfo(javax.swing.text.JTextComponent tc,
                                                                               boolean replaceTabsWithSpaces)

getShowParameterToolTip

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

Returns:
Whether the tool tip is appropriate to display.