org.primefaces

Class PrimeFaces

java.lang.Object

org.primefaces.PrimeFaces

public class PrimeFaces
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PrimeFaces.Ajax
class	PrimeFaces.Dialog
class	PrimeFaces.MultiViewState

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrimeFaces() Protected constructor to allow CDI proxying - and also allow customizations, or setting a mock.

Method Summary

Modifier and Type	Method and Description
PrimeFaces.Ajax	ajax()
void	clearDataListState(String key) Deprecated. Use PrimeFaces.MultiViewState.clear(String, String) instead
void	clearDataListStates() Deprecated. Use PrimeFaces.MultiViewState.clearAll() instead
void	clearTableState(String key) Deprecated. Use PrimeFaces.MultiViewState.clear(String, String) instead
void	clearTableStates() Deprecated. Use PrimeFaces.MultiViewState.clearAll() instead
static PrimeFaces	current()
PrimeFaces.Dialog	dialog() Returns the dialog helpers.
void	executeInitScript(String statement) Executes a JavaScript statement before all other PrimeFaces scripts are executed.
void	executeScript(String statement) Executes a JavaScript statement.
void	focus(String expression) Resolves the search expression, starting from the viewroot, and focus the resolved component.
void	focus(String expression, javax.faces.component.UIComponent base) Resolves the search expression and focus the resolved component.
protected javax.faces.context.FacesContext	getFacesContext()
protected PrimeRequestContext	getRequestContext()
boolean	isAjaxRequest() Shortcut for PartialViewContext.isAjaxRequest().
PrimeFaces.MultiViewState	multiViewState() Returns the MultiViewState helpers.
void	resetInputs(Collection<String> expressions) Resolves the search expressions, starting from the viewroot and resets all found UIInput components.
void	resetInputs(String... expressions) Resolves the search expressions, starting from the viewroot and resets all found UIInput components.
void	scrollTo(String clientId) Scrolls to a component with the given clientId.
static void	setCurrent(PrimeFaces primeFaces)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimeFaces

protected PrimeFaces()

Protected constructor to allow CDI proxying - and also allow customizations, or setting a mock.

Method Detail

current

public static PrimeFaces current()

setCurrent

public static void setCurrent(PrimeFaces primeFaces)

getFacesContext

protected javax.faces.context.FacesContext getFacesContext()

getRequestContext

protected PrimeRequestContext getRequestContext()

isAjaxRequest

public boolean isAjaxRequest()

Shortcut for PartialViewContext.isAjaxRequest().

Returns:

true if the current request is a AJAX request.

executeInitScript

public void executeInitScript(String statement)

Executes a JavaScript statement before all other PrimeFaces scripts are executed. Useful when you need to do some initialization.

Parameters:

statement - the JavaScript statement.

executeScript

public void executeScript(String statement)

Executes a JavaScript statement.

Parameters:

statement - the JavaScript statement.

scrollTo

public void scrollTo(String clientId)

Scrolls to a component with the given clientId.

Parameters:

clientId - clientId of the target component.

focus

public void focus(String expression)

Resolves the search expression, starting from the viewroot, and focus the resolved component.

Parameters:

expression - The search expression.

focus

public void focus(String expression,
                  javax.faces.component.UIComponent base)

Resolves the search expression and focus the resolved component.

Parameters:

expression - the search expression.

base - the base component from which we will start to resolve the search expression.

resetInputs

public void resetInputs(Collection<String> expressions)

Resolves the search expressions, starting from the viewroot and resets all found UIInput components.

Parameters:

expressions - a list of search expressions.

resetInputs

public void resetInputs(String... expressions)

Resolves the search expressions, starting from the viewroot and resets all found UIInput components.

Parameters:

expressions - a list of search expressions.

clearTableStates

@Deprecated
public void clearTableStates()

Deprecated. Use PrimeFaces.MultiViewState.clearAll() instead

Removes the multiViewState for all DataTables within the current session.

clearTableState

@Deprecated
public void clearTableState(String key)

Deprecated. Use PrimeFaces.MultiViewState.clear(String, String) instead

Removes the multiViewState for one specific DataTable within the current session.

Parameters:

key - Key of the DataTable. See DataTable.getMultiViewState(boolean) for the namebuild of this key.

clearDataListStates

@Deprecated
public void clearDataListStates()

Deprecated. Use PrimeFaces.MultiViewState.clearAll() instead

Removes the multiViewState for all DataLists within the current session.

clearDataListState

@Deprecated
public void clearDataListState(String key)

Deprecated. Use PrimeFaces.MultiViewState.clear(String, String) instead

Removes the multiViewState for one specific DataList within the current session.

Parameters:

key - Key of the DataList. See DataList.getMultiViewState(boolean)} for the namebuild of this key.

dialog

public PrimeFaces.Dialog dialog()

Returns the dialog helpers.

Returns:

the dialog helpers.

ajax

public PrimeFaces.Ajax ajax()

multiViewState

public PrimeFaces.MultiViewState multiViewState()

Returns the MultiViewState helpers.

Returns:

the MultiViewState helpers.