org.omnifaces.event
Class FacesEventWrapper

java.lang.Object
  extended by java.util.EventObject
      extended by javax.faces.event.FacesEvent
          extended by org.omnifaces.event.FacesEventWrapper
All Implemented Interfaces:
java.io.Serializable, javax.faces.FacesWrapper<javax.faces.event.FacesEvent>

public abstract class FacesEventWrapper
extends javax.faces.event.FacesEvent
implements javax.faces.FacesWrapper<javax.faces.event.FacesEvent>

Provides a simple implementation of FacesEvent that can be sub-classed by developers wishing to provide specialized behavior to an existing FacesEvent instance without the need to implement/override all the methods which do not necessarily need to be implemented. The default implementation of all methods expect of EventObject.getSource() and FacesEvent.getComponent() is to call through to the wrapped FacesEvent.

Since:
1.1
Author:
Bauke Scholtz
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
FacesEventWrapper(javax.faces.event.FacesEvent wrapped, javax.faces.component.UIComponent component)
          Construct a new faces event wrapper which wraps the given faces event for the given component.
 
Method Summary
 javax.faces.event.PhaseId getPhaseId()
           
 javax.faces.event.FacesEvent getWrapped()
           
 boolean isAppropriateListener(javax.faces.event.FacesListener listener)
           
 void processListener(javax.faces.event.FacesListener listener)
           
 void queue()
           
 void setPhaseId(javax.faces.event.PhaseId phaseId)
           
 
Methods inherited from class javax.faces.event.FacesEvent
getComponent
 
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
 

Constructor Detail

FacesEventWrapper

public FacesEventWrapper(javax.faces.event.FacesEvent wrapped,
                         javax.faces.component.UIComponent component)
Construct a new faces event wrapper which wraps the given faces event for the given component.

Parameters:
wrapped - The faces event to be wrapped.
component - The component to broadcast this event for.
Method Detail

queue

public void queue()
Overrides:
queue in class javax.faces.event.FacesEvent

isAppropriateListener

public boolean isAppropriateListener(javax.faces.event.FacesListener listener)
Specified by:
isAppropriateListener in class javax.faces.event.FacesEvent

processListener

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

getPhaseId

public javax.faces.event.PhaseId getPhaseId()
Overrides:
getPhaseId in class javax.faces.event.FacesEvent

setPhaseId

public void setPhaseId(javax.faces.event.PhaseId phaseId)
Overrides:
setPhaseId in class javax.faces.event.FacesEvent

getWrapped

public javax.faces.event.FacesEvent getWrapped()
Specified by:
getWrapped in interface javax.faces.FacesWrapper<javax.faces.event.FacesEvent>