com.actional.ui.plugin

Interface IPluginUI.IProcessPageContext

Enclosing interface:

IPluginUI

public static interface IPluginUI.IProcessPageContext

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.Object plainText, java.lang.Object html) Deprecated. Use addMessage(Message) or addMessage(Message, Object[]) instead.
void	addMessage(Message msg) Specifies a message to host application to either indicate an invalid setting, an exception or a status message.
void	addMessage(Message msg, java.lang.Object... args) Specifies a message to host application to either indicate an invalid setting, an exception or a status message.
void	addMessage(Message msg, java.lang.Object[] args, java.lang.Exception e) Specifies a message to host application to either indicate an invalid setting, an exception or a status message.
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	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.
ISettings	getMergedSettings() Returns the current merged settings of the plug-in.
IPluginUI.IPart	getPart(java.lang.String name) Gets the file content of one of your <input type='file'> HTML tags.
IRWSettings	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 one of your <input> HTML tags.
java.lang.String[]	getStringParameterValues(java.lang.String name) Gets the values of one of your <input> HTML tags.
boolean	nextPageRequested() Returns a boolean indicating whether or not the 'next' page was requested through the wizard.
boolean	previousPageRequested() Returns a boolean indicating whether or not the 'previous' page was requested through the wizard.
void	setPageToDisplay(java.lang.String pageID) Sets the page to be shown in the wizard, pending successful validation (if required).
void	setState(java.io.Serializable o) Stores the plug-in's state.

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

getIdPrefix

java.lang.String getIdPrefix()

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

Returns:

The ID prefix

getStringParameter

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

Gets the value of one of your <input> HTML tags. Don't forget to prefix the name of your parameter.

Returns:

The value of the specified String parameter

getStringParameterValues

java.lang.String[] getStringParameterValues(java.lang.String name)

Gets the values of one of your <input> HTML tags. Don't forget to prefix the name of your parameter.

Returns:

The value of the specified String parameter

getPart

IPluginUI.IPart getPart(java.lang.String name)

Gets the file content of one of your <input type='file'> HTML tags. Don't forget to prefix the name of your parameter.

Returns:

The value of the specified String parameter

addError

@Deprecated
void addError(java.lang.Object plainText,
                           java.lang.Object html)

Deprecated. Use addMessage(Message) or addMessage(Message, Object[]) instead.

Notifies the host application that one of the setting was invalid.

Parameters:

plainText - The error description in plain text

html - The error description in HTML markup

addMessage

void addMessage(Message msg)

Specifies a message to host application to either indicate an invalid setting, an exception or a status message. The message severity will be used to determine how the message should be handled by the host application.
Use this method instead of addMessage(Message, Object[]) if the message does not require any arguments.

Parameters:

msg - The message to be passed on to the host application

addMessage

void addMessage(Message msg,
                java.lang.Object... args)

Specifies a message to host application to either indicate an invalid setting, an exception or a status message. The message severity will be used to determine how the message should be handled by the host application.
Use this method instead of addMessage(Message) if the message requires at least one argument.

Parameters:

msg - The message to be passed on to the host application

args - A list of arguments for the specified message

addMessage

void addMessage(Message msg,
                java.lang.Object[] args,
                java.lang.Exception e)

Specifies a message to host application to either indicate an invalid setting, an exception or a status message. The message severity will be used to determine how the message should be handled by the host application.
Use this method instead of addMessage(Message) if the message requires at least one argument.

Parameters:

msg - The message to be passed on to the host application

args - A list of arguments for the specified message

e - An exception that should be wrapped using the specified message

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

setPageToDisplay

void setPageToDisplay(java.lang.String pageID)

Sets the page to be shown in the wizard, pending successful validation (if required).
This method may be used to override the default behavior which is to display all pages in the order in which they were defined by calling IPluginUI.IProvideMetadataContext.addPage(String, String).
When calling this method, previousPageRequested() and nextPageRequested() may be taken into account to determine whether the 'previous' or 'next' button was pressed.

Parameters:

pageID - The plug-in's state

previousPageRequested

boolean previousPageRequested()

Returns a boolean indicating whether or not the 'previous' page was requested through the wizard.

Returns:

true if a 'previous' navigation button was pressed, false otherwise

nextPageRequested

boolean nextPageRequested()

Returns a boolean indicating whether or not the 'next' page was requested through the wizard.

Returns:

true if a 'next' navigation button was pressed, false otherwise

getSettings

IRWSettings getSettings()

Returns the current settings of the plug-in.

Returns:

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

getMergedSettings

ISettings getMergedSettings()

Returns the current merged settings of the plug-in.
The ISettings contains the class settings of the plugin merged with the current instance settings.
The purpose of this method is to give the plugin the same view of the configuration that it will deal with at runtime (aka when it gets executed for real).

Returns:

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