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 jboss-jsf-api_2.3_spec Show documentation

JSR-000372: JavaServer(TM) Faces 2.3 API

There is a newer version: 3.1.0.SP02

Show newest version

/*
 * 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.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);

}