jakarta.faces.lifecycle.ClientWindowWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
The newest version!
/*
 * Copyright (c) 1997, 2020 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 jakarta.faces.lifecycle;

import java.util.Map;

import jakarta.faces.FacesWrapper;
import jakarta.faces.context.FacesContext;

/**
 * 
 * Wrapper for {@link ClientWindow}
 * 
 *
 * 
 * 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.2
 */
public abstract class ClientWindowWrapper extends ClientWindow implements FacesWrapper {

    private ClientWindow wrapped;

    /**
     * @deprecated Use the other constructor taking the implementation being wrapped.
     */
    @Deprecated
    public ClientWindowWrapper() {

    }

    /**
     * 
     * If this client window 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 ClientWindowWrapper(ClientWindow wrapped) {
        this.wrapped = wrapped;
    }

    @Override
    public ClientWindow getWrapped() {
        return wrapped;
    }

    @Override
    public String getId() {
        return getWrapped().getId();
    }

    @Override
    public Map getQueryURLParameters(FacesContext context) {
        return getWrapped().getQueryURLParameters(context);
    }

    @Override
    public void disableClientWindowRenderMode(FacesContext context) {
        getWrapped().disableClientWindowRenderMode(context);
    }

    @Override
    public void enableClientWindowRenderMode(FacesContext context) {
        getWrapped().enableClientWindowRenderMode(context);
    }

    @Override
    public boolean isClientWindowRenderModeEnabled(FacesContext context) {
        return getWrapped().isClientWindowRenderModeEnabled(context);
    }

    @Override
    public void decode(FacesContext context) {
        getWrapped().decode(context);
    }

}