com.actional.ui.plugin

Interface ISettingDescriber.IProvideMetadataContext

Enclosing interface:

ISettingDescriber

public static interface ISettingDescriber.IProvideMetadataContext

Method Summary

Modifier and Type	Method and Description
ISettingUIDescription	declareSetting(java.lang.String name, int type, java.lang.String label) Adds a new setting description.
boolean	forRegistration() Determines whether the HTML GUI that must be generated is intended for the registration of the plug-in (true) or for the configuration of new instances (false).
void	setEditHelpText(Message helpText) Sets the help text for the plug-in that will be displayed on the 'edit' page
void	setSummaryHelpText(Message helpText) Sets the help text for the plug-in that will be displayed on the summary page
void	setTitle(Message title) Sets the title for the plug-in that will be displayed at the top of the plug-in's 'edit' page

Method Detail

forRegistration

boolean forRegistration()

Determines whether the HTML GUI that must be generated is intended for the registration of the plug-in (true) or for the configuration of new instances (false).

Returns:

true if the UI is intended for the plug-in's registration, false otherwise

setTitle

void setTitle(Message title)

Sets the title for the plug-in that will be displayed at the top of the plug-in's 'edit' page

setSummaryHelpText

void setSummaryHelpText(Message helpText)

Sets the help text for the plug-in that will be displayed on the summary page

Parameters:

helpText - The help text associated with the plug-in

setEditHelpText

void setEditHelpText(Message helpText)

Sets the help text for the plug-in that will be displayed on the 'edit' page

Parameters:

helpText - The help text associated with the plug-in

declareSetting

ISettingUIDescription declareSetting(java.lang.String name,
                                     int type,
                                     java.lang.String label)

Adds a new setting description. The name, type and label are mandatory.
Note: If no settings are declared either for the plug-in's registration or the configuration of one of its instances, it is assumed that the plug-in does not require any UI-based configuration for its settings and

Parameters:

name - Programmatic name of the setting being declared

type - one of ISettingTypes

label - Display name of the setting being declared

Returns:

the ISettingUIDescription instance for the newly declared setting