org.apache.myfaces.trinidad.event
Class WindowLifecycleEvent
java.lang.Object
java.util.EventObject
org.apache.myfaces.trinidad.event.WindowEvent
org.apache.myfaces.trinidad.event.WindowLifecycleEvent
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- WindowLifecycleNavigateEvent
public class WindowLifecycleEvent
- extends WindowEvent
Event delivered when the LifecycleState of a Window changes. The cause
indicates the cause ot the state change. The state diagram for theWindow LifecycleStates
is
+-----------load---------------+
| | ---expire---
V /---unload----\ | / \
---open--->OPEN----- ----->UNLOADED-- -->CLOSED
| \--navigate---/ ^ \ /
| | ---close----
+---------closing--------------+
The new LifecycleStates can be retrieved by calling getLifecycleState
on the
source Window or by calling the getNewLifecycleState
convenience function
on the WindowLifecycleEvent
- See Also:
Window
,
Window.LifecycleState
,
Serialized Form
WindowLifecycleEvent
public WindowLifecycleEvent(Window source,
WindowLifecycleEvent.Cause cause)
- Creates a WindowOpenEvent event for the specified Window and cause.
getCause
public WindowLifecycleEvent.Cause getCause()
- Returns:
- the cause of the WindowOpen event.
getNewLifecycleState
public final Window.LifecycleState getNewLifecycleState()
- Returns the new LifecycleState that the Window has moved to.
hashCode
public int hashCode()
- Overrides:
hashCode
in class Object
equals
public boolean equals(Object o)
- Overrides:
equals
in class Object
toString
public String toString()
- Overrides:
toString
in class EventObject
subclassEquals
protected final boolean subclassEquals(WindowLifecycleEvent e)
- Called by subclass
equals
implementation to check the WindowEvent
portion of equivalence.
- Parameters:
e
- Non-null WindowEvent to compare for equality
- Returns:
true
if the the WindowEvent satisfies the WindowEvent portion
of equivalence.
Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.