javax.faces.component.ContextCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf-api Show documentation
This is the master POM file for Sun's Implementation of the JSF 2.1 Specification.
There is a newer version: 2.2.20
/*
 * ComponentCallback.java
 *
 * Created on February 9, 2006, 12:58 PM
 * $Id: ContextCallback.java,v 1.4 2007/04/27 22:00:03 ofung Exp $
 */

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. 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.html
 * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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.component;

import javax.faces.context.FacesContext;

/**
 *
 * A simple callback interace that enables taking action on a
 * specific UIComponent (either facet or child) in the view while
 * preserving any contextual state for that component instance in the
 * view.
 *
 */
public interface ContextCallback {
    
    /**
     * This method will be called by an implementation of {@link
     * UIComponent#invokeOnComponent} and must be passed the component
     * with the clientId given as an argument to
     * invokeOnComponent.  At the point in time when this
     * method is called, the argument target is guaranteed
     * to be in the proper state with respect to its ancestors in the
     * View.
     *
     * @param context the FacesContext for this request.
     *
     * @param target the {@link UIComponent} that was located by
     * clientId by a call to {@link
     * UIComponent#invokeOnComponent}.
     */
    
    public void invokeContextCallback(FacesContext context, 
				      UIComponent target);
    
}