FacesEventWrapper (OmniFaces 4.5 API)

java.lang.Object
- java.util.EventObject
- - jakarta.faces.event.FacesEvent
  - - org.omnifaces.event.FacesEventWrapper

All Implemented Interfaces:

FacesWrapper<FacesEvent>, Serializable
```
public abstract class FacesEventWrapper
extends FacesEvent
implements FacesWrapper<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

Constructors
Modifier	Constructor	Description
`protected`	`FacesEventWrapper(FacesEvent wrapped, UIComponent component)`	Construct a new faces event wrapper which wraps the given faces event for the given component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PhaseId`	`getPhaseId()`
`FacesEvent`	`getWrapped()`
`boolean`	`isAppropriateListener(FacesListener listener)`
`void`	`processListener(FacesListener listener)`
`void`	`queue()`
`void`	`setPhaseId(PhaseId phaseId)`

Methods inherited from class jakarta.faces.event.FacesEvent
getComponent, getFacesContext

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
```
protected FacesEventWrapper(FacesEvent wrapped,
                            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 FacesEvent
  - isAppropriateListener
```
public boolean isAppropriateListener(FacesListener listener)
```
    Specified by:
    
    isAppropriateListener in class FacesEvent
  - processListener
```
public void processListener(FacesListener listener)
```
    Specified by:
    
    processListener in class FacesEvent
  - getPhaseId
```
public PhaseId getPhaseId()
```
    Overrides:
    
    getPhaseId in class FacesEvent
  - setPhaseId
```
public void setPhaseId(PhaseId phaseId)
```
    Overrides:
    
    setPhaseId in class FacesEvent
  - getWrapped
```
public FacesEvent getWrapped()
```
    Specified by:
    
    getWrapped in interface FacesWrapper<FacesEvent>