javax.faces.event.FacesEvent Maven / Gradle / Ivy
/*
* $Id: FacesEvent.java,v 1.13 2006/09/01 01:22:20 tony_robertson Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.event;
import java.util.EventObject;
import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
/**
* FacesEvent is the base class for user interface and
* application events that can be fired by {@link UIComponent}s. Concrete
* event classes must subclass {@link FacesEvent} in order to be supported
* by the request processing lifecycle.
*/
public abstract class FacesEvent extends EventObject {
// ------------------------------------------------------------ Constructors
/**
* Construct a new event object from the specified source component.
*
* @param component Source {@link UIComponent} for this event
*
* @throws IllegalArgumentException if component is
* null
*/
public FacesEvent(UIComponent component) {
super(component);
}
// -------------------------------------------------------------- Properties
/**
* Return the source {@link UIComponent} that sent this event.
*/
public UIComponent getComponent() {
return ((UIComponent) getSource());
}
private PhaseId phaseId = PhaseId.ANY_PHASE;
/**
*
Return the identifier of the request processing phase during
* which this event should be delivered. Legal values are the
* singleton instances defined by the {@link PhaseId} class,
* including PhaseId.ANY_PHASE, which is the default
* value.
*/
public PhaseId getPhaseId() {
return phaseId;
}
/**
* Set the {@link PhaseId} during which this event will be
* delivered.
*
* @throws IllegalArgumentException phaseId is null.
*
*/
public void setPhaseId(PhaseId phaseId) {
if (null == phaseId) {
throw new IllegalArgumentException();
}
this.phaseId = phaseId;
}
// ------------------------------------------------- Event Broadcast Methods
/**
* Convenience method to queue this event for broadcast at the end
* of the current request processing lifecycle phase.
*
* @throws IllegalStateException if the source component for this
* event is not a descendant of a {@link UIViewRoot}
*/
public void queue() {
getComponent().queueEvent(this);
}
/**
* Return true if this {@link FacesListener} is an instance
* of a listener class that this event supports. Typically, this will be
* accomplished by an "instanceof" check on the listener class.
*
* @param listener {@link FacesListener} to evaluate
*/
public abstract boolean isAppropriateListener(FacesListener listener);
/**
* Broadcast this {@link FacesEvent} to the specified
* {@link FacesListener}, by whatever mechanism is appropriate. Typically,
* this will be accomplished by calling an event processing method, and
* passing this {@link FacesEvent} as a paramter.
*
* @param listener {@link FacesListener} to send this {@link FacesEvent} to
*
* @throws AbortProcessingException Signal the JavaServer Faces
* implementation that no further processing on the current event
* should be performed
*/
public abstract void processListener(FacesListener listener);
}