Wizard

Method Summary
String	getCurrentDialog() Returns the name of the current dialog.
Data	getData() Returns the Data object for this wizard.
Data	getDialogData(String dialog) Returns the Data object the specified dialog.
String[]	getDialogValues(String dialog, String key) Returns the values associated with key and dialog if it exists, empty array otherwise. Used primarily for multi-select fields.
DisplaySettings	getDisplaySettings() Returns the DisplaySettings for this Wizard
String	getName() Returns the name of this wizard.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise.
String[]	getValues(String key) Returns the values associated with key if it exists, empty array otherwise. Used primarily for multi-select fields.
boolean	isCurrent() Returns true if all of the wizard dialogs have corresponding presentation in the Pal.
	rebuildFromPal(boolean preserve) Clears all information in the wizard, both data and dialog history. If preserve is true an attempt is made to preserve data and dialog history. All dialogs in the wizard after the first dialog that do not have a matching dialog in the pal are dropped along with associated data, if any. Warning: this may adversely impact the data and functionality of the wizard.
	setEndAction(String action) Sets the action that will be passed to the workflow when the wizard ends.
	setLinkedValues(boolean link) Allows to enable or disable link between fields with the same names on different wizard dialogs. Disabled by default.
	showDialog(String dialog, boolean clear) Sets the current dialog within the wizard for rendering, optionally clearing the history.
String	toString() Returns a description of this object.
boolean	wasChanged() Returns true if wizard was changed by the current request and false otherwise
boolean	wasDialogChanged(String pageName) Returns true if wizard dialog was changed by the current request and false otherwise

Method Detail

String getCurrentDialog()

Returns the name of the current dialog.

Returns: String

Since: 05-31-2007

top

Data getData()

Returns the Data object for this wizard.

Returns: Data

Since: 05-31-2007

top

Data getDialogData(String dialog)

Returns the Data object the specified dialog.

Parameters:

String dialog

Returns: Data

Since: 05-31-2007

top

String[] getDialogValues(String dialog, String key)

Returns the values associated with key and dialog if it exists, empty array otherwise. Used primarily for multi-select fields.

Parameters:

String dialog Required parameter.
String key Required parameter.

Returns: String[]

Since: 09-19-2012

top

DisplaySettings getDisplaySettings()

Returns the DisplaySettings for this Wizard

Returns: DisplaySettings

Since: 02-17-2009

top

String getName()

Returns the name of this wizard.

Returns: String

Since: 07-19-2007

top

String getValue(String key)

Returns the value associated with key if it exists, null otherwise.

Parameters:

String key

Returns: String

Since: 02-25-2008

top

String[] getValues(String key)

Returns the values associated with key if it exists, empty array otherwise. Used primarily for multi-select fields.

Parameters:

String key Required parameter.

Returns: String[]

Since: 09-19-2012

top

boolean isCurrent()

Returns true if all of the wizard dialogs have corresponding presentation in the Pal.

Returns: boolean

Since: 02-24-2011

top

rebuildFromPal(boolean preserve)

Clears all information in the wizard, both data and dialog history. If preserve is true an attempt is made to preserve data and dialog history. All dialogs in the wizard after the first dialog that do not have a matching dialog in the pal are dropped along with associated data, if any. Warning: this may adversely impact the data and functionality of the wizard.

Parameters: