javax.faces.application.ViewHandlerWrapper 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-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.application;
import java.util.List;
import java.util.Set;
import javax.faces.context.FacesContext;
import javax.faces.component.UIViewRoot;
import javax.faces.FacesException;
import java.util.Locale;
import java.util.Map;
import java.io.IOException;
import javax.faces.FacesWrapper;
import javax.faces.view.ViewDeclarationLanguage;
/**
* Provides a simple implementation of {@link ViewHandler} that can
* be subclassed by developers wishing to provide specialized behavior
* to an existing {@link ViewHandler} instance. The default
* implementation of all methods is to call through to the wrapped
* {@link ViewHandler}.
*
* Usage: extend this class and override {@link #getWrapped} to
* return the instance we are wrapping.
*
* @since 1.2
*/
public abstract class ViewHandlerWrapper extends ViewHandler implements FacesWrapper {
/**
* @return the instance that we are wrapping.
*/
@Override
public abstract ViewHandler getWrapped();
// ------------------------ Methods from javax.faces.application.ViewHandler
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#calculateCharacterEncoding(javax.faces.context.FacesContext)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#calculateCharacterEncoding(javax.faces.context.FacesContext)
* @since 1.2
*/
@Override
public String calculateCharacterEncoding(FacesContext context) {
return getWrapped().calculateCharacterEncoding(context);
}
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#calculateLocale(javax.faces.context.FacesContext)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#calculateLocale(javax.faces.context.FacesContext)
* @since 1.2
*/
@Override
public Locale calculateLocale(FacesContext context) {
return getWrapped().calculateLocale(context);
}
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#deriveViewId(javax.faces.context.FacesContext, String)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#deriveViewId(javax.faces.context.FacesContext, String)
* @since 2.0
*/
@Override
public String deriveViewId(FacesContext context, String input) {
return getWrapped().deriveViewId(context, input);
}
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#deriveLogicalViewId(javax.faces.context.FacesContext, String)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#deriveLogicalViewId(javax.faces.context.FacesContext, String)
* @since 2.1
*/
@Override
public String deriveLogicalViewId(FacesContext context, String input) {
return getWrapped().deriveLogicalViewId(context, input);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#calculateRenderKitId(javax.faces.context.FacesContext)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#calculateRenderKitId(javax.faces.context.FacesContext)
* @since 1.2
*/
@Override
public String calculateRenderKitId(FacesContext context) {
return getWrapped().calculateRenderKitId(context);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#createView(javax.faces.context.FacesContext, String)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#createView(javax.faces.context.FacesContext, String)
* @since 1.2
*/
@Override
public UIViewRoot createView(FacesContext context, String viewId) {
return getWrapped().createView(context, viewId);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#getActionURL(javax.faces.context.FacesContext, String)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#getActionURL(javax.faces.context.FacesContext, String)
* @since 1.2
*/
@Override
public String getActionURL(FacesContext context, String viewId) {
return getWrapped().getActionURL(context, viewId);
}
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#getProtectedViewsUnmodifiable}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#getProtectedViewsUnmodifiable
* @since 2.2
*/
@Override
public Set getProtectedViewsUnmodifiable() {
return getWrapped().getProtectedViewsUnmodifiable();
}
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#addProtectedView}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#addProtectedView
* @since 2.2
*/
@Override
public void addProtectedView(String urlPattern) {
getWrapped().addProtectedView(urlPattern);
}
/**
*
* The default behavior of this method is to
* call {@link ViewHandler#removeProtectedView}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#removeProtectedView
* @since 2.2
*/
@Override
public boolean removeProtectedView(String urlPattern) {
return getWrapped().removeProtectedView(urlPattern);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#getRedirectURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#getRedirectURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
* @since 2.0
*/
@Override
public String getRedirectURL(FacesContext context,
String viewId,
Map> parameters,
boolean includeViewParams) {
return getWrapped().getRedirectURL(context,
viewId,
parameters,
includeViewParams);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#getBookmarkableURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#getBookmarkableURL(javax.faces.context.FacesContext, String, java.util.Map, boolean)
* @since 2.0
*/
@Override
public String getBookmarkableURL(FacesContext context,
String viewId,
Map> parameters,
boolean includeViewParams) {
return getWrapped().getBookmarkableURL(context,
viewId,
parameters,
includeViewParams);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#getResourceURL(javax.faces.context.FacesContext, String)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#getResourceURL(javax.faces.context.FacesContext, String)
* @since 1.2
*/
@Override
public String getResourceURL(FacesContext context, String path) {
return getWrapped().getResourceURL(context, path);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#getViewDeclarationLanguage}
* on the wrapped {@link ViewHandler} object.
*
* @since 2.0
*/
@Override
public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context,
String viewId) {
return getWrapped().getViewDeclarationLanguage(context, viewId);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#initView}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#initView
* @since 1.2
*/
@Override
public void initView(FacesContext context) throws FacesException {
getWrapped().initView(context);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)
* @since 1.2
*/
@Override
public void renderView(FacesContext context, UIViewRoot viewToRender)
throws IOException, FacesException {
getWrapped().renderView(context, viewToRender);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#restoreView(javax.faces.context.FacesContext, String)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#restoreView(javax.faces.context.FacesContext, String)
* @since 1.2
*/
@Override
public UIViewRoot restoreView(FacesContext context, String viewId) {
return getWrapped().restoreView(context, viewId);
}
/**
* The default behavior of this method is to
* call {@link ViewHandler#writeState(javax.faces.context.FacesContext)}
* on the wrapped {@link ViewHandler} object.
*
* @see ViewHandler#writeState(javax.faces.context.FacesContext)
* @since 1.2
*/
@Override
public void writeState(FacesContext context) throws IOException {
getWrapped().writeState(context);
}
}