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

javax.faces.render.ClientBehaviorRenderer Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.3 Specification.

There is a newer version: 2.3-pfd
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.render;


import javax.faces.component.UIComponent;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorContext;
import javax.faces.context.FacesContext;


/**
 * 

A ClientBehaviorRenderer produces * the client-side script that implements a {@link ClientBehavior}'s client-side * logic. It can also enqueue server-side {@link javax.faces.event.BehaviorEvent}s that may be * processed later by event listeners that have registered an interest.

* *

Individual {@link ClientBehaviorRenderer} instances will be instantiated as * requested during the rendering process, and will remain in existence for the * remainder of the lifetime of a web application. Because each instance * may be invoked from more than one request processing thread simultaneously, * they MUST be programmed in a thread-safe manner.

* * @since 2.0 */ public abstract class ClientBehaviorRenderer { // ------------------------------------------------------ Rendering Methods /** *

Return the script that implements this * ClientBehavior's client-side logic. The default implementation returns * null.

* *

ClientBehaviorRenderer.getScript() implementations are allowed to return * null to indicate that no script is required for this particular * getScript() call. For example, a ClientBehaviorRenderer implementation may * return null if the associated ClientBehavior 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(). ClientBehaviorRenderer * implementations must not hold onto references to ClientBehaviorContexts. * * @param behavior the ClientBehavior instance that generates script. * * @return script that provides the client-side behavior, or null * if no script is required. * * @since 2.0 * */ public String getScript(ClientBehaviorContext behaviorContext, ClientBehavior behavior) { return null; } /** *

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().

* * @param context {@link FacesContext} for the request we are processing * @param component {@link UIComponent} the component associated with this * {@link javax.faces.component.behavior.Behavior} * @param behavior {@link ClientBehavior} the behavior instance * * @throws NullPointerException if context, * component behavior is null * * @since 2.0 */ public void decode(FacesContext context, UIComponent component, ClientBehavior behavior) { if (null == context || null == component || behavior == null) { throw new NullPointerException(); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy