Package 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.

In order to use any instance of a ParameterizedCompletion, you need to call AutoCompletion.setParameterAssistanceEnabled(boolean) with a value of true first. Otherwise, any completion choices will be visible in the completion list, but won't insert anything when selected.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ParameterizedCompletion.Parameter	A parameter passed to a parameterized Completion.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefinitionString()	Returns the "definition string" for this completion.
ParameterizedCompletionInsertionInfo	getInsertionInfo(javax.swing.text.JTextComponent tc, boolean replaceTabsWithSpaces)	Returns completion information for this parameterized completion, given the specified text component.
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

ParameterizedCompletionInsertionInfo getInsertionInfo(javax.swing.text.JTextComponent tc,
                                                      boolean replaceTabsWithSpaces)

Returns completion information for this parameterized completion, given the specified text component.

Parameters:

tc - The text component.

replaceTabsWithSpaces - Whether to replace tabs with spaces.

Returns:

The completion info.

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.