jsx3.amp.util

class WizardPane

->jsx3.lang.Object

->jsx3.amp.util.WizardPane

All Implemented Interfaces:

jsx3.util.EventDispatcher

class WizardPane
extends jsx3.lang.Object

A pane of a wizard. Provided by the jsx3.amp.util.wizard plug-in.

Constructor Summary
jsx3.app.Model	init(data : jsx3.xml.Entity \| jsx3.amp.Resource, resolver : jsx3.amp.PlugIn) The instance initializer.

Method Summary
jsx3.app.Model	getFirstResponder() Returns the object in the UI of this pane that should be focused when the pane is revealed.
String	getTitle() Returns the title of this pane.
jsx3.app.Model	getUI() Returns the root UI component of this pane once it has been rendered.
jsx3.amp.util.Wizard	getWizard() Returns the wizard owning this pane.
boolean	mayCancel() Returns true if the cancel button should be enabled.
boolean	mayFinish() Returns true if the finish button should be enabled.
boolean	mayNext() Returns true if the next button should be enabled.
boolean	mayPrevious() Returns true if the previous button should be enabled.
void	onEnter(objSession : Object) Called when this pane is revealed.
void	onExit(objSession : Object) Called when this pane is hidden.
void	onNext() Called when the UI requests continuing to the next pane.
void	onPrevious() Called when the UI requests backtracking to the previous pane.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Constructor Detail

init

jsx3.app.Model init(data : jsx3.xml.Entity | jsx3.amp.Resource, resolver : jsx3.amp.PlugIn)

The instance initializer.

Parameters:

data – the UI component that renders this pane.

resolver – the plug-in against which to resolve paths in the UI component.

Returns:

Method Detail

getFirstResponder

jsx3.app.Model getFirstResponder()

Returns the object in the UI of this pane that should be focused when the pane is revealed. This method delegates to the getFirstResponder() method of the UI component, if that method is defined.

Returns:

getTitle

String getTitle()

Returns the title of this pane.

Returns:

getUI

jsx3.app.Model getUI()

Returns the root UI component of this pane once it has been rendered.

Returns:

getWizard

jsx3.amp.util.Wizard getWizard()

Returns the wizard owning this pane.

Returns:

mayCancel

boolean mayCancel()

Returns true if the cancel button should be enabled.

Returns:

mayFinish

boolean mayFinish()

Returns true if the finish button should be enabled.

Returns:

mayNext

boolean mayNext()

Returns true if the next button should be enabled.

Returns:

mayPrevious

boolean mayPrevious()

Returns true if the previous button should be enabled.

Returns:

onEnter

void onEnter(objSession : Object)

Called when this pane is revealed. Calls the onReveal() method of the root UI component, if that method is defined.

Parameters:

objSession –

onExit

void onExit(objSession : Object)

Called when this pane is hidden. Calls the onConceal() method of the root UI component, if that method is defined.

Parameters:

objSession –

onNext

void onNext()

Called when the UI requests continuing to the next pane. This pane may veto such a change by returning an object with the ok field equal to false.

Returns:

{ok:Boolean, alert:Boolean, title:String, message:String}

onPrevious

void onPrevious()

Called when the UI requests backtracking to the previous pane. This pane may veto such a change by returning an object with the ok field equal to false.

Returns:

{ok:Boolean, alert:Boolean, title:String, message:String}