javax.faces.event.PreRenderComponentEvent 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
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
/*
* Copyright (c) 1997, 2018 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 javax.faces.event;
import javax.faces.component.UIComponent;
import javax.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 UIComponent} instance that is about to be
* rendered and that it is safe to call {@link
* UIComponent#getParent}, {@link UIComponent#getClientId}, and other
* methods that depend upon the component instance being in the
* view.
*
* @since 2.0
*/
public class PreRenderComponentEvent extends ComponentSystemEvent {
// ------------------------------------------------------------ Constructors
private static final long serialVersionUID = -938817831518520795L;
/**
* Instantiate a new
* PreRenderComponentEvent
that indicates the argument
* component
is about to be rendered.
* @param component the UIComponent
that is about to be
* rendered.
* @throws IllegalArgumentException if the argument is null
.
*/
public PreRenderComponentEvent(UIComponent component) {
super(component);
}
/**
* Instantiate a new
* PreRenderComponentEvent
that indicates the argument
* component
is about to be rendered.
*
* @param facesContext the Faces context.
* @param component the UIComponent
that is about to be
* rendered.
* @throws IllegalArgumentException if the argument is null
.
*/
public PreRenderComponentEvent(FacesContext facesContext, UIComponent component) {
super(facesContext, component);
}
}