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

javax.faces.render.RenderKit 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.render;


import javax.faces.component.UIComponent;
import javax.faces.context.ResponseWriter;
import javax.faces.context.ResponseStream;
import java.io.Writer;
import java.io.OutputStream;
import java.util.Iterator;
import java.util.Collections;
import java.util.Set;


/**
 * 

RenderKit * represents a collection of {@link Renderer} instances that, together, * know how to render JavaServer Faces {@link UIComponent} instances for * a specific client. Typically, {@link RenderKit}s are specialized for * some combination of client device type, markup language, and/or user * Locale. A {@link RenderKit} also acts as a Factory for * associated {@link Renderer} instances, which perform the actual * rendering process for each component.

* *

A typical JavaServer Faces implementation will configure one or * more {@link RenderKit} instances at web application startup. They * are made available through calls to the getRenderKit() * methods of {@link RenderKitFactory}. Because {@link RenderKit} * instances are shared, they must be implemented in a thread-safe * manner. Due to limitations in the current specification having * multiple RenderKit instances at play in the same * application requires a custom {@link * javax.faces.application.ViewHandler} instance that is aware of how to * deal with this case. This limitation will be lifted in a future * version of the spec.

* *

The RenderKit instance must also vend a {@link * ResponseStateManager} instance, which is used in the process of * saving and restoring tree structure and state.

*/ public abstract class RenderKit { /** *

Register the specified {@link Renderer} instance, associated with the * specified component family and rendererType, * to the set of {@link Renderer}s registered with this {@link RenderKit}, * replacing any previously registered {@link Renderer} for this * combination of identifiers.

* * @param family Component family of the {@link Renderer} to register * @param rendererType Renderer type of the {@link Renderer} to register * @param renderer {@link Renderer} instance we are registering * * @throws NullPointerException if family or * rendererType or renderer is null */ public abstract void addRenderer(String family, String rendererType, Renderer renderer); /** *

Return the {@link Renderer} instance most recently registered for * the specified component family and * rendererType, if any; otherwise, return * null.

* * @param family Component family of the requested * {@link Renderer} instance * @param rendererType Renderer type of the requested * {@link Renderer} instance * * @throws NullPointerException if family or * rendererType is null */ public abstract Renderer getRenderer(String family, String rendererType); /** *

Return an instance of {@link ResponseStateManager} to handle * rendering technology specific state management decisions.

*/ public abstract ResponseStateManager getResponseStateManager(); /** *

Use the provided Writer to create a new {@link * ResponseWriter} instance for the specified (optional) content * type, and character encoding.

* *

Implementors are advised to consult the * getCharacterEncoding() method of class {@link * javax.servlet.ServletResponse} to get the required value for the * characterEncoding for this method. Since the Writer * for this response will already have been obtained (due to it * ultimately being passed to this method), we know that the * character encoding cannot change during the rendering of the * response.

* * @param writer the Writer around which this {@link ResponseWriter} * must be built. * * @param contentTypeList an "Accept header style" list of content * types for this response, or null if the RenderKit * should choose the best fit. As of the current version, the * values accepted by the Standard render-kit for this parameter * include any valid "Accept header style" String that includes the * String text/html, * application/xhtml+xml, application/xml * or text/xml. This may change in a future version. * The RenderKit must support a value for this argument that comes * straight from the Accept HTTP header, and therefore * requires parsing according to the specification of the * Accept header. Please see Section * 14.1 of RFC 2616 for the specification of the * Accept header. * * @param characterEncoding such as "ISO-8859-1" for this * ResponseWriter, or null if the * RenderKit should choose the best fit. Please see the * IANA for a list of character encodings. * * @return a new {@link ResponseWriter}. * * @throws IllegalArgumentException if no matching content type * can be found in contentTypeList, no appropriate * content type can be found with the implementation dependent best * fit algorithm, or no matching character encoding can be found for * the argument characterEncoding. * */ public abstract ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding); /** *

Use the provided OutputStream to create a new * {@link ResponseStream} instance.

* */ public abstract ResponseStream createResponseStream(OutputStream out); /** *

Return an Iterator over * the component-family entries supported by this * RenderKit instance.

* *

* The default implementation of this method returns an empty * Iterator *

* * @since 2.0 * */ public Iterator getComponentFamilies() { Set empty = Collections.emptySet(); return empty.iterator(); } /** *

Return an Iterator over * the renderer-type entries for the given component-family.

* *

If the specified componentFamily * is not known to this RenderKit implementation, return * an empty Iterator

* *

* The default implementation of this method returns an empty * Iterator *

* * @param componentFamily one of the members of the * Iterator returned by {@link #getComponentFamilies}. * * @since 2.0 */ public Iterator getRendererTypes(String componentFamily) { Set empty = Collections.emptySet(); return empty.iterator(); } /** *

Register the specified {@link ClientBehaviorRenderer} instance, * associated with the specified component type, * to the set of {@link ClientBehaviorRenderer}s registered with this * {@link RenderKit}, replacing any previously registered * {@link ClientBehaviorRenderer} for this type.

* * @param type type of the {@link ClientBehaviorRenderer} to register * @param renderer {@link ClientBehaviorRenderer} instance we are registering * * @throws NullPointerException if type or * renderer is null * * @since 2.0 */ public void addClientBehaviorRenderer(String type, ClientBehaviorRenderer renderer) { throw new UnsupportedOperationException("The default implementation must override this method"); } /** *

Return the {@link ClientBehaviorRenderer} instance most recently * registered for the specified type, if any; * otherwise, return null.

* * @param type type of the requested * {@link ClientBehaviorRenderer} instance * * @throws NullPointerException if type * is null * * @since 2.0 */ public ClientBehaviorRenderer getClientBehaviorRenderer(String type) { throw new UnsupportedOperationException("The default implementation must override this method"); } /** *

Return an Iterator over * the {@link ClientBehaviorRenderer} types.

* * @since 2.0 */ public Iterator getClientBehaviorRendererTypes() { throw new UnsupportedOperationException("The default implementation must override this method"); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy