javax.faces.lifecycle.ClientWindowFactory Maven / Gradle / Ivy
Show all versions of javax.faces Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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.lifecycle;
import javax.faces.FacesWrapper;
import javax.faces.context.FacesContext;
/**
* Create {@link ClientWindow} instances based on
* the incoming request.
*
*
* @since 2.2
*/
public abstract class ClientWindowFactory implements FacesWrapper {
/**
* If this factory has been decorated, the
* implementation doing the decorating may override this method to provide
* access to the implementation being wrapped. A default implementation
* is provided that returns null.
*
* @since 2.2
*/
@Override
public ClientWindowFactory getWrapped() {
return null;
}
/**
* The implementation is responsible
* for creating the {@link ClientWindow} instance for this request.
* If {@link ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME}
* is "none" or unspecified, this method must return {@code null}.
* If {@link ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME}
* is "url" the implementation must return a ClientWindow
* instance that implements the url-mode semantics described in
* {@link ClientWindow}.
*
* @param context the {@link FacesContext} for this request.
* @return the {@link ClientWindow} for this request, or {@code null}
*
* @since 2.2
*/
public abstract ClientWindow getClientWindow(FacesContext context);
}