javax.faces.lifecycle
Class ClientWindow

java.lang.Object
  extended by javax.faces.lifecycle.ClientWindow

public abstract class ClientWindow
extends Object

This class represents a client window, which may be a browser tab, browser window, browser pop-up, portlet, or anything else that can display a UIComponent hierarchy rooted at a UIViewRoot.

Modes of Operation

Since:
2.2

Field Summary
static String WINDOW_ID_MODE_PARAM_NAME
          

The context-param that controls the operation of the ClientWindow feature.

 
Constructor Summary
ClientWindow()
           
 
Method Summary
abstract  void decode(FacesContext context)
          

The implementation is responsible for examining the incoming request and extracting the value that must be returned from the getId() method.

static void disableClientWindowUrlMode(FacesContext context)
          

Components that permit per-use disabling of the appending of the windowId in generated URLs must call this method first before rendering those URLs.

static void enableClientWindowUrlMode(FacesContext context)
          

Components that permit per-use disabling of the appending of the windowId in generated URLs must call this method first after rendering those URLs.

abstract  String getId()
          

Return a String value that uniquely identifies this ClientWindow within the scope of the current session.

static boolean isClientWindowUrlModeEnabled(FacesContext context)
          

Methods that append the windowId to generated URLs must call this method to see if they are permitted to do so.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WINDOW_ID_MODE_PARAM_NAME

public static final String WINDOW_ID_MODE_PARAM_NAME

The context-param that controls the operation of the ClientWindow feature. Valid values are "none" and "url", without the quotes. If not specified, "none" is assumed.

Since:
2.2
See Also:
Constant Field Values
Constructor Detail

ClientWindow

public ClientWindow()
Method Detail

getId

public abstract String getId()

Return a String value that uniquely identifies this ClientWindow within the scope of the current session. See decode(javax.faces.context.FacesContext) for the specification of how to derive this value.

Since:
2.2

decode

public abstract void decode(FacesContext context)

The implementation is responsible for examining the incoming request and extracting the value that must be returned from the getId() method. If WINDOW_ID_MODE_PARAM_NAME is "none" this method must not be invoked. If WINDOW_ID_MODE_PARAM_NAME is "url" the implementation must first look for a request parameter under the name given by the value of ResponseStateManager.WINDOW_ID_PARAM. If no value is found, look for a request parameter under the name given by the value of ResponseStateManager.WINDOW_ID_URL_PARAM. If no value is found, fabricate an id that uniquely identifies this ClientWindow within the scope of the current session. This value must be encrypted with a key stored in the http session and made available to return from the getId() method. The value must be suitable for inclusion as a hidden field or query parameter. If a value is found, decrypt it using the key from the session and make it available for return from getId().

Parameters:
context - the FacesContext for this request.
Since:
2.2

disableClientWindowUrlMode

public static void disableClientWindowUrlMode(FacesContext context)

Components that permit per-use disabling of the appending of the windowId in generated URLs must call this method first before rendering those URLs. The caller must call enableClientWindowUrlMode(javax.faces.context.FacesContext) from a finally block after rendering the URL. If WINDOW_ID_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the windowId by default.

Parameters:
context - the FacesContext for this request.
Since:
2.2

enableClientWindowUrlMode

public static void enableClientWindowUrlMode(FacesContext context)

Components that permit per-use disabling of the appending of the windowId in generated URLs must call this method first after rendering those URLs. If WINDOW_ID_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the windowId by default.

Parameters:
context - the FacesContext for this request.
Since:
2.2

isClientWindowUrlModeEnabled

public static boolean isClientWindowUrlModeEnabled(FacesContext context)

Methods that append the windowId to generated URLs must call this method to see if they are permitted to do so. If WINDOW_ID_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the windowId by default.

Parameters:
context - the FacesContext for this request.
Since:
2.2


Copyright 2002-2010 Oracle America Inc, Inc. All Rights Reserved.