com.actional.ui.plugin

Interface IPluginUI.IDescribeContext

Enclosing interface:

IPluginUI

public static interface IPluginUI.IDescribeContext

Method Summary

Modifier and Type	Method and Description
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.String	generateUrl(java.lang.String pageId, java.lang.String[] names, java.lang.Object[] values) Generates a URL that may be used by the plug-in to specify a URL referring to (a particular page within) the plug-in's UI.
ISettings	getSettings() Returns the current settings of the plug-in.
java.io.Writer	getWriter() Returns the writer object to be used for rendering a summary of the plug-in.

Method Detail

getSettings

ISettings getSettings()

Returns the current settings of the plug-in.

Returns:

The ISettings instance containing the plug-in's current settings.

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

generateUrl

java.lang.String generateUrl(java.lang.String pageId,
                             java.lang.String[] names,
                             java.lang.Object[] values)

Generates a URL that may be used by the plug-in to specify a URL referring to (a particular page within) the plug-in's UI. This URL may be used to generate hyperlinks referring to individual plug-in pages and passing additional parameters which may be subsequently retrieved using IPluginUI.IGeneratePageContext.getStringParameter(String).

Parameters:

pageId - The pageId of the plug-in page to be displayed or null for the first page

names - Parameter names that should be included in the URL being generated; must match the number of values provided in the values parameter

values - Parameter values that should be included in the URL being generated; must match the number of names provided in the names parameter

Returns:

The value of the specified String parameter

getWriter

java.io.Writer getWriter()

Returns the writer object to be used for rendering a summary of the plug-in.

Returns:

The Writer onto which to render the plug-in summary