com.actional.ui.plugin

Interface IPluginUI.IProvideMetadataContext

Enclosing interface:

IPluginUI

public static interface IPluginUI.IProvideMetadataContext

Method Summary

Modifier and Type	Method and Description
void	addPage(java.lang.String pageID, java.lang.String title) Indicates to the hosting platform the IDs and titles of the different pages that may be displayed during the configuration of the plug-in.
boolean	forRegistration() Returns a boolean value indicating whether the HTML GUI being generated is intended for the registration of the plug-in (true) or for the configuration of a new instance (false).
java.lang.Object	getProperty(java.lang.String key) Returns a property for the specified key.
void	setRequiresSettings(boolean val) Indicates to the hosting platform whether the plug-in's configuration UI is required.

Method Detail

forRegistration

boolean forRegistration()

Returns a boolean value indicating whether the HTML GUI being generated is intended for the registration of the plug-in (true) or for the configuration of a new instance (false).

Returns:

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

getProperty

java.lang.Object getProperty(java.lang.String key)

Returns a property for the specified key. Properties may be defined for some plug-ins. Please consult the documentation for each plug-in for the list of properties that may be available for those plug-ins.

Returns:

property corresponding to the specified key

setRequiresSettings

void setRequiresSettings(boolean val)

Indicates to the hosting platform whether the plug-in's configuration UI is required.

Parameters:

val - true if the plug-in requires any settings, false otherwise (default: true)

addPage

void addPage(java.lang.String pageID,
             java.lang.String title)

Indicates to the hosting platform the IDs and titles of the different pages that may be displayed during the configuration of the plug-in. Call this method once for each page in the order the pages should initially appear in the UI.

Parameters:

pageID - The page identifier for the page being added

title - The title which may be displayed by the hosting platform for this page