Constructor Detail

• FunctionCompletion

  public FunctionCompletion​(CompletionProvider provider,
                            String name,
                            String returnType)

  Constructor.

  Parameters:

  provider - The parent provider.

  name - The name of this function.

  returnType - The return type of this function.

Method Detail

• addDefinitionString

  protected void addDefinitionString​(StringBuilder sb)

  Overrides:

  addDefinitionString in class VariableCompletion

• addParameters

  protected void addParameters​(StringBuilder sb)

  Adds HTML describing the parameters to this function to a buffer.

  Parameters:

  sb - The buffer to append to.

• getDefinitionString

  public String getDefinitionString()

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

  Specified by:

  getDefinitionString in interface ParameterizedCompletion

  Overrides:

  getDefinitionString in class VariableCompletion

  Returns:

  The definition string.

• getInsertionInfo

  public org.fife.ui.autocomplete.ParameterizedCompletionInsertionInfo getInsertionInfo​(JTextComponent tc,
                                                                                        boolean replaceTabsWithSpaces)

  Specified by:

  getInsertionInfo in interface ParameterizedCompletion

• getParam

  public ParameterizedCompletion.Parameter getParam​(int index)

  Returns the specified ParameterizedCompletion.Parameter.

  Specified by:

  getParam in interface ParameterizedCompletion

  Parameters:

  index - The index of the parameter to retrieve.

  Returns:

  The parameter.

  See Also:

  ParameterizedCompletion.getParamCount()

• getParamCount

  public int getParamCount()

  Returns the number of parameters to this function.

  Specified by:

  getParamCount in interface ParameterizedCompletion

  Returns:

  The number of parameters to this function.

  See Also:

  getParam(int)

• getShowParameterToolTip

  public boolean getShowParameterToolTip()

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

  Specified by:

  getShowParameterToolTip in interface ParameterizedCompletion

  Returns:

  Whether the tool tip is appropriate to display.

• getReturnValueDescription

  public String getReturnValueDescription()

  Returns the description of the return value of this function.

  Returns:

  The description, or null if there is none.

  See Also:

  setReturnValueDescription(String)

• getSummary

  public String getSummary()

  Returns the description of this auto-complete choice. This can be used in a popup "description window."

  Specified by:

  getSummary in interface Completion

  Overrides:

  getSummary in class VariableCompletion

  Returns:

  This item's description. This should be HTML. It may be null if there is no description for this completion.

• getToolTipText

  public 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 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).

  Specified by:

  getToolTipText in interface Completion

  Overrides:

  getToolTipText in class VariableCompletion

  Returns:

  The tool tip text for this completion, or null if none.

• setParams

  public void setParams​(List<ParameterizedCompletion.Parameter> params)

  Sets the parameters to this function.

  Parameters:

  params - The parameters. This should be a list of ParameterizedCompletion.Parameters.

  See Also:

  getParam(int), getParamCount()

• setReturnValueDescription

  public void setReturnValueDescription​(String desc)

  Sets the description of the return value of this function.

  Parameters:

  desc - The description.

  See Also:

  getReturnValueDescription()