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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

The newest version!

/*
 * 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 in a tree that has just had its state restored.
 * 
 *
 * @since 2.0
 */
public class PostRestoreStateEvent extends ComponentSystemEvent {

    static final long serialVersionUID = -1007196479122154347L;

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

    /**
     *
     * 
     * Instantiate a new PostRestoreStateEvent that indicates the argument component just had its
     * state restored.
     * 
     *
     * @param component the UIComponent whose state was just restored.
     *
     * @throws IllegalArgumentException if the argument is null.
     */
    public PostRestoreStateEvent(UIComponent component) {
        super(component);
    }

    /**
     * 
     * Instantiate a new PostRestoreStateEvent that indicates the argument component just had its
     * state restored.
     * 
     *
     * @param facesContext the Faces context.
     * @param component the UIComponent whose state was just restored.
     *
     * @throws IllegalArgumentException if the argument is null.
     */
    public PostRestoreStateEvent(FacesContext facesContext, UIComponent component) {
        super(facesContext, component);
    }

    public void setComponent(UIComponent newComponent) {
        source = newComponent;
    }

}