Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * 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
  * 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;

ClientBehavior is the base contract for Behaviors that attach script content to client-side events exposed by ClientBehaviorHolder components. Instances of ClientBehavior may be attached to components that implement the ClientBehaviorHolder contract by calling ClientBehaviorHolder.addClientBehavior(java.lang.String,javax.faces.component.behavior.ClientBehavior). Once a ClientBehavior has been attached to a ClientBehaviorHolder component, the component calls getScript(javax.faces.component.behavior.ClientBehaviorContext) 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 javax.faces.application.ResourceDependency or javax.faces.application.ResourceDependencies annotation.

 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.

behaviorContext the 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.
script that provides the client-side behavior, or null if no script is required.
java.lang.NullPointerException if behaviorContext is null
     public String getScript(ClientBehaviorContext behaviorContext);


Decode any new state of this ClientBehavior from the request contained in the specified javax.faces.context.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 javax.faces.render.ClientBehaviorRenderer.decode(javax.faces.context.FacesContext,javax.faces.component.UIComponent,javax.faces.component.behavior.ClientBehavior)

context javax.faces.context.FacesContext for the request we are processing
component javax.faces.component.UIComponent the component associated with this Behavior
java.lang.NullPointerException if context or component is null.
    public void decode(FacesContext contextUIComponent 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.

a non-null, unmodifiable collection of ClientBehaviorHints.
    public Set<ClientBehaviorHintgetHints();
New to GrepCode? Check out our FAQ X