Class ValueChangeEvent
- All Implemented Interfaces:
Serializable
public class ValueChangeEvent extends FacesEvent
A ValueChangeEvent
is a notification that the local value of the source component has been change as a result
of user interface activity. It is not fired unless validation of the new value was completed successfully.
- See Also:
- Serialized Form
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ValueChangeEvent(UIComponent component, Object oldValue, Object newValue)
Construct a new event object from the specified source component, old value, and new value.ValueChangeEvent(FacesContext facesContext, UIComponent component, Object oldValue, Object newValue)
Construct a new event object from the Faces context, specified source component, old value and new value. -
Method Summary
Modifier and Type Method Description Object
getNewValue()
Return the current local value of the sourceUIComponent
.Object
getOldValue()
Return the previous local value of the sourceUIComponent
.boolean
isAppropriateListener(FacesListener listener)
Returntrue
if thisFacesListener
is an instance of a listener class that this event supports.void
processListener(FacesListener listener)
Broadcast thisFacesEvent
to the specifiedFacesListener
, by whatever mechanism is appropriate.Methods inherited from class jakarta.faces.event.FacesEvent
getComponent, getFacesContext, getPhaseId, queue, setPhaseId
-
Constructor Details
-
ValueChangeEvent
Construct a new event object from the specified source component, old value, and new value.
The default
PhaseId
for this event isPhaseId.ANY_PHASE
.- Parameters:
component
- SourceUIComponent
for this eventoldValue
- The previous local value of thisUIComponent
newValue
- The new local value of thieUIComponent
- Throws:
IllegalArgumentException
- ifcomponent
isnull
-
ValueChangeEvent
public ValueChangeEvent(FacesContext facesContext, UIComponent component, Object oldValue, Object newValue)Construct a new event object from the Faces context, specified source component, old value and new value.
The default
PhaseId
for this event isPhaseId.ANY_PHASE
.- Parameters:
facesContext
- the Faces context.component
- SourceUIComponent
for this eventoldValue
- The previous local value of thisUIComponent
newValue
- The new local value of thieUIComponent
- Throws:
IllegalArgumentException
- ifcomponent
isnull
-
-
Method Details
-
getOldValue
Return the previous local value of the source
UIComponent
.- Returns:
- the previous local value
-
getNewValue
Return the current local value of the source
UIComponent
.- Returns:
- the current local value
-
isAppropriateListener
Description copied from class:FacesEvent
Return
true
if thisFacesListener
is an instance of a listener class that this event supports. Typically, this will be accomplished by an "instanceof" check on the listener class.- Specified by:
isAppropriateListener
in classFacesEvent
- Parameters:
listener
-FacesListener
to evaluate- Returns:
- true if it is the appropriate instance, false otherwise.
-
processListener
Description copied from class:FacesEvent
Broadcast this
FacesEvent
to the specifiedFacesListener
, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing thisFacesEvent
as a paramter.- Specified by:
processListener
in classFacesEvent
- Parameters:
listener
-FacesListener
to send thisFacesEvent
to- Throws:
AbortProcessingException
- Signal the Jakarta Server Faces implementation that no further processing on the current event should be performed
-