ILanguageDriver.IParameterHelp Interface

com.bea.ide.sourceeditor.driver
ILanguageDriver.IParameterHelp Interface

public static interface ILanguageDriver.IParameterHelp

IParameterHelp objects define individual options to be displayed in a parameter help popup. An IParameter help option is presented in the following format:

[prefix][parameter description][parameter separator]...[parameter description][suffix]

For example, a method 'void foo(int i, int j)' would be broken up as follows:
Display prefix: "void foo("
Display suffix: ")"
Parameter descriptions: {"int i", "int j"}
Parameter separator: ", "

Enclosing interface

ILanguageDriver

Method Summary

public String
getDisplayPrefix()
Returns the parameter help display prefix.
public String
getDisplaySuffix()
Returns the parameter help display suffix.
public String[]
getParameterDescriptions()
Returns the parameter help parameter descriptions.
public String
getParameterSeparator()
Returns the parameter help parameter separator.
public boolean
isPrimary()
Returns a boolean indicating whether this help option is considered more likely than others in the set (as returned by ILanguageDriver.IParameterHelp.getParameterHelp(int, char)) to be the correct parameter help item.

Method Detail

getDisplayPrefix() Method

public String getDisplayPrefix()
Returns the parameter help display prefix. See ILanguageDriver.IParameterHelp for formatting information.


getDisplaySuffix() Method

public String getDisplaySuffix()
Returns the parameter help display suffix. See ILanguageDriver.IParameterHelp for formatting information.


getParameterDescriptions() Method

public String[] getParameterDescriptions()
Returns the parameter help parameter descriptions. See ILanguageDriver.IParameterHelp for formatting information.


getParameterSeparator() Method

public String getParameterSeparator()
Returns the parameter help parameter separator. See ILanguageDriver.IParameterHelp for formatting information.


isPrimary() Method

public boolean isPrimary()
Returns a boolean indicating whether this help option is considered more likely than others in the set (as returned by ILanguageDriver.IParameterHelp.getParameterHelp(int, char)) to be the correct parameter help item. Items that return 'true' from this method will be given special highlighting in the UI. If no items in a parameter help set are flagged as being primary, all will be presented as equally likely in the UI.