jakarta.faces.event.PreRenderViewEvent 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.UIViewRoot;
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 the {@link UIViewRoot} instance that is about to be rendered.
 * 
 *
 * 
 *
 * 
 * It is valid for a listener for this event to change the {@link UIViewRoot} in the current
 * {@link jakarta.faces.context.FacesContext}, but the listener must ensure that the new UIViewRoot was
 * created with a call to {@link jakarta.faces.application.ViewHandler#createView}, and that the view is fully populated
 * with the children to be traversed during render. The listener implementation may call
 * {@link jakarta.faces.view.ViewDeclarationLanguage#buildView} to populate the UIViewRoot.
 * 
 *
 * 
 *
 * @since 2.0
 */
public class PreRenderViewEvent extends ComponentSystemEvent {

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

    private static final long serialVersionUID = -781238104491250220L;

    /**
     *
     * 
     * Instantiate a new PreRenderViewEvent that indicates the argument root is about to be
     * rendered.
     * 
     *
     * @param root the UIViewRoot that is about to be rendered.
     *
     * @throws IllegalArgumentException if the argument is null.
     */
    public PreRenderViewEvent(UIViewRoot root) {
        super(root);
    }

    /**
     * 
     * Instantiate a new PreRenderViewEvent that indicates the argument root is about to be
     * rendered.
     * 
     *
     * @param facesContext the Faces context.
     * @param root the UIViewRoot that is about to be rendered.
     * @throws IllegalArgumentException if the argument is null.
     */
    public PreRenderViewEvent(FacesContext facesContext, UIViewRoot root) {
        super(facesContext, root);
    }
}