javax.faces.render.RenderKitWrapper Maven / Gradle / Ivy
Show all versions of javax.faces-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 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.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 java.io.OutputStream;
import java.io.Writer;
import java.util.Iterator;
import javax.faces.FacesWrapper;
import javax.faces.context.ResponseStream;
import javax.faces.context.ResponseWriter;
/**
* Provides a simple implementation of
* {@link RenderKit} that
* can be subclassed by developers wishing to provide specialized
* behavior to an existing {@link RenderKit} instance. The default
* implementation of all methods is to call through to the wrapped
* {@link RenderKit}.
*
* Usage: extend this class and override {@link #getWrapped} to
* return the instance we are wrapping.
*
* Usage: extend this class and push the implementation being wrapped to the
* constructor and use {@link #getWrapped} to access the instance being wrapped.
*
* @since 2.0
*/
public abstract class RenderKitWrapper extends RenderKit implements FacesWrapper {
private RenderKit wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public RenderKitWrapper() {
}
/**
* If this render kit has been decorated,
* the implementation doing the decorating should push the implementation being wrapped to this constructor.
* The {@link #getWrapped()} will then return the implementation being wrapped.
*
* @param wrapped The implementation being wrapped.
* @since 2.3
*/
public RenderKitWrapper(RenderKit wrapped) {
this.wrapped = wrapped;
}
@Override
public RenderKit getWrapped() {
return wrapped;
}
/**
* The default behavior of this method is to
* call {@link RenderKit#addRenderer(String, String, Renderer)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#addRenderer(String, String, Renderer)
*/
@Override
public void addRenderer(String family, String rendererType, Renderer renderer) {
getWrapped().addRenderer(family, rendererType, renderer);
}
/**
* The default behavior of this method is to
* call {@link RenderKit#createResponseStream(java.io.OutputStream)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#createResponseStream(java.io.OutputStream)
*/
@Override
public ResponseStream createResponseStream(OutputStream out) {
return getWrapped().createResponseStream(out);
}
/**
* The default behavior of this method is to
* call {@link RenderKit#createResponseWriter(java.io.Writer, String, String)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#createResponseWriter(java.io.Writer, String, String)
*/
@Override
public ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding) {
return getWrapped().createResponseWriter(writer, contentTypeList, characterEncoding);
}
/**
* The default behavior of this method is to
* call {@link RenderKit#getRenderer(String, String)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#getRenderer(String, String)
*/
@Override
public Renderer getRenderer(String family, String rendererType) {
return getWrapped().getRenderer(family, rendererType);
}
/**
* The default behavior of this method is to
* call {@link javax.faces.render.RenderKit#getResponseStateManager()}
* on the wrapped {@link RenderKit} object.
*
* @see javax.faces.render.RenderKit#getResponseStateManager()
*/
@Override
public ResponseStateManager getResponseStateManager() {
return getWrapped().getResponseStateManager();
}
/**
* The default behavior of this method is to
* call {@link javax.faces.render.RenderKit#getComponentFamilies()}
* on the wrapped {@link RenderKit} object.
*
* @see javax.faces.render.RenderKit#getComponentFamilies()
*/
@Override
public Iterator getComponentFamilies() {
return getWrapped().getComponentFamilies();
}
/**
* The default behavior of this method is to
* call {@link RenderKit#getRendererTypes(String)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#getRendererTypes(String)
*/
@Override
public Iterator getRendererTypes(String componentFamily) {
return getWrapped().getRendererTypes(componentFamily);
}
/**
* The default behavior of this method is to
* call {@link RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer)
*/
@Override
public void addClientBehaviorRenderer(String type, ClientBehaviorRenderer renderer) {
getWrapped().addClientBehaviorRenderer(type, renderer);
}
/**
* The default behavior of this method is to
* call {@link RenderKit#getClientBehaviorRenderer(String)}
* on the wrapped {@link RenderKit} object.
*
* @see RenderKit#getClientBehaviorRenderer(String)
*/
@Override
public ClientBehaviorRenderer getClientBehaviorRenderer(String type) {
return getWrapped().getClientBehaviorRenderer(type);
}
/**
* The default behavior of this method is to
* call {@link javax.faces.render.RenderKit#getClientBehaviorRendererTypes()}
* on the wrapped {@link RenderKit} object.
*
* @see javax.faces.render.RenderKit#getClientBehaviorRendererTypes()
*/
@Override
public Iterator getClientBehaviorRendererTypes() {
return getWrapped().getClientBehaviorRendererTypes();
}
}