javax.faces.event.FacesEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation

The public API classes of the Apache MyFaces CORE JSF-2.2 project

There is a newer version: 4.1.0

/*
 * Copyright 2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package javax.faces.event;

import java.util.EventObject;

import javax.faces.component.UIComponent;

/**
 * see Javadoc of JSF Specification
 *
 * @author Thomas Spiegl (latest modification by $Author: matzew $)
 * @version $Revision: 358099 $ $Date: 2005-12-20 20:40:00 +0000 (Tue, 20 Dec 2005) $
 */
public abstract class FacesEvent extends EventObject
{
	// FIELDS
    private PhaseId _phaseId;

	// CONSTRUCTORS
	public FacesEvent(UIComponent uiComponent)
	{
        super(uiComponent);
        if (uiComponent == null) throw new IllegalArgumentException("uiComponent");
        _phaseId = PhaseId.ANY_PHASE;
	}

	// METHODS
    public abstract boolean isAppropriateListener(FacesListener faceslistener);

    public abstract void processListener(FacesListener faceslistener);

	public UIComponent getComponent()
	{
        return (UIComponent)getSource();
	}

	public void queue()
	{
        ((UIComponent)getSource()).queueEvent(this);
	}

    public PhaseId getPhaseId()
    {
        return _phaseId;
    }

    public void setPhaseId(PhaseId phaseId)
    {
        _phaseId = phaseId;
    }
}