com.liferay.faces.util.context

Class FacesRequestContext

java.lang.Object

com.liferay.faces.util.context.FacesRequestContext

public abstract class FacesRequestContext
extends Object

This class defines the usage of a ThreadLocal singleton that exists alongside the FacesContext.

Author:

Kyle Stiemann

Constructor Summary

Constructors

Constructor and Description
FacesRequestContext()

Method Summary

Modifier and Type	Method and Description
abstract void	addScript(javax.faces.context.FacesContext facesContext, String script) Adds the specified script to the list of scripts that are to be executed on the client.
abstract void	addScript(Script script) Adds the specified Script to the list of scripts that are to be executed on the client.
abstract void	addScript(String script) Deprecated. Call addScript(FacesContext, String) instead. Adds the specified script to the list of scripts that are to be executed on the client.
static FacesRequestContext	getCurrentInstance()
abstract List<Script>	getScripts() Returns an immutable list of scripts that were added via the addScript(Script) or addScript(FacesContext,String) method.
abstract void	release() Releases any resources that are associated with this FacesRequestContext instance.
static void	setCurrentInstance(FacesRequestContext facesRequestContext) Sets or removes the value of the ThreadLocal singleton instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FacesRequestContext

public FacesRequestContext()

Method Detail

getCurrentInstance

public static FacesRequestContext getCurrentInstance()

setCurrentInstance

public static void setCurrentInstance(FacesRequestContext facesRequestContext)

Sets or removes the value of the ThreadLocal singleton instance.

Parameters:

facesRequestContext - If a non-null value is specified, then it will become the singleton value. If null is specified, then singleton value is removed from the ThreadLocal. is removed.

addScript

public abstract void addScript(Script script)

Adds the specified Script to the list of scripts that are to be executed on the client.

addScript

@Deprecated
public abstract void addScript(String script)

Deprecated. Call addScript(FacesContext, String) instead.

Adds the specified script to the list of scripts that are to be executed on the client.

Parameters:

script - The script that is to be added.

addScript

public abstract void addScript(javax.faces.context.FacesContext facesContext,
                               String script)

Adds the specified script to the list of scripts that are to be executed on the client.

Parameters:

facesContext - The current faces context.

script - The script that is to be added.

Since:

3.1, 2.1, 1.1

getScripts

public abstract List<Script> getScripts()

Returns an immutable list of scripts that were added via the addScript(Script) or addScript(FacesContext,String) method.

release

public abstract void release()

Releases any resources that are associated with this FacesRequestContext instance.