com.actional.ui.plugin

Interface IPluginUI.IGeneratePageContext

Enclosing interface:

IPluginUI

public static interface IPluginUI.IGeneratePageContext

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	getClassSettings() This method returns the class settings of the plug-in.
java.lang.String	getCurrentPageId() Retrieves the identifier of the current page being processed.
java.lang.String	getIdPrefix() Returns the prefix for the IDs of the HTML <input> tags or other form elements.
java.lang.Object	getProperty(java.lang.String key) Returns a property for the specified key.
ISettings	getSettings() Returns the current settings of the plug-in.
java.io.Serializable	getState() Retrieves the plug-in's state.
java.lang.String	getStringParameter(java.lang.String name) Gets the value of a parameter that was specified when the page is being displayed using a URL obtained through generateUrl(String, String[], Object[]).
java.io.Writer	getWriter() Returns the writer object to be used when generating the HTML GUI.
boolean	isEditMode() Returns a boolean value indicating whether the HTML GUI is being generated for the plug-in's edit mode (true) or create mode (false)
void	setCancelPageId(java.lang.String pageId) Specifies the page ID of the plug-in page that should be shown if the user cancels the wizard on the current page.
void	setNavigationPreferences(boolean hasPreviousPage, boolean hasNextPage) Tells the hosting platform whether the plug-in requires navigation buttons to point to a previous or next page among the pages defined for this plug-in.
void	setState(java.io.Serializable o) Stores the plug-in's state.

Method Detail

getSettings

ISettings getSettings()

Returns the current settings of the plug-in.
If forRegistration() is true then it returns the class settings(settings given at the time of registration of the plug-in).
If forRegistration() is false then it returns the merged class & instance settings where the instance settings dominate the class settings.

Returns:

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

getClassSettings

ISettings getClassSettings()

This method returns the class settings of the plug-in.
If forRegistration() is true then it is the same as calling getSettings(). Both of these methods return the same value -> the class settings(settings at the time of registration of the plug-in).
If forRegistration() is false then it strictly returns the class settings of this plug-in instance which were configured during the registration of the plug-in.

Returns:

The ISettings instance containing the plug-in's class 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

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

isEditMode

boolean isEditMode()

Returns a boolean value indicating whether the HTML GUI is being generated for the plug-in's edit mode (true) or create mode (false)

Returns:

true if the UI is being generated in edit mode, false otherwise

getIdPrefix

java.lang.String getIdPrefix()

Returns the prefix for the IDs of the HTML <input> tags or other form elements.

Returns:

Prefix that should be prepended to IDs of HTML form elements.

getWriter

java.io.Writer getWriter()

Returns the writer object to be used when generating the HTML GUI.

Returns:

The Writer onto which to render the plug-in UI

setState

void setState(java.io.Serializable o)
       throws java.lang.Exception

Stores the plug-in's state.
This can be used by the plug-in to carry data for the duration of the wizard (for instance, what is the current page of the wizard).

Parameters:

o - The Serializable instance to be stored

Throws:

java.lang.Exception

getState

java.io.Serializable getState()

Retrieves the plug-in's state.

Returns:

The plug-in's state

getCurrentPageId

java.lang.String getCurrentPageId()

Retrieves the identifier of the current page being processed. This correspond to one of the page IDs provided through IPluginUI.IProvideMetadataContext.addPage(String, String).

Returns:

The page identifier for the current page

getStringParameter

java.lang.String getStringParameter(java.lang.String name)

Gets the value of a parameter that was specified when the page is being displayed using a URL obtained through generateUrl(String, String[], Object[]).

Returns:

The value of the specified String parameter

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 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

setCancelPageId

void setCancelPageId(java.lang.String pageId)

Specifies the page ID of the plug-in page that should be shown if the user cancels the wizard on the current page. If not specified, the entire wizard will be canceled.

Parameters:

pageId - The pageId of the cancel page

setNavigationPreferences

void setNavigationPreferences(boolean hasPreviousPage,
                              boolean hasNextPage)

Tells the hosting platform whether the plug-in requires navigation buttons to point to a previous or next page among the pages defined for this plug-in.
The default behavior when defining multiple plug-in pages is for the hosting platform to render the UIs for these pages in the order they were defined. Thus, this method only needs to be invoked if the plug-in page processing differs from that default behavior, e.g. by defining additional pages that would only be shown under special circumstances and that should not cause the hosting platform to display a 'next' button when in fact the plug-in does not expect a subsequent page to be shown.
Note that this method only specifies preferences from the plug-in's perspective and that the hosting platform may ultimately still display navigation buttons if the plug-in configuration pages are part of a wizard that includes additional pages before and after the plug-in configuration phase.
If 'hasPreviousPage' and 'hasNextPage' are false (which is the default), then the hosting platform may choose to display the buttons 'Ok' and 'Cancel', if possible.
If 'hasPreviousPage' or 'hasNextPage' is false, then the hosting platform may choose to display the default navigation buttons with the 'Previous' or 'Next' button disabled.

Parameters:

hasPreviousPage - true if the plug-in requires 'previous' button to point to another page defined for this plug-in

hasNextPage - true if the plug-in requires 'next' button to point to another page defined for this plug-in