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

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

There is a newer version: 3.1.0.SP02
Show newest version
/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

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(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy