/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2015 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.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;
import javax.faces.context.FacesContext;
/**
*
* <p class="changed_added_2_0"><span
* class="changed_modified_2_2">When</span> an instance of this event is
* passed to {@link SystemEventListener#processEvent} or {@link
* ComponentSystemEventListener#processEvent}, the listener
* implementation may assume that the <code>source</code> 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.</p>
*
* <div class="changed_added_2_0 changed_deleted_2_2">
*
* <p>The implementation must guarantee that {@link
* javax.faces.application.Application#publishEvent} is called,
* immediately after any <code>UIComponent</code> instance is added to
* the view hierarchy <strong>except</strong> in the case where {@link
* javax.faces.render.ResponseStateManager#isPostback} returns
* <code>true</code> <strong>at the same time as</strong> {@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.</p>
*
* </div>
* <div class="changed_added_2_2">
* <p>The implementation must guarantee that {@link
* javax.faces.application.Application#publishEvent} is called in the
* following cases.</p>
* <ul>
<li><p>Upon the initial construction of the view, when each
instance is added to the view.</p></li>
<li><p>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
<code>c:if</code>, <code>ui:include</code>, and other tags
that dynamically influence the assembly of the view.</p></li>
<li><p>If a component is programmatically added to the view
using the Java API directly. For example, user code manually
adds children using <code>comp.getChildren().add()</code>,
where <code>comp</code> is a <code>UIComponent</code>.
</p></li>
</ul>
* </div>
*
* @since 2.0
*/
public class PostAddToViewEvent extends ComponentSystemEvent {
private static final long serialVersionUID = -1113592223476173895L;
// ------------------------------------------------------------ Constructors
/**
* <p class="changed_added_2_0">Instantiate a new
* <code>PostAddToViewEvent</code> that indicates the argument
* <code>component</code> was just added to the view.</p>
* @param component the <code>UIComponent</code> that has just been
* added to the view.
*
* @throws IllegalArgumentException if the argument is <code>null</code>.
*/
public PostAddToViewEvent(UIComponent component) {
super(component);
}
/**
* <p class="changed_added_2_3">Instantiate a new
* <code>PostAddToViewEvent</code> that indicates the argument
* <code>component</code> was just added to the view.</p>
*
* @param facesContext the Faces context.
* @param component the <code>UIComponent</code> that has just been
* added to the view.
* @throws IllegalArgumentException if the argument is <code>null</code>.
*/
public PostAddToViewEvent(FacesContext facesContext, UIComponent component) {
super(facesContext, component);
}
// --------------------------------------- Methods from ComponentSystemEvent
/**
* <p class="changed_added_2_0">Returns <code>true</code> if and
* only if the argument <code>listener</code> is an instance of
* {@link SystemEventListener}.</p>
*
* @param listener the faces listener.
* @return true if it is an appropriate listener, false otherwise.
*/
@Override
public boolean isAppropriateListener(FacesListener listener) {
return (listener instanceof SystemEventListener);
}
}