Package org.fife.rsta.ac.js.completion

Class JSFunctionCompletion

java.lang.Object

org.fife.ui.autocomplete.AbstractCompletion

org.fife.ui.autocomplete.BasicCompletion

org.fife.ui.autocomplete.VariableCompletion

org.fife.ui.autocomplete.FunctionCompletion

org.fife.rsta.ac.js.completion.JSFunctionCompletion

All Implemented Interfaces:

java.lang.Comparable<org.fife.ui.autocomplete.Completion>, JSCompletion, JSCompletionUI, org.fife.ui.autocomplete.Completion, org.fife.ui.autocomplete.ParameterizedCompletion

Direct Known Subclasses:

JSConstructorCompletion

public class JSFunctionCompletion
extends org.fife.ui.autocomplete.FunctionCompletion
implements JSCompletion

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JSFunctionCompletion.JSFunctionParam	Override the FunctionCompletion.Parameter to look up the Javascript name for the completion type

Nested classes/interfaces inherited from interface org.fife.ui.autocomplete.ParameterizedCompletion

org.fife.ui.autocomplete.ParameterizedCompletion.Parameter

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	compareString
private JSMethodData	methodData
private java.lang.String	nameAndParameters

Fields inherited from interface org.fife.rsta.ac.js.completion.JSCompletionUI

BASIC_COMPLETION_RELEVANCE, BEAN_METHOD_RELEVANCE, DEFAULT_CLASS_RELEVANCE, DEFAULT_FUNCTION_RELEVANCE, DEFAULT_VARIABLE_RELEVANCE, GLOBAL_FUNCTION_RELEVANCE, GLOBAL_VARIABLE_RELEVANCE, LOCAL_VARIABLE_RELEVANCE, STATIC_FIELD_RELEVANCE, TEMPLATE_RELEVANCE

Constructor Summary

Constructors

Constructor	Description
JSFunctionCompletion(org.fife.ui.autocomplete.CompletionProvider provider, MethodInfo method)
JSFunctionCompletion(org.fife.ui.autocomplete.CompletionProvider provider, MethodInfo methodInfo, boolean showParameterType)

Method Summary

Modifier and Type	Method	Description
int	compareTo(org.fife.ui.autocomplete.Completion other)
boolean	equals(java.lang.Object obj)
private static java.lang.String	formatMethodAtString(java.lang.String name, JSMethodData method)
java.lang.String	getAlreadyEntered(javax.swing.text.JTextComponent comp)
private java.lang.String	getCompareString()
java.lang.String	getDefinitionString()
java.lang.String	getEnclosingClassName(boolean fullyQualified)	Returns the name of the enclosing class.
javax.swing.Icon	getIcon()
java.lang.String	getLookupName()
JSMethodData	getMethodData()
private static java.lang.String	getMethodName(MethodInfo info, org.fife.ui.autocomplete.CompletionProvider provider)
private java.lang.String	getMethodSummary()
private java.lang.String	getNameAndParameters()
int	getRelevance()
java.lang.String	getSignature()
java.lang.String	getSummary()
java.lang.String	getType()
java.lang.String	getType(boolean qualified)
int	hashCode()
private java.util.List<org.fife.ui.autocomplete.ParameterizedCompletion.Parameter>	populateParams(JSMethodData methodData, boolean showParameterType)
java.lang.String	toString()

Methods inherited from class org.fife.ui.autocomplete.FunctionCompletion

addDefinitionString, addParameters, getInsertionInfo, getParam, getParamCount, getReturnValueDescription, getShowParameterToolTip, getToolTipText, setParams, setReturnValueDescription

Methods inherited from class org.fife.ui.autocomplete.VariableCompletion

getDefinedIn, getName, possiblyAddDefinedIn, possiblyAddDescription, setDefinedIn

Methods inherited from class org.fife.ui.autocomplete.BasicCompletion

getReplacementText, getShortDescription, setShortDescription, setSummary

Methods inherited from class org.fife.ui.autocomplete.AbstractCompletion

getInputText, getProvider, setIcon, setRelevance

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fife.ui.autocomplete.Completion

getInputText, getProvider, getReplacementText, getToolTipText

Field Detail

methodData

private JSMethodData methodData

compareString

private java.lang.String compareString

nameAndParameters

private java.lang.String nameAndParameters

Constructor Detail

JSFunctionCompletion

public JSFunctionCompletion(org.fife.ui.autocomplete.CompletionProvider provider,
                            MethodInfo method)

JSFunctionCompletion

public JSFunctionCompletion(org.fife.ui.autocomplete.CompletionProvider provider,
                            MethodInfo methodInfo,
                            boolean showParameterType)

Method Detail

getMethodName

private static java.lang.String getMethodName(MethodInfo info,
                                              org.fife.ui.autocomplete.CompletionProvider provider)

populateParams

private java.util.List<org.fife.ui.autocomplete.ParameterizedCompletion.Parameter> populateParams(JSMethodData methodData,
                                                                                                  boolean showParameterType)

compareTo

public int compareTo(org.fife.ui.autocomplete.Completion other)

Specified by:

compareTo in interface java.lang.Comparable<org.fife.ui.autocomplete.Completion>

Specified by:

compareTo in interface org.fife.ui.autocomplete.Completion

Overrides:

compareTo in class org.fife.ui.autocomplete.FunctionCompletion

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class org.fife.ui.autocomplete.FunctionCompletion

getAlreadyEntered

public java.lang.String getAlreadyEntered(javax.swing.text.JTextComponent comp)

Specified by:

getAlreadyEntered in interface org.fife.ui.autocomplete.Completion

Overrides:

getAlreadyEntered in class org.fife.ui.autocomplete.AbstractCompletion

getCompareString

private java.lang.String getCompareString()

getLookupName

public java.lang.String getLookupName()

Specified by:

getLookupName in interface JSCompletion

Returns:

a logical lookup name that is unique

getDefinitionString

public java.lang.String getDefinitionString()

Specified by:

getDefinitionString in interface org.fife.ui.autocomplete.ParameterizedCompletion

Overrides:

getDefinitionString in class org.fife.ui.autocomplete.FunctionCompletion

getMethodSummary

private java.lang.String getMethodSummary()

getNameAndParameters

private java.lang.String getNameAndParameters()

formatMethodAtString

private static java.lang.String formatMethodAtString(java.lang.String name,
                                                     JSMethodData method)

getSignature

public java.lang.String getSignature()

getSummary

public java.lang.String getSummary()

Specified by:

getSummary in interface org.fife.ui.autocomplete.Completion

Overrides:

getSummary in class org.fife.ui.autocomplete.FunctionCompletion

hashCode

public int hashCode()

Overrides:

hashCode in class org.fife.ui.autocomplete.FunctionCompletion

toString

public java.lang.String toString()

Overrides:

toString in class org.fife.ui.autocomplete.VariableCompletion

getType

public java.lang.String getType()

Overrides:

getType in class org.fife.ui.autocomplete.VariableCompletion

getType

public java.lang.String getType(boolean qualified)

Specified by:

getType in interface JSCompletion

Returns:

JavaScript type from Completion qualified

getIcon

public javax.swing.Icon getIcon()

Specified by:

getIcon in interface org.fife.ui.autocomplete.Completion

Overrides:

getIcon in class org.fife.ui.autocomplete.AbstractCompletion

getRelevance

public int getRelevance()

Specified by:

getRelevance in interface org.fife.ui.autocomplete.Completion

Overrides:

getRelevance in class org.fife.ui.autocomplete.AbstractCompletion

getEnclosingClassName

public java.lang.String getEnclosingClassName(boolean fullyQualified)

Description copied from interface: JSCompletion

Returns the name of the enclosing class.

Specified by:

getEnclosingClassName in interface JSCompletion

Parameters:

fullyQualified - Whether the name returned should be fully qualified.

Returns:

The class name.

getMethodData

public JSMethodData getMethodData()