echopoint.wizard
Class WizardNavigationEvent

java.lang.Object
  java.util.EventObject
      echopoint.wizard.WizardNavigationEvent

All Implemented Interfaces:

java.io.Serializable

public class WizardNavigationEvent
extends java.util.EventObject

The class provides the event that will be raised when navigation within a WizardPane takes place.

See Also:

Serialized Form

Field Summary

static int	CANCEL the user wants to cancel the wizard steps
static int	FINISH the user wants to finish the wizard steps
static int	NEXT the user wants the previous component
static int	PREVIOUS the user wants the next component

Fields inherited from class java.util.EventObject

source

Constructor Summary

WizardNavigationEvent(java.lang.Object source, int type, Component fromComponent, Component toComponent, int fromIndex, int toIndex)
WizardNavigationEvent constructor.

Method Summary

Component	getFromComponent() Returns the component navigated from.
int	getFromIndex() Returns the index of the component navigated from.
Component	getToComponent() Returns the component navigated to.
int	getToIndex() Returns the index of the component navigated to.
int	getType() Returns the type of Wizard Navigation that has occurred.
WizardPane	getWizardPane() Returns the WizardPane associated with this event

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PREVIOUS

public static final int PREVIOUS

the user wants the next component

See Also:

Constant Field Values

NEXT

public static final int NEXT

the user wants the previous component

See Also:

Constant Field Values

CANCEL

public static final int CANCEL

the user wants to cancel the wizard steps

See Also:

Constant Field Values

FINISH

public static final int FINISH

the user wants to finish the wizard steps

See Also:

Constant Field Values

Constructor Detail

WizardNavigationEvent

public WizardNavigationEvent(java.lang.Object source,
                             int type,
                             Component fromComponent,
                             Component toComponent,
                             int fromIndex,
                             int toIndex)

WizardNavigationEvent constructor.

Method Detail

getFromComponent

public Component getFromComponent()

Returns the component navigated from.

Returns:

nextapp.echo.Component

getFromIndex

public int getFromIndex()

Returns the index of the component navigated from.

Returns:

int

getToComponent

public Component getToComponent()

Returns the component navigated to.

Returns:

nextapp.echo.Component

getToIndex

public int getToIndex()

Returns the index of the component navigated to.

Returns:

int

getType

public int getType()

Returns the type of Wizard Navigation that has occurred. This can be one of the following values :

• PREVIOUS - the user wants the previous component
• NEXT - the user wants the next component
• CANCEL - the user wants to cancel the wizard steps
• FINISH - the user wants to finish the wizard steps

Returns:

int

getWizardPane

public WizardPane getWizardPane()

Returns the WizardPane associated with this event