|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.EventObject
javax.faces.event.FacesEvent
com.sun.webui.jsf.event.WizardEvent
public class WizardEvent
WizardEvent is the event class broadcast by the
Wizard to
WizardEventListeners.
| 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 |
|---|
public static final int CANCEL
public static final int CLOSE
public static final int FINISH
public static final int GOTOSTEP
public static final int HELPTAB
public static final int NEXT
public static final int PREVIOUS
public static final int STEPSTAB
public static final int START
encodeBegin to indicate
that this wizard session is being rendered the first time.
public static final int COMPLETE
encodeEnd to indicate
that this wizard session has completed.
public static final int NOEVENT
WizardEventListeners.
public static final int INVALID
public static final int DECODE
public static final int VALIDATE
public static final int UPDATE
public static final int INVOKE_APPLICATION
public static final int RENDER
public static final int STEP_ENTER
public static final int STEP_EXIT
| Constructor Detail |
|---|
public WizardEvent(Wizard wizard)
WizardEvent instance, specifying the
Wizard source.
public WizardEvent(Wizard wizard,
javax.faces.component.UIComponent navigationSource,
int navigationEvent,
java.lang.Object data)
WizardEvent(Wizard, UIComponent, int,
WizardStep, String)
public WizardEvent(Wizard wizard,
javax.faces.component.UIComponent eventSource,
int event,
WizardStep step,
java.lang.String gotoStepId)
WizardEvent with event data.
Not all data will be available with all events. In particular:
gotoStepId will only be available if the event
is GOTOSTEP.
eventSource will be null for the START
and COMPLETE events.
wizard - the wizard instance broadcasting this eventeventSource - the component that generated this eventevent - the WizardEvent constant identifying this eventstep - the WizardStep generating this eventgotoStepId - the id of the step the wizard will display next| Method Detail |
|---|
public int getNavigationEvent()
getEvent()
public int getEvent()
WizardEvent constant identifying this event.
public void setNavigationEvent(int navigationEvent)
setEvent(int)
public void setEvent(int event)
public javax.faces.component.UIComponent getNavigationEventSource()
getEventSource()
public javax.faces.component.UIComponent getEventSource()
ActionEvent that queued this event.
public Wizard getWizard()
Wizard broadcasting this event.
public WizardStep getStep()
WizardStep that generated this event.
public void setStep(WizardStep step)
WizardStep that generated this event.
public java.lang.String getGotoStepId()
WizardStep that the
wizard will be proceeding to.
public boolean isAppropriateListener(javax.faces.event.FacesListener listener)
true if listener is an instance of
WizardEventListener.
isAppropriateListener in class javax.faces.event.FacesEventlistener - appropriate listener for this event.public void processListener(javax.faces.event.FacesListener listener)
processListener in class javax.faces.event.FacesEvent
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||