Main Page   Packages   Class Hierarchy   Compound List   Compound Members   Related Pages  

scripting.NameCompleter Interface Reference

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

Inheritance diagram for scripting.NameCompleter:

scripting.BeanShellNameCompleter scripting.SearchableObjectRegistry 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


Member Function Documentation

List 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 scripting.BeanShellNameCompleter, and scripting.SearchableObjectRegistry.

List 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 scripting.BeanShellNameCompleter, and scripting.SearchableObjectRegistry.


The documentation for this interface was generated from the following file:
Generated on Mon Dec 15 19:38:45 2003 for SCT DAQ/DCS Software by doxygen1.3-rc3