public class ResetListener extends BasePolytypeListener implements javax.faces.component.StateHolder
The resetListener declarative way to reset input component's submitted values. It is a generalized version of the resetActionListener and should be used in its place. Use the type attribute to select the event the listener should be activated on. All values submitted will be reset to null or empty, and all editable components will be updated with the current values of the model on the server. The reset will not alter any model state directly.
JSF validation is the third lifecycle phase and proceeds the apply request values phase. During the apply request values phase, input components set their submitted value as a property of the input component. The submitted value is kept by the component until after it has been validated. If validation fails, the JSF lifecycle is short-circuited to the render response phase. The submitted value is returned to the client along with associated faces messages.
This listener should be used primarily in situations that use partial page submits. There are times that the submitted values needs to be cleared. Another common use is with an af:popup. This listener be configured to reset the content of a popup by using the "popupFetch", "popupCanceled" or "dialog" event types. The listener will find the event's process root and traverse down through that subtree resetting input components. An event's process root defines an area of the page that an event should act on. Some of the more common components that are defined as process roots includes: form, subform, region, and popup.
BasePolytypeListener.EventType
Constructor and Description |
---|
ResetListener()
The no-args constructor default type is
BasePolytypeListener.EventType.ACTION . |
ResetListener(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 |
---|---|
protected void |
handleEvent(javax.faces.event.FacesEvent event)
The event is approprate for the originating
BasePolytypeListener.EventType . |
addListener, getEventType, getFacesBean, isAppropriate, isTransient, process, processAction, processCalendar, processCalendarActivity, processCalendarActivityDurationChange, processCalendarDisplayChange, processCarouselSpin, processContextInfo, processDataReturn, processDialog, processDisclosure, processDisclosure, processFocus, processItemEvent, processLaunch, processLaunch, processPoll, processPopupCanceled, processPopupFetch, processQuery, processQueryOperation, processRangeChange, processRegionNavigation, processReturn, processReturn, processSelection, processSort, processSpringboardChange, processValueChange, restoreState, saveState, setEventType, setTransient
public ResetListener()
BasePolytypeListener.EventType.ACTION
.public ResetListener(BasePolytypeListener.EventType eventType)
BasePolytypeListener.EventType
that defines what associated event this particular instance handles.eventType
- framework concrete eventprotected void handleEvent(javax.faces.event.FacesEvent event)
BasePolytypeListener.EventType
. Find the event source of the component and then locate the processing root for the event. Next, reset all editable values holders under the target event process root.handleEvent
in class BasePolytypeListener
event
- target faces event to handleBasePolytypeListener.isAppropriate(javax.faces.event.FacesEvent)