All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.component.behavior.ClientBehavior Maven / Gradle / Ivy

Go to download

This is the master POM file for Sun's Implementation of the JSF 2.1 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * 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.component.behavior;

import java.util.Set;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;

/**
 * 

ClientBehavior is the * base contract for {@link Behavior}s that attach script content to * client-side events exposed by {@link ClientBehaviorHolder} * components. Instances of ClientBehavior may be attached * to components that implement the {@link ClientBehaviorHolder} * contract by calling {@link ClientBehaviorHolder#addClientBehavior}. * Once a ClientBehavior has been attached to a {@link * ClientBehaviorHolder} component, the component calls {@link * #getScript} to obtain the behavior's script and the component wires * this up to the appropriate client-side event handler. Note that the * script content returned by this method is always in-line script * content. If the implementing class wants to invoke functions defined * in other script resources, the implementing class must use the * {@link javax.faces.application.ResourceDependency} or {@link * javax.faces.application.ResourceDependencies} annotation.

* * @since 2.0 */ public interface ClientBehavior extends Behavior { /** *

Return the script that implements this * ClientBehavior's client-side logic.

* *
* *

ClientBehavior.getScript() implementations are allowed to return * null to indicate that no script is required for this particular * getScript() call. For example, a ClientBehavior implementation may * return null if the Behavior is disabled. *

* *
* * @param behaviorContext the {@link ClientBehaviorContext} that provides * properties that might influence this getScript() call. Note that * ClientBehaviorContext instances are short-lived objects that are only * valid for the duration of the call to getScript(). ClientBehavior * implementations must not hold onto references to ClientBehaviorContexts. * * @return script that provides the client-side behavior, or null * if no script is required. * @throws NullPointerException if behaviorContext is * null * * @since 2.0 */ public String getScript(ClientBehaviorContext behaviorContext); /** *

Decode any new state of this * {@link ClientBehavior} from the * request contained in the specified {@link FacesContext}.

* *
* *

During decoding, events may be enqueued for later processing * (by event listeners who have registered an interest), by calling * queueEvent(). Default implementation delegates decoding * to {@link javax.faces.render.ClientBehaviorRenderer#decode(FacesContext, UIComponent, ClientBehavior)}

* *
* * @param context {@link FacesContext} for the request we are processing * @param component {@link UIComponent} the component associated with this {@link Behavior} * * @throws NullPointerException if context or * component is null. * * @since 2.0 */ public void decode(FacesContext context, UIComponent component); /** *

Returns hints that describe the * behavior of the ClientBehavior implementation. The hints may * impact how Renderers behave in the presence of Behaviors. For * example, when a Behavior that specifies * ClientBehaviorHint.SUBMITTING is present, the * Renderer may choose to alternate the scripts that it generates * itself.

* * @return a non-null, unmodifiable collection of ClientBehaviorHints. * * @since 2.0 */ public Set getHints(); }