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

Class JavaScriptMethodCompletion

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

All Implemented Interfaces:

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

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

Nested Class Summary

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 Method	method
private java.lang.String	nameAndParameters
private boolean	systemFunction

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
JavaScriptMethodCompletion(org.fife.ui.autocomplete.CompletionProvider provider, Method method)

Method Summary

Modifier and Type	Method	Description
int	compareTo(org.fife.ui.autocomplete.Completion other)
private java.lang.String	createNameAndParameters()
boolean	equals(java.lang.Object obj)
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()
private java.lang.String	getMethodSummary()
int	getRelevance()
java.lang.String	getSignature()
java.lang.String	getSummary()
java.lang.String	getType(boolean qualified)
int	hashCode()	Overridden since equals() is overridden.
boolean	isSystemFunction()
void	setSystemFunction(boolean systemFunction)
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, getType, 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

getAlreadyEntered, 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

getAlreadyEntered, getInputText, getProvider, getReplacementText, getToolTipText

Field Detail

method

private Method method

compareString

private java.lang.String compareString

systemFunction

private boolean systemFunction

nameAndParameters

private java.lang.String nameAndParameters

Constructor Detail

JavaScriptMethodCompletion

public JavaScriptMethodCompletion(org.fife.ui.autocomplete.CompletionProvider provider,
                                  Method method)

Method Detail

createNameAndParameters

private java.lang.String createNameAndParameters()

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

setSystemFunction

public void setSystemFunction(boolean systemFunction)

isSystemFunction

public boolean isSystemFunction()

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

getSignature

public java.lang.String getSignature()

hashCode

public int hashCode()

Overridden since equals() is overridden.

Overrides:

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

toString

public java.lang.String toString()

Overrides:

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

getMethodSummary

private java.lang.String getMethodSummary()

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

getCompareString

private java.lang.String getCompareString()

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

getType

public java.lang.String getType(boolean qualified)

Specified by:

getType in interface JSCompletion

Returns:

JavaScript type from Completion qualified

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.

getLookupName

public java.lang.String getLookupName()

Specified by:

getLookupName in interface JSCompletion

Returns:

a logical lookup name that is unique