com.sun.webui.jsf.event
Class WizardEvent

java.lang.Object
  extended by java.util.EventObject
      extended by javax.faces.event.FacesEvent
          extended by com.sun.webui.jsf.event.WizardEvent
All Implemented Interfaces:
java.io.Serializable

public class WizardEvent
extends javax.faces.event.FacesEvent

WizardEvent is the event class broadcast by the Wizard to WizardEventListeners.

See Also:
Serialized Form

Field Summary
static int CANCEL
          The cancel button was clicked.
static int CLOSE
          The close button was clicked.
static int COMPLETE
          This event is broadcast by the Wizard in encodeEnd to indicate that this wizard session has completed.
static int DECODE
          Deprecated.  
static int FINISH
          The finish button was clicked.
static int GOTOSTEP
          A step link was clicked.
static int HELPTAB
          The help tab was clicked.
static int INVALID
          Deprecated.  
static int INVOKE_APPLICATION
          Deprecated.  
static int NEXT
          The next button was clicked.
static int NOEVENT
          This is an internal Wizard event and is not broadcast to application defined WizardEventListeners.
static int PREVIOUS
          The previous button was clicked.
static int RENDER
          Deprecated.  
static int START
          This event is broadcast by the Wizard in encodeBegin to indicate that this wizard session is being rendered the first time.
static int STEP_ENTER
          Deprecated.  
static int STEP_EXIT
          Deprecated.  
static int STEPSTAB
          The steps tab was clicked.
static int UPDATE
          Deprecated.  
static int VALIDATE
          Deprecated.  
 
Constructor Summary
WizardEvent(Wizard wizard)
          Contruct a WizardEvent instance, specifying the Wizard source.
WizardEvent(Wizard wizard, javax.faces.component.UIComponent navigationSource, int navigationEvent, java.lang.Object data)
          Deprecated. replaced by WizardEvent(Wizard, UIComponent, int, WizardStep, String)
WizardEvent(Wizard wizard, javax.faces.component.UIComponent eventSource, int event, WizardStep step, java.lang.String gotoStepId)
          Contruct a WizardEvent with event data.
 
Method Summary
 int getEvent()
          Return the WizardEvent constant identifying this event.
 javax.faces.component.UIComponent getEventSource()
          Return the wizard subcomponent that generated the original ActionEvent that queued this event.
 java.lang.String getGotoStepId()
          Return the component id of the WizardStep that the wizard will be proceeding to.
 int getNavigationEvent()
          Deprecated. replaced by getEvent()
 javax.faces.component.UIComponent getNavigationEventSource()
          Deprecated. replaced by getEventSource()
 WizardStep getStep()
          Return the WizardStep that generated this event.
 Wizard getWizard()
          Return the Wizard broadcasting this event.
 boolean isAppropriateListener(javax.faces.event.FacesListener listener)
          Return true if listener is an instance of WizardEventListener.
 void processListener(javax.faces.event.FacesListener listener)
           
 void setEvent(int event)
          Set the event constant identifying this event.
 void setNavigationEvent(int navigationEvent)
          Deprecated. replaced by setEvent(int)
 void setStep(WizardStep step)
          Set the WizardStep that generated this event.
 
Methods inherited from class javax.faces.event.FacesEvent
getComponent, getPhaseId, queue, setPhaseId
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CANCEL

public static final int CANCEL
The cancel button was clicked.

See Also:
Constant Field Values

CLOSE

public static final int CLOSE
The close button was clicked.

See Also:
Constant Field Values

FINISH

public static final int FINISH
The finish button was clicked.

See Also:
Constant Field Values

GOTOSTEP

public static final int GOTOSTEP
A step link was clicked.

See Also:
Constant Field Values

HELPTAB

public static final int HELPTAB
The help tab was clicked.

See Also:
Constant Field Values

NEXT

public static final int NEXT
The next button was clicked.

See Also:
Constant Field Values

PREVIOUS

public static final int PREVIOUS
The previous button was clicked.

See Also:
Constant Field Values

STEPSTAB

public static final int STEPSTAB
The steps tab was clicked.

See Also:
Constant Field Values

START

public static final int START
This event is broadcast by the Wizard in encodeBegin to indicate that this wizard session is being rendered the first time.

See Also:
Constant Field Values

COMPLETE

public static final int COMPLETE
This event is broadcast by the Wizard in encodeEnd to indicate that this wizard session has completed.

See Also:
Constant Field Values

NOEVENT

public static final int NOEVENT
This is an internal Wizard event and is not broadcast to application defined WizardEventListeners.

See Also:
Constant Field Values

INVALID

public static final int INVALID
Deprecated. 
See Also:
Constant Field Values

DECODE

public static final int DECODE
Deprecated. 
See Also:
Constant Field Values

VALIDATE

public static final int VALIDATE
Deprecated. 
See Also:
Constant Field Values

UPDATE

public static final int UPDATE
Deprecated. 
See Also:
Constant Field Values

INVOKE_APPLICATION

public static final int INVOKE_APPLICATION
Deprecated. 
See Also:
Constant Field Values

RENDER

public static final int RENDER
Deprecated. 
See Also:
Constant Field Values

STEP_ENTER

public static final int STEP_ENTER
Deprecated. 
See Also:
Constant Field Values

STEP_EXIT

public static final int STEP_EXIT
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

WizardEvent

public WizardEvent(Wizard wizard)
Contruct a WizardEvent instance, specifying the Wizard source.


WizardEvent

public WizardEvent(Wizard wizard,
                   javax.faces.component.UIComponent navigationSource,
                   int navigationEvent,
                   java.lang.Object data)
Deprecated. replaced by WizardEvent(Wizard, UIComponent, int, WizardStep, String)


WizardEvent

public WizardEvent(Wizard wizard,
                   javax.faces.component.UIComponent eventSource,
                   int event,
                   WizardStep step,
                   java.lang.String gotoStepId)
Contruct a WizardEvent with event data. Not all data will be available with all events. In particular:
Method Detail

getNavigationEvent

public int getNavigationEvent()
Deprecated. replaced by getEvent()


getEvent

public int getEvent()
Return the WizardEvent constant identifying this event.


setNavigationEvent

public void setNavigationEvent(int navigationEvent)
Deprecated. replaced by setEvent(int)


setEvent

public void setEvent(int event)
Set the event constant identifying this event.


getNavigationEventSource

public javax.faces.component.UIComponent getNavigationEventSource()
Deprecated. replaced by getEventSource()


getEventSource

public javax.faces.component.UIComponent getEventSource()
Return the wizard subcomponent that generated the original ActionEvent that queued this event.


getWizard

public Wizard getWizard()
Return the Wizard broadcasting this event.


getStep

public WizardStep getStep()
Return the WizardStep that generated this event.


setStep

public void setStep(WizardStep step)
Set the WizardStep that generated this event.


getGotoStepId

public java.lang.String getGotoStepId()
Return the component id of the WizardStep that the wizard will be proceeding to.


isAppropriateListener

public boolean isAppropriateListener(javax.faces.event.FacesListener listener)
Return true if listener is an instance of WizardEventListener.

Specified by:
isAppropriateListener in class javax.faces.event.FacesEvent
Parameters:
listener - appropriate listener for this event.

processListener

public void processListener(javax.faces.event.FacesListener listener)
Specified by:
processListener in class javax.faces.event.FacesEvent


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.