jsx3.amp.util

class Wizard

->jsx3.lang.Object

->jsx3.amp.util.Wizard

All Implemented Interfaces:

jsx3.util.EventDispatcher

class Wizard
extends jsx3.lang.Object

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

Field Summary
static String	CANCEL Event subject published when a wizard is cancelled.
static String	FINISH Event subject published when a wizard is finished.
static String	NEXT Event subject published when a wizard advances to the next pane.
static String	PREVIOUS Event subject published when a wizard advances to the previous pane.

Constructor Summary
void	init() The instance initializer.

Method Summary
void	addPane(p : jsx3.amp.util.WizardPane) Adds a pane to this wizard.
void	cancel() Invokes the cancel button.
void	finish() Invokes the finish button.
jsx3.amp.util.WizardPane	getPane(index : int) Returns a pane of this wizard by its index.
int	getPaneCount() Returns the number of panes in this wizard.
int	getPaneIndex(p : jsx3.amp.util.WizardPane) Returns the index of a pane of this wizard.
Object	getSession() Returns the wizard session object.
void	next() Invokes the next button.
void	previous() Invokes the previous button.
void	removePane(index : int) Removes a pane from this wizard by its list index.
void	renderIn(objContainer : jsx3.app.Model) Renders the wizard UI as a child of objContainer.
void	setButtonState(previous : boolean, next : boolean, finish : boolean, cancel : boolean) Updates the enabled button states of the four wizard buttons.

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

Field Detail

CANCEL

static String CANCEL

Event subject published when a wizard is cancelled.

FINISH

static String FINISH

Event subject published when a wizard is finished.

NEXT

static String NEXT

Event subject published when a wizard advances to the next pane.

PREVIOUS

static String PREVIOUS

Event subject published when a wizard advances to the previous pane.

Constructor Detail

init

void init()

The instance initializer.

Method Detail

addPane

void addPane(p : jsx3.amp.util.WizardPane)

Adds a pane to this wizard.

Parameters:

p –

cancel

void cancel()

Invokes the cancel button.

finish

void finish()

Invokes the finish button.

getPane

jsx3.amp.util.WizardPane getPane(index : int)

Returns a pane of this wizard by its index.

Parameters:

index –

Returns:

getPaneCount

int getPaneCount()

Returns the number of panes in this wizard.

Returns:

getPaneIndex

int getPaneIndex(p : jsx3.amp.util.WizardPane)

Returns the index of a pane of this wizard.

Parameters:

p –

Returns:

getSession

Object getSession()

Returns the wizard session object. The session can be used by wizard panes to store arbitrary data for the duration of the wizard.

Returns:

next

void next()

Invokes the next button.

previous

void previous()

Invokes the previous button.

removePane

void removePane(index : int)

Removes a pane from this wizard by its list index.

Parameters:

index –

renderIn

void renderIn(objContainer : jsx3.app.Model)

Renders the wizard UI as a child of objContainer.

Parameters:

objContainer –

setButtonState

void setButtonState(previous : boolean, next : boolean, finish : boolean, cancel : boolean)

Updates the enabled button states of the four wizard buttons.

Parameters:

previous –

next –

finish –

cancel –

Copyright © 2001-2011, TIBCO Software Inc.