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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation
The public API classes of the Apache MyFaces CORE JSF-2.1 project
There is a newer version: 4.1.0-RC3
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package jakarta.faces.render;

import jakarta.faces.FacesWrapper;
import jakarta.faces.context.ResponseStream;
import jakarta.faces.context.ResponseWriter;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Iterator;

/**
 * 
 *   Provides a simple implementation of RenderKit that can be subclassed by developers wishing 
 *   to provide specialized behavior to an existing RenderKit instance. The default implementation
 *   of all methods is to call through to the wrapped RenderKit.
 * 
 * 
 *   Usage: extend this class and override getWrapped() to return the  wrapped instance.
 * 
 *
 * @since 2.0
 */
public abstract class RenderKitWrapper extends RenderKit implements FacesWrapper
{
    private RenderKit delegate;

    @Deprecated
    public RenderKitWrapper()
    {
    }

    public RenderKitWrapper(RenderKit delegate)
    {
        this.delegate = delegate;
    }
    
    @Override
    public void addClientBehaviorRenderer(String type, ClientBehaviorRenderer renderer)
    {
        getWrapped().addClientBehaviorRenderer(type,renderer);
    }
    
    /** {@inheritDoc} */
    @Override
    public void addRenderer(String family, String rendererType, Renderer renderer)
    {
        getWrapped().addRenderer(family, rendererType, renderer);
    }

    /** {@inheritDoc} */
    @Override
    public ResponseStream createResponseStream(OutputStream out)
    {
        return getWrapped().createResponseStream(out);
    }

    /** {@inheritDoc} */
    @Override
    public ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding)
    {
        return getWrapped().createResponseWriter(writer, contentTypeList, characterEncoding);
    }

    @Override
    public ClientBehaviorRenderer getClientBehaviorRenderer(String type)
    {
        return getWrapped().getClientBehaviorRenderer(type);
    }
    
    @Override
    public Iterator getClientBehaviorRendererTypes()
    {
        return getWrapped().getClientBehaviorRendererTypes();
    }
    
    /** {@inheritDoc} */
    @Override
    public Renderer getRenderer(String family, String rendererType)
    {
        return getWrapped().getRenderer(family, rendererType);
    }

    /** {@inheritDoc} */
    @Override
    public ResponseStateManager getResponseStateManager()
    {
        return getWrapped().getResponseStateManager();
    }

    /** {@inheritDoc} */
    @Override
    public RenderKit getWrapped()
    {
        return delegate;
    }

    /** {@inheritDoc} */
    @Override
    public Iterator getComponentFamilies()
    {
        return getWrapped().getComponentFamilies();
    }

    /** {@inheritDoc} */
    @Override
    public Iterator getRendererTypes(String componentFamily)
    {
        return getWrapped().getRendererTypes(componentFamily);
    }
}