javax.faces.event.PostAddToViewEvent Maven / Gradle / Ivy
Show all versions of jsf-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.event;
import javax.faces.component.UIComponent;
/**
*
* 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 and that either that
* instance or an ancestor of that instance was just added to 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.
*
*
*
* The implementation must guarantee that {@link
* javax.faces.application.Application#publishEvent} is called,
* immediately after any UIComponent instance is added to
* the view hierarchy except in the case where {@link
* javax.faces.render.ResponseStateManager#isPostback} returns
* true at the same time as {@link
* javax.faces.context.FacesContext#getCurrentPhaseId} returns {@link
* javax.faces.event.PhaseId#RESTORE_VIEW}. When both of those
* conditions are met, {@link
* javax.faces.application.Application#publishEvent} must not be called.
*
*
*
* The implementation must guarantee that {@link
* javax.faces.application.Application#publishEvent} is called in the
* following cases.
*
Upon the initial construction of the view, when each
instance is added to the view.
On a non-initial rendering of the view, if a component
is added to the view by the View Declaration Language
implememtation as a result of changes in evaluation result of
EL expressions referenced by VDL tags such as
c:if, ui:include, and other tags
that dynamically influence the assembly of the view.
If a component is programmatically added to the view
using the Java API directly. For example, user code manually
adds children using comp.getChildren().add(),
where comp is a UIComponent.
*
*
* @since 2.0
*/
public class PostAddToViewEvent extends ComponentSystemEvent {
private static final long serialVersionUID = -1113592223476173895L;
// ------------------------------------------------------------ Constructors
/**
* Instantiate a new
* PostAddToViewEvent that indicates the argument
* component was just added to the view.
* @param component the UIComponent that has just been
* added to the view.
*
* @throws IllegalArgumentException if the argument is null.
*/
public PostAddToViewEvent(UIComponent component) {
super(component);
}
// --------------------------------------- Methods from ComponentSystemEvent
/**
* Returns true if and
* only if the argument listener is an instance of
* {@link SystemEventListener}.
* @param listener
*/
@Override
public boolean isAppropriateListener(FacesListener listener) {
return (listener instanceof SystemEventListener);
}
}