org.primefaces.context
Class DefaultRequestContext

java.lang.Object
  org.primefaces.context.RequestContext
      org.primefaces.context.DefaultRequestContext

public class DefaultRequestContext
extends RequestContext

Constructor Summary

DefaultRequestContext()

Method Summary

void	addCallbackParam(String name, Object value) Add a parameter for ajax oncomplete client side callbacks.
void	execute(String script) Execute a javascript after current ajax request is completed.
Map<String,Object>	getCallbackParams()
List<String>	getScriptsToExecute()
WidgetBuilder	getWidgetBuilder()
boolean	isAjaxRequest()
void	reset(Collection<String> ids) Reset a collection of editableValueHolders.
void	reset(String id) Reset an editableValueHolder.
void	scrollTo(String clientId) Scroll to a component after ajax request is completed.
void	update(Collection<String> collection) Update components with ajax.
void	update(String clientId) Update a component with ajax.

Methods inherited from class org.primefaces.context.RequestContext

getCurrentInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRequestContext

public DefaultRequestContext()

Method Detail

isAjaxRequest

public boolean isAjaxRequest()

Specified by:

isAjaxRequest in class RequestContext

Returns:

true if request is an ajax request, otherwise return false.

addCallbackParam

public void addCallbackParam(String name,
                             Object value)

Description copied from class: RequestContext

Add a parameter for ajax oncomplete client side callbacks. Value would be serialized to json.

Specified by:

addCallbackParam in class RequestContext

Parameters:

name - name of the parameter.

execute

public void execute(String script)

Description copied from class: RequestContext

Execute a javascript after current ajax request is completed.

Specified by:

execute in class RequestContext

Parameters:

script - Javascript statement to execute.

getCallbackParams

public Map<String,Object> getCallbackParams()

Specified by:

getCallbackParams in class RequestContext

Returns:

all callback parameters added in the current request.

getScriptsToExecute

public List<String> getScriptsToExecute()

Specified by:

getScriptsToExecute in class RequestContext

Returns:

all scripts added in the current request.

getWidgetBuilder

public WidgetBuilder getWidgetBuilder()

Specified by:

getWidgetBuilder in class RequestContext

Returns:

Shared WidgetBuilder instance of the current request

scrollTo

public void scrollTo(String clientId)

Description copied from class: RequestContext

Scroll to a component after ajax request is completed.

Specified by:

scrollTo in class RequestContext

Parameters:

clientId - Client side identifier of the component.

update

public void update(String clientId)

Description copied from class: RequestContext

Update a component with ajax.

Specified by:

update in class RequestContext

Parameters:

clientId - Client side identifier of the component.

update

public void update(Collection<String> collection)

Description copied from class: RequestContext

Update components with ajax.

Specified by:

update in class RequestContext

Parameters:

collection - Client side identifiers of the components.

reset

public void reset(Collection<String> ids)

Description copied from class: RequestContext

Reset a collection of editableValueHolders.

Specified by:

reset in class RequestContext

Parameters:

ids - Client side identifiers of the components.

reset

public void reset(String id)

Description copied from class: RequestContext

Reset an editableValueHolder.

Specified by:

reset in class RequestContext

Parameters:

id - Client side identifier of the component.