GuiComponents.scripting.NameCompleter Interface Reference

Classes that implement this interface are used to help the interpreter complete a name. More...

Inheritance diagram for GuiComponents.scripting.NameCompleter:

[legend]List of all members.

Public Member Functions
List	completeName (String context, String part)
	This function is called whenever the owner wants to complete a string.
List	provideHelp (String method)
	This function returns a list of help Strings.

---

Detailed Description

Classes that implement this interface are used to help the interpreter complete a name.

Typically called after the user has pressed the TAB key. None of these methods may return null.

Author:

Matthew Palmer

Definition at line 15 of file NameCompleter.java.

---

Member Function Documentation

List GuiComponents.scripting.NameCompleter.completeName (  String  context, String  part )

This function is called whenever the owner wants to complete a string. The parameter context can be used to determine context. For instance, typing: "import java.la<TAB>" would give context = "import" and part = "java.la". Returns: A List of possible completions. Should only contain Strings. Parameters: context  The text preceding the string to be completed. part  The substring to be completed Implemented in GuiComponents.scripting.BeanShellNameCompleter, and GuiComponents.scripting.SearchableObjectRegistry. Referenced by GuiComponents.scripting.DefaultInterpreter.completeName().

List GuiComponents.scripting.NameCompleter.provideHelp (  String  method  )

This function returns a list of help Strings. It is intended to be used to help the user when calling a function/method by providing an argument list. Returns: a List of helpful Strings Parameters: method  The method string Implemented in GuiComponents.scripting.BeanShellNameCompleter, and GuiComponents.scripting.SearchableObjectRegistry.

---

The documentation for this interface was generated from the following file:

• NameCompleter.java

---