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

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

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 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.Collections;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.render.ClientBehaviorRenderer;
import javax.faces.render.RenderKit;

/**
 * 

ClientBehaviorBase is a * convenience base class that implements the default concrete behavior * of all methods defined by {@link ClientBehavior}.

* *
* *

Subclasses should either override getRendererType() to identify * the {@link ClientBehaviorRenderer} to delegate to, or they should override * getScript() to locally generate the desired Behavior * script, and decode(). *

* *
* * @since 2.0 */ public class ClientBehaviorBase extends BehaviorBase implements ClientBehavior { private static final Logger logger = Logger.getLogger("javax.faces.component.behavior", "javax.faces.LogStrings"); /** *

Default implementation of of {@link * ClientBehavior#getScript}. If a {@link ClientBehaviorRenderer} * is available for the specified behavior renderer type, this * method delegates to the {@link ClientBehaviorRenderer#getScript} * method. Otherwise, this method returns null.

* * @param behaviorContext the {@link ClientBehaviorContext} * * @return the script provided by the associated * ClientBehaviorRenderer, or null if no ClientBehaviorRenderer is * available. * * @throws NullPointerException if behaviorContext is * null * * @since 2.0 */ public String getScript(ClientBehaviorContext behaviorContext) { if (null == behaviorContext) { throw new NullPointerException(); } ClientBehaviorRenderer renderer = getRenderer(behaviorContext.getFacesContext()); String script = null; if (null != renderer){ script = renderer.getScript(behaviorContext, this); } return script; } /** *

Default implementation of of {@link * ClientBehavior#decode}. If a {@link ClientBehaviorRenderer} is * available for the specified behavior renderer type, this method * delegates to the ClientBehaviorRenderer's decode() method. * Otherwise, no decoding is performed.

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

Returns the renderer type of the * {@link ClientBehaviorRenderer} to use for the behavior. The default * implementation returns null. Subclasses should either override this * method to return a string that identifies the type of * {@link ClientBehaviorRenderer} to use, or should override * {@link #getScript} and perform script rendering locally in the * {@link ClientBehavior} implementation. *

* @return the default renderer type, which is null. * * @since 2.0 */ public String getRendererType() { return null; } /** *

Default implementation of * {@link ClientBehavior#getHints()}. * By default, no hints are specified, and this method returns an empty, * umodifiable set.

* * @return an empty, unmodifiable set of {@link ClientBehaviorHint}s. * * @since 2.0 */ public Set getHints() { return Collections.emptySet(); } /** *

Convenience method to return the * {@link ClientBehaviorRenderer} instance associated with this * {@link ClientBehavior}, if any; otherwise, return * null.

* @param context {@link FacesContext} for the request we are processing * @return {@link ClientBehaviorRenderer} instance from the current {@link RenderKit} or null. * * @throws NullPointerException if context is null. * * @since 2.0 */ protected ClientBehaviorRenderer getRenderer(FacesContext context) { if (null == context){ throw new NullPointerException(); } ClientBehaviorRenderer renderer = null; String rendererType = getRendererType(); if (null != rendererType){ RenderKit renderKit = context.getRenderKit(); if (null != renderKit){ renderer = renderKit.getClientBehaviorRenderer(rendererType); } if (null == renderer){ if (logger.isLoggable(Level.FINE)){ logger.fine("Can't get behavior renderer for type " + rendererType); } } } else { if(logger.isLoggable(Level.FINE)){ logger.fine("No renderer-type for behavior " + this.getClass().getName()); } } return renderer; } }