public abstract class BasePolytypeListener extends Object implements javax.faces.component.StateHolder, javax.faces.event.ActionListener, javax.faces.event.ValueChangeListener, org.apache.myfaces.trinidad.event.DisclosureListener, PopupFetchListener, PopupCanceledListener, org.apache.myfaces.trinidad.event.FocusListener, ItemListener, org.apache.myfaces.trinidad.event.LaunchListener, org.apache.myfaces.trinidad.event.PollListener, org.apache.myfaces.trinidad.event.RangeChangeListener, org.apache.myfaces.trinidad.event.ReturnListener, org.apache.myfaces.trinidad.event.RowDisclosureListener, org.apache.myfaces.trinidad.event.SelectionListener, SpringboardChangeListener, org.apache.myfaces.trinidad.event.SortListener, DialogListener, LaunchPopupListener, QueryListener, QueryOperationListener, RegionNavigationListener, ReturnPopupDataListener, ReturnPopupListener, CalendarListener, CalendarActivityListener, CalendarActivityDurationChangeListener, CalendarDisplayChangeListener, ContextInfoListener, CarouselSpinListener
Note: This abstract listener should support all faces events we provide in our component library. To add a new event, consider the following:
Modifier and Type | Class and Description |
---|---|
static class |
BasePolytypeListener.EventType
These enumerations define the types of events this listener can process.
|
Constructor and Description |
---|
BasePolytypeListener(BasePolytypeListener.EventType eventType)
Constructor requires an enumeration of
BasePolytypeListener.EventType that defines what associated event this particular instance handles. |
Modifier and Type | Method and Description |
---|---|
static boolean |
addListener(BasePolytypeListener listener, javax.faces.component.UIComponent component)
Registers a poly type listener with the component.
|
protected BasePolytypeListener.EventType |
getEventType()
Gets the eventType from the state holder bean.
|
protected org.apache.myfaces.trinidad.bean.FacesBean |
getFacesBean() |
protected abstract void |
handleEvent(javax.faces.event.FacesEvent event)
Called passing in the target event of the registered event type.
|
protected boolean |
isAppropriate(javax.faces.event.FacesEvent event)
This method is similar to the
isAppropriateListener you might find on a concrete instance of FacesEvent but this check is not if the listener implements an interface. |
boolean |
isTransient()
Realization of
StateHolder . |
protected void |
process(javax.faces.event.FacesEvent event)
If the event matchings the target
eventType then delecate to the handleEvent method. |
void |
processAction(javax.faces.event.ActionEvent event)
The
ActionListener implementation that resets input component values under the process root. |
void |
processCalendar(CalendarEvent event)
The
CalendarListener implementation that resets input component values under the process root. |
void |
processCalendarActivity(CalendarActivityEvent event)
The
CalendarActivityListener implementation that resets input component values under the process root. |
void |
processCalendarActivityDurationChange(CalendarActivityDurationChangeEvent event)
The
CalendarActivityDurationChangeListener implementation that resets input component values under the process root. |
void |
processCalendarDisplayChange(CalendarDisplayChangeEvent event)
The
CalendarDisplayChangeListener implementation that resets input component values under the process root. |
void |
processCarouselSpin(CarouselSpinEvent event)
The
CarouselSpinListener implementation that resets input component values under the process root. |
void |
processContextInfo(ContextInfoEvent event)
The
ContextInfoListener implementation that resets input component values under the process root. |
void |
processDataReturn(ReturnPopupDataEvent event)
The
ReturnPopupDataListener implementation that resets input component values under the process root. |
void |
processDialog(DialogEvent event)
The
DialogListener implementation that resets input component values under the process root. |
void |
processDisclosure(org.apache.myfaces.trinidad.event.DisclosureEvent event)
The
DisclosureListener implementation that resets input component values under the process root. |
void |
processDisclosure(org.apache.myfaces.trinidad.event.RowDisclosureEvent event)
The
RowDisclosureListener implementation that resets input component values under the process root. |
void |
processFocus(org.apache.myfaces.trinidad.event.FocusEvent event)
The
FocusListener implementation that resets input component values under the process root. |
void |
processItemEvent(ItemEvent event)
The
ItemListener implementation that resets input component values under the process root. |
void |
processLaunch(org.apache.myfaces.trinidad.event.LaunchEvent event)
The
LaunchListener implementation that resets input component values under the process root. |
void |
processLaunch(LaunchPopupEvent event)
The
LaunchPopupListener implementation that resets input component values under the process root. |
void |
processPoll(org.apache.myfaces.trinidad.event.PollEvent event)
The
PollListener implementation that resets input component values under the process root. |
void |
processPopupCanceled(PopupCanceledEvent event)
The
PopupCanceledListener implementation that resets input component values under the process root. |
void |
processPopupFetch(PopupFetchEvent event)
The
PopupFetchListener implementation that resets input component values under the process root. |
void |
processQuery(QueryEvent event)
The
QueryListener implementation that resets input component values under the process root. |
void |
processQueryOperation(QueryOperationEvent event)
The
QueryOperationListener implementation that resets input component values under the process root. |
void |
processRangeChange(org.apache.myfaces.trinidad.event.RangeChangeEvent event)
The
RangeChangeListener implementation that resets input component values under the process root. |
void |
processRegionNavigation(RegionNavigationEvent event)
The
RegionNavigationListener implementation that resets input component values under the process root. |
void |
processReturn(org.apache.myfaces.trinidad.event.ReturnEvent event)
The
ReturnListener implementation that resets input component values under the process root. |
void |
processReturn(ReturnPopupEvent event)
The
ReturnPopupListener implementation that resets input component values under the process root. |
void |
processSelection(org.apache.myfaces.trinidad.event.SelectionEvent event)
The
SelectionListener implementation that resets input component values under the process root. |
void |
processSort(org.apache.myfaces.trinidad.event.SortEvent event)
The
SortListener implementation that resets input component values under the process root. |
void |
processSpringboardChange(SpringboardChangeEvent event)
The
SpringboardChangeListener implementation that resets input component values under the process root. |
void |
processValueChange(javax.faces.event.ValueChangeEvent event)
The
ValueChangeListener implementation that resets input component values under the process root. |
void |
restoreState(javax.faces.context.FacesContext context, Object object)
Restores the internal state into the faces bean.
|
Object |
saveState(javax.faces.context.FacesContext context)
Saves the listener's state with the component tree.
|
protected void |
setEventType(BasePolytypeListener.EventType eventType)
Sets the eventType to the state holder bean.
|
void |
setTransient(boolean isTransient)
Realization of
StateHolder . |
public BasePolytypeListener(BasePolytypeListener.EventType eventType)
BasePolytypeListener.EventType
that defines what associated event this particular instance handles.eventType
- framework concrete eventIllegalArgumentException
- eventType cannot be nullprotected abstract void handleEvent(javax.faces.event.FacesEvent event)
eventType
passed as a constructor argument matches the target event.event
- faces event corresponding to the BasePolytypeListener.EventType
passed via the constructorisAppropriate(javax.faces.event.FacesEvent)
protected BasePolytypeListener.EventType getEventType()
protected void setEventType(BasePolytypeListener.EventType eventType)
eventType
- that defines the target event the listener should act onpublic Object saveState(javax.faces.context.FacesContext context)
StateHolder
.saveState
in interface javax.faces.component.StateHolder
context
- faces contextpublic void restoreState(javax.faces.context.FacesContext context, Object object)
StateHolder
.restoreState
in interface javax.faces.component.StateHolder
context
- faces contextobject
- internal statepublic boolean isTransient()
StateHolder
.isTransient
in interface javax.faces.component.StateHolder
false
public void setTransient(boolean isTransient)
StateHolder
.setTransient
in interface javax.faces.component.StateHolder
isTransient
-UnsupportedOperationException
- noop implementationpublic final void processAction(javax.faces.event.ActionEvent event) throws javax.faces.event.AbortProcessingException
ActionListener
implementation that resets input component values under the process root.processAction
in interface javax.faces.event.ActionListener
event
- target action eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processDialog(DialogEvent event) throws javax.faces.event.AbortProcessingException
DialogListener
implementation that resets input component values under the process root.processDialog
in interface DialogListener
event
- target dialog eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processPopupCanceled(PopupCanceledEvent event) throws javax.faces.event.AbortProcessingException
PopupCanceledListener
implementation that resets input component values under the process root.processPopupCanceled
in interface PopupCanceledListener
event
- popup canceled eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processPopupFetch(PopupFetchEvent event) throws javax.faces.event.AbortProcessingException
PopupFetchListener
implementation that resets input component values under the process root.processPopupFetch
in interface PopupFetchListener
event
- popup fetch eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processCalendar(CalendarEvent event) throws javax.faces.event.AbortProcessingException
CalendarListener
implementation that resets input component values under the process root.processCalendar
in interface CalendarListener
event
- calendar eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processCalendarActivity(CalendarActivityEvent event) throws javax.faces.event.AbortProcessingException
CalendarActivityListener
implementation that resets input component values under the process root.processCalendarActivity
in interface CalendarActivityListener
event
- calendar activity eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processCalendarActivityDurationChange(CalendarActivityDurationChangeEvent event) throws javax.faces.event.AbortProcessingException
CalendarActivityDurationChangeListener
implementation that resets input component values under the process root.processCalendarActivityDurationChange
in interface CalendarActivityDurationChangeListener
event
- calendar activity duration change eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processCalendarDisplayChange(CalendarDisplayChangeEvent event) throws javax.faces.event.AbortProcessingException
CalendarDisplayChangeListener
implementation that resets input component values under the process root.processCalendarDisplayChange
in interface CalendarDisplayChangeListener
event
- calendar display change eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processCarouselSpin(CarouselSpinEvent event) throws javax.faces.event.AbortProcessingException
CarouselSpinListener
implementation that resets input component values under the process root.processCarouselSpin
in interface CarouselSpinListener
event
- carousel spin eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processContextInfo(ContextInfoEvent event) throws javax.faces.event.AbortProcessingException
ContextInfoListener
implementation that resets input component values under the process root.processContextInfo
in interface ContextInfoListener
event
- context info eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processDataReturn(ReturnPopupDataEvent event) throws javax.faces.event.AbortProcessingException
ReturnPopupDataListener
implementation that resets input component values under the process root.processDataReturn
in interface ReturnPopupDataListener
event
- LOV data return eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processDisclosure(org.apache.myfaces.trinidad.event.RowDisclosureEvent event) throws javax.faces.event.AbortProcessingException
RowDisclosureListener
implementation that resets input component values under the process root.processDisclosure
in interface org.apache.myfaces.trinidad.event.RowDisclosureListener
event
- row disclosure eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processDisclosure(org.apache.myfaces.trinidad.event.DisclosureEvent event) throws javax.faces.event.AbortProcessingException
DisclosureListener
implementation that resets input component values under the process root.processDisclosure
in interface org.apache.myfaces.trinidad.event.DisclosureListener
event
- disclosure eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processFocus(org.apache.myfaces.trinidad.event.FocusEvent event) throws javax.faces.event.AbortProcessingException
FocusListener
implementation that resets input component values under the process root.processFocus
in interface org.apache.myfaces.trinidad.event.FocusListener
event
- focus eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processItemEvent(ItemEvent event) throws javax.faces.event.AbortProcessingException
ItemListener
implementation that resets input component values under the process root.processItemEvent
in interface ItemListener
event
- item eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processLaunch(org.apache.myfaces.trinidad.event.LaunchEvent event) throws javax.faces.event.AbortProcessingException
LaunchListener
implementation that resets input component values under the process root.processLaunch
in interface org.apache.myfaces.trinidad.event.LaunchListener
event
- dialog framework launch eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processLaunch(LaunchPopupEvent event) throws javax.faces.event.AbortProcessingException
LaunchPopupListener
implementation that resets input component values under the process root.processLaunch
in interface LaunchPopupListener
event
- LOV popup launch eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processPoll(org.apache.myfaces.trinidad.event.PollEvent event) throws javax.faces.event.AbortProcessingException
PollListener
implementation that resets input component values under the process root.processPoll
in interface org.apache.myfaces.trinidad.event.PollListener
event
- poll eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processQuery(QueryEvent event) throws javax.faces.event.AbortProcessingException
QueryListener
implementation that resets input component values under the process root.processQuery
in interface QueryListener
event
- query eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processQueryOperation(QueryOperationEvent event) throws javax.faces.event.AbortProcessingException
QueryOperationListener
implementation that resets input component values under the process root.processQueryOperation
in interface QueryOperationListener
event
- query eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processRangeChange(org.apache.myfaces.trinidad.event.RangeChangeEvent event) throws javax.faces.event.AbortProcessingException
RangeChangeListener
implementation that resets input component values under the process root.processRangeChange
in interface org.apache.myfaces.trinidad.event.RangeChangeListener
event
- range change eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processRegionNavigation(RegionNavigationEvent event) throws javax.faces.event.AbortProcessingException
RegionNavigationListener
implementation that resets input component values under the process root.processRegionNavigation
in interface RegionNavigationListener
event
- region navigationjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processReturn(org.apache.myfaces.trinidad.event.ReturnEvent event) throws javax.faces.event.AbortProcessingException
ReturnListener
implementation that resets input component values under the process root.processReturn
in interface org.apache.myfaces.trinidad.event.ReturnListener
event
- dialog return eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processReturn(ReturnPopupEvent event) throws javax.faces.event.AbortProcessingException
ReturnPopupListener
implementation that resets input component values under the process root.processReturn
in interface ReturnPopupListener
event
- LOV popup return eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processSelection(org.apache.myfaces.trinidad.event.SelectionEvent event) throws javax.faces.event.AbortProcessingException
SelectionListener
implementation that resets input component values under the process root.processSelection
in interface org.apache.myfaces.trinidad.event.SelectionListener
event
- selection eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processSpringboardChange(SpringboardChangeEvent event) throws javax.faces.event.AbortProcessingException
SpringboardChangeListener
implementation that resets input component values under the process root.processSpringboardChange
in interface SpringboardChangeListener
event
- springboard change eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processSort(org.apache.myfaces.trinidad.event.SortEvent event) throws javax.faces.event.AbortProcessingException
SortListener
implementation that resets input component values under the process root.processSort
in interface org.apache.myfaces.trinidad.event.SortListener
event
- sort eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
public final void processValueChange(javax.faces.event.ValueChangeEvent event) throws javax.faces.event.AbortProcessingException
ValueChangeListener
implementation that resets input component values under the process root.processValueChange
in interface javax.faces.event.ValueChangeListener
event
- value change eventjavax.faces.event.AbortProcessingException
- exception during processing eventprocess(javax.faces.event.FacesEvent)
protected boolean isAppropriate(javax.faces.event.FacesEvent event)
isAppropriateListener
you might find on a concrete instance of FacesEvent
but this check is not if the listener implements an interface. This one listener can work with several event types. The BasePolytypeListener.EventType
enumeration passed to the constructor is associated with an event class. If the event
's class is the same as the event class established via the constructor, processing is invoked.event
- targettrue
if the event should be processed by the listenerprocess(javax.faces.event.FacesEvent)
protected void process(javax.faces.event.FacesEvent event)
eventType
then delecate to the handleEvent
method.event
- faces eventisAppropriate(javax.faces.event.FacesEvent)
, handleEvent(javax.faces.event.FacesEvent)
public static boolean addListener(BasePolytypeListener listener, javax.faces.component.UIComponent component)
true
value is returned. Otherwise; if the component does not support this event, false
is returned.listener
- concrete poly type listenercomponent
- to add the target listenertrue
if the listener was successfully addedIllegalArgumentException
- listener cannot be null; component cannot be nullprotected org.apache.myfaces.trinidad.bean.FacesBean getFacesBean()