jakarta.faces.event.PreRemoveFromViewEvent Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.faces.event;

import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;

/**
 *
 * 
 * When an instance of this event is passed to {@link SystemEventListener#processEvent} or
 * {@link ComponentSystemEventListener#processEvent}, the listener implementation may assume that the
 * source of this event instance is a {@link UIComponent} instance that is about to be removed from the
 * view. Therefore, the implementation may assume it is safe to call {@link UIComponent#getParent},
 * {@link UIComponent#getClientId}, and other methods that depend upon the component instance being added into the view.
 * 
 *
 * @since 2.0
 */
public class PreRemoveFromViewEvent extends ComponentSystemEvent {

    // ------------------------------------------------------------ Constructors

    private static final long serialVersionUID = 1715650557625760365L;

    /**
     * 
     * Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be
     * removed from the view.
     * 
     *
     * @param component the UIComponent that is about to be removed from the view.
     *
     * @throws IllegalArgumentException if component is null
     */
    public PreRemoveFromViewEvent(UIComponent component) {

        super(component);

    }

    /**
     * 
     * Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be
     * removed from the view.
     * 
     *
     * @param facesContext the Faces context.
     * @param component the UIComponent that is about to be removed from the view.
     * @throws IllegalArgumentException if component is null
     */
    public PreRemoveFromViewEvent(FacesContext facesContext, UIComponent component) {
        super(facesContext, component);
    }

    // --------------------------------------- Methods from ComponentSystemEvent

    /**
     * 
     * Returns true if and only if the argument listener is an instance of
     * {@link SystemEventListener}.
     * 
     *
     * @param listener the faces listener.
     * @return true if the listener is an appropriate one, false otherwise.
     */
    @Override
    public boolean isAppropriateListener(FacesListener listener) {

        return listener instanceof SystemEventListener;

    }

}