org.fife.rsta.ac.js.completion

Class JSFunctionCompletion

java.lang.Object

FunctionCompletion

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

All Implemented Interfaces:

JSCompletion, JSCompletionUI

Direct Known Subclasses:

JSConstructorCompletion

public class JSFunctionCompletion
extends FunctionCompletion
implements JSCompletion

Nested Class Summary

Nested Classes

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

Field Summary

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 and Description
JSFunctionCompletion(CompletionProvider provider, MethodInfo method)
JSFunctionCompletion(CompletionProvider provider, MethodInfo methodInfo, boolean showParameterType)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Completion other)
boolean	equals(java.lang.Object obj)
java.lang.String	getAlreadyEntered(javax.swing.text.JTextComponent comp)
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()
int	getRelevance()
java.lang.String	getSignature()
java.lang.String	getSummary()
java.lang.String	getType()
java.lang.String	getType(boolean qualified)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JSFunctionCompletion

public JSFunctionCompletion(CompletionProvider provider,
                            MethodInfo method)

JSFunctionCompletion

public JSFunctionCompletion(CompletionProvider provider,
                            MethodInfo methodInfo,
                            boolean showParameterType)

Method Detail

compareTo

public int compareTo(Completion other)

equals

public boolean equals(java.lang.Object obj)

getAlreadyEntered

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

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()

getSignature

public java.lang.String getSignature()

getSummary

public java.lang.String getSummary()

hashCode

public int hashCode()

toString

public java.lang.String toString()

getType

public java.lang.String getType()

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()

getRelevance

public int getRelevance()

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()