Package org.primefaces.context

Class RequestContext

java.lang.Object

org.primefaces.context.RequestContext

Direct Known Subclasses:

DefaultRequestContext

public abstract class RequestContext
extends Object

A RequestContext is a helper class consisting of several utilities. RequestContext is thread-safe and scope is same as FacesContext. Current instance can be retrieved as;

RequestContext.getCurrentInstance(context);

Constructor Summary

Constructors

Constructor	Description
RequestContext()

Method Summary

Modifier and Type	Method	Description
abstract void	addCallbackParam(String name, Object value)	Deprecated. Use PrimeFaces.ajax().addCallbackParam instead
abstract void	clearTableState(String clientId)	Deprecated. Use PrimeFaces.clearTableState(java.lang.String) instead
abstract void	clearTableStates()	Deprecated. Use PrimeFaces#clearTableState() instead
abstract void	closeDialog(Object data)	Deprecated. Use PrimeFaces.dialog().closeDynamic instead
abstract void	execute(String script)	Deprecated. Use PrimeFaces.executeScript(java.lang.String)
abstract AjaxRequestBuilder	getAjaxRequestBuilder()
abstract ApplicationContext	getApplicationContext()
abstract Map<Object,Object>	getAttributes()	Deprecated.
abstract Map<String,Object>	getCallbackParams()
abstract CSVBuilder	getCSVBuilder()
static RequestContext	getCurrentInstance()
static RequestContext	getCurrentInstance(javax.faces.context.FacesContext facesContext)
abstract StringEncrypter	getEncrypter()
abstract List<String>	getScriptsToExecute()
abstract WidgetBuilder	getWidgetBuilder()
abstract boolean	isAjaxRequest()	Deprecated. Use PrimeFaces.isAjaxRequest() instead
abstract boolean	isIgnoreAutoUpdate()
abstract boolean	isRTL()
abstract boolean	isSecure()	Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
abstract void	openDialog(String outcome)	Deprecated. Use PrimeFaces.dialog().openDynamic() instead
abstract void	openDialog(String outcome, Map<String,Object> options, Map<String,List<String>> params)	Deprecated. Use PrimeFaces.dialog().openDynamic() instead
abstract void	release()	Clear resources.
abstract void	reset(String expressions)	Deprecated. Use PrimeFaces.resetInputs(java.lang.String...) instead
abstract void	reset(String... expressions)	Deprecated. Use PrimeFaces.resetInputs(java.lang.String...) instead
abstract void	reset(Collection<String> expressions)	Deprecated. Use PrimeFaces.resetInputs(java.lang.String...) instead
abstract void	scrollTo(String clientId)	Deprecated. Use PrimeFaces.scrollTo(java.lang.String) instead
static void	setCurrentInstance(RequestContext context, javax.faces.context.FacesContext facesContext)
abstract void	showMessageInDialog(javax.faces.application.FacesMessage message)	Deprecated. Use PrimeFaces.dialog().showMessageDynamic instead
abstract void	update(String name)	Deprecated. Use PrimeFaces.ajax().update() instead
abstract void	update(Collection<String> collection)	Deprecated. Use PrimeFaces.ajax().update() instead

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestContext

public RequestContext()

Method Detail

getCurrentInstance

public static RequestContext getCurrentInstance()

getCurrentInstance

public static RequestContext getCurrentInstance(javax.faces.context.FacesContext facesContext)

setCurrentInstance

public static void setCurrentInstance(RequestContext context,
                                      javax.faces.context.FacesContext facesContext)

isAjaxRequest

@Deprecated
public abstract boolean isAjaxRequest()

Deprecated. Use PrimeFaces.isAjaxRequest() instead

Returns:

addCallbackParam

@Deprecated
public abstract void addCallbackParam(String name,
                                      Object value)

Deprecated. Use PrimeFaces.ajax().addCallbackParam instead

getCallbackParams

public abstract Map<String,Object> getCallbackParams()

Returns:

all callback parameters added in the current request.

getScriptsToExecute

public abstract List<String> getScriptsToExecute()

Returns:

all scripts added in the current request.

execute

@Deprecated
public abstract void execute(String script)

Deprecated. Use PrimeFaces.executeScript(java.lang.String)

Use PrimeFaces.executeScript(java.lang.String)

Parameters:

script -

scrollTo

@Deprecated
public abstract void scrollTo(String clientId)

Deprecated. Use PrimeFaces.scrollTo(java.lang.String) instead

Parameters:

clientId -

update

@Deprecated
public abstract void update(String name)

Deprecated. Use PrimeFaces.ajax().update() instead

update

@Deprecated
public abstract void update(Collection<String> collection)

Deprecated. Use PrimeFaces.ajax().update() instead

reset

@Deprecated
public abstract void reset(String expressions)

Deprecated. Use PrimeFaces.resetInputs(java.lang.String...) instead

Parameters:

expressions -

reset

@Deprecated
public abstract void reset(Collection<String> expressions)

Deprecated. Use PrimeFaces.resetInputs(java.lang.String...) instead

Parameters:

expressions -

reset

@Deprecated
public abstract void reset(String... expressions)

Deprecated. Use PrimeFaces.resetInputs(java.lang.String...) instead

Parameters:

expressions -

getWidgetBuilder

public abstract WidgetBuilder getWidgetBuilder()

Returns:

Shared WidgetBuilder instance of the current request

getAjaxRequestBuilder

public abstract AjaxRequestBuilder getAjaxRequestBuilder()

Returns:

Shared AjaxRequestBuilder instance of the current request

getCSVBuilder

public abstract CSVBuilder getCSVBuilder()

Returns:

Shared Client Side Validation builder instance of the current request

getAttributes

@Deprecated
public abstract Map<Object,Object> getAttributes()

Deprecated.

Use FacesContext#getAttributes()

openDialog

@Deprecated
public abstract void openDialog(String outcome)

Deprecated. Use PrimeFaces.dialog().openDynamic() instead

openDialog

@Deprecated
public abstract void openDialog(String outcome,
                                Map<String,Object> options,
                                Map<String,List<String>> params)

Deprecated. Use PrimeFaces.dialog().openDynamic() instead

closeDialog

@Deprecated
public abstract void closeDialog(Object data)

Deprecated. Use PrimeFaces.dialog().closeDynamic instead

showMessageInDialog

@Deprecated
public abstract void showMessageInDialog(javax.faces.application.FacesMessage message)

Deprecated. Use PrimeFaces.dialog().showMessageDynamic instead

getApplicationContext

public abstract ApplicationContext getApplicationContext()

Returns:

ApplicationContext instance.

getEncrypter

public abstract StringEncrypter getEncrypter()

Returns:

StringEncrypter used to encode and decode a string.

release

public abstract void release()

Clear resources.

isSecure

public abstract boolean isSecure()

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

isIgnoreAutoUpdate

public abstract boolean isIgnoreAutoUpdate()

Returns:

true if AutoUpdatable components should not be updated automatically in this request.

isRTL

public abstract boolean isRTL()

clearTableStates

@Deprecated
public abstract void clearTableStates()

Deprecated. Use PrimeFaces#clearTableState() instead

clearTableState

@Deprecated
public abstract void clearTableState(String clientId)

Deprecated. Use PrimeFaces.clearTableState(java.lang.String) instead

Parameters:

clientId -