Class idx.layout.WizardPane

Provides a pane in the idx.layout._Wizard.
Defined in: <idx\layout\WizardPane.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	idx.layout.WizardPane()

Field Summary

Field Attributes	Field Name and Description
	disabled Boolean indicating if this pane is displayed.
	finishable Boolean indicating if the finish button should enable when this pane is the current pane.
	headingOnly Boolean indicating if this pane is only a heading with no content.
	hidden Boolean indicating if this pane should be hidden.
	labelClass An extra, optional class to add to the table of contents label node.
	next Optionally, specifies the next WizardPane to display when the Next button is selected.
	parent If substep = true, then this will contain the parent idx.layout.WizardPane after the pane is added to the wizard.
	savable Boolean indicating if the save button should be enabled or disabled when this pane is the current pane.
	substep Boolean indicating if this is a sub-step.
	valid Boolean indicating if the data on the pane is valid.
	visited Boolean indicating if the pane is visited.

Method Summary

Method Attributes	Method Name and Description
	clearSubsteps() Call this method to clear the sub-steps.
	getData() This method should return the data entered on this pane.
	hideSubsteps(bool) Call this method to hide or show the sub-steps.
	isSelectable() Returns true if this pane can be selected.
	onClear() Event fired when the wizard data is cleared.
	onNext() Event fired when the user hit Next and this pane will no longer be selected / shown.
	onPrevious() Event fired when the user hit Previous and this pane will no longer be selected / shown.
	onSelect() Event fired when this pane is going to be selected / shown.
	postCreate()
	setData(data) This method set set the data on this pane.

Constructor Detail

idx.layout.WizardPane()

Field Detail

disabled

Boolean indicating if this pane is displayed. If true, this pane's label displays in the table of contents as disabled, but the pane will be skipped when the user hits Next. Default is false.

finishable

Boolean indicating if the finish button should enable when this pane is the current pane. Default is false. (Note: for the last pane in the wizard, this value is ignored.) Default is false.

headingOnly

Boolean indicating if this pane is only a heading with no content. If true, this pane's label will display in the table of contents, but the pane will be skipped when the user hits Next. Default is false.

hidden

Boolean indicating if this pane should be hidden. If true, this pane is skipped when the user hits Next. For the table of contents wizard, this pane's label will not display in the table of contents. Default is false.

labelClass

An extra, optional class to add to the table of contents label node.

Optionally, specifies the next WizardPane to display when the Next button is selected.

parent

If substep = true, then this will contain the parent idx.layout.WizardPane after the pane is added to the wizard.

savable

Boolean indicating if the save button should be enabled or disabled when this pane is the current pane. (This setting only applies when the save button is displayed in the wizard.) Default is true.

substep

Boolean indicating if this is a sub-step. Default is false.

valid

Boolean indicating if the data on the pane is valid. If true and this is the current pane, then the _Wizard enables the Next (or Finish) button. If false and this is the current pane, then the _Wizard disables the Next button (or Finish). Default is true.

visited

Boolean indicating if the pane is visited. Default is false. This value will be updated when the pane is selected.

Method Detail

clearSubsteps()

Call this method to clear the sub-steps. The _Wizard listens to this event and calls clearData for all of this step's sub-steps.

getData()

This method should return the data entered on this pane. Users of this widget can enhance this method to return the data the user entered in the fields on this pane.

Returns:: An object containing the data on this pane.

hideSubsteps(bool)

Call this method to hide or show the sub-steps. The _Wizard listens to this event and sets the hidden attribute for all of this step's sub-steps.

Parameters:
bool: A boolean indicating if this pane's substeps should be hidden or shown.

isSelectable()

Returns true if this pane can be selected. Hidden, disabled, and heading only panes cannot be selected.

Returns:: Boolean indicating if the pane can be selected.

onClear()

Event fired when the wizard data is cleared.

onNext()

Event fired when the user hit Next and this pane will no longer be selected / shown.

onPrevious()

Event fired when the user hit Previous and this pane will no longer be selected / shown.

onSelect()

Event fired when this pane is going to be selected / shown.

postCreate()

setData(data)

This method set set the data on this pane. Users of this widget can enhance this method to update the UI with the data passed into this method.

Parameters:
data