org.richfaces.renderkit.util
Class CoreAjaxRendererUtils

java.lang.Object
  org.richfaces.renderkit.util.CoreAjaxRendererUtils

public final class CoreAjaxRendererUtils
extends Object

Author:

shura

Some utilites for render AJAX components.

Field Summary

static String	AJAX_PROCESS_ATTRIBUTE
static String	AJAX_REGIONS_ATTRIBUTE
static String	DATA_ATTR_NAME
static String	LIMITRENDER_ATTR_NAME Attribute to keep
static String	ONBEFOREDOMUPDATE_ATTR_NAME Attribute for keep JavaScript function name for call before updating DOM tree.
static String	ONCOMPLETE_ATTR_NAME Attribute for keep JavaScript function name for call after complete request.

Method Summary

static Set<String>	asIdsSet(Object valueToSet)
static Set<String>	asSimpleSet(Object valueToSet)
static Set<String>	getAjaxAreas(javax.faces.component.UIComponent uiComponent) Get list of clientId's for given component
static Set<String>	getAjaxAreasToProcess(javax.faces.component.UIComponent component) Returns set of areas to be processed as a result of this component action invocation
static Object	getAjaxData(javax.faces.component.UIComponent component)
static String	getAjaxOnBeforeDomUpdate(javax.faces.component.UIComponent component) Get function name for call before update DOM.
static String	getAjaxOncomplete(javax.faces.component.UIComponent component) Get function name for call on completed ajax request.
static boolean	isAjaxLimitRender(javax.faces.component.UIComponent component) Calculate, must be component render only given areas, or all sended from server.
static void	renderAjaxExtensions(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)

Methods inherited from class java.lang.Object

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

Field Detail

ONBEFOREDOMUPDATE_ATTR_NAME

public static final String ONBEFOREDOMUPDATE_ATTR_NAME

Attribute for keep JavaScript function name for call before updating DOM tree.

See Also:

Constant Field Values

ONCOMPLETE_ATTR_NAME

public static final String ONCOMPLETE_ATTR_NAME

Attribute for keep JavaScript function name for call after complete request.

See Also:

Constant Field Values

DATA_ATTR_NAME

public static final String DATA_ATTR_NAME

See Also:

Constant Field Values

LIMITRENDER_ATTR_NAME

public static final String LIMITRENDER_ATTR_NAME

Attribute to keep

See Also:

Constant Field Values

AJAX_PROCESS_ATTRIBUTE

public static final String AJAX_PROCESS_ATTRIBUTE

Since:

3.3.0

See Also:

Constant Field Values

AJAX_REGIONS_ATTRIBUTE

public static final String AJAX_REGIONS_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

renderAjaxExtensions

public static void renderAjaxExtensions(javax.faces.context.FacesContext facesContext,
                                        javax.faces.component.UIComponent component)
                                 throws IOException

Throws:

IOException

getAjaxAreas

public static Set<String> getAjaxAreas(javax.faces.component.UIComponent uiComponent)

Get list of clientId's for given component

Parameters:

uiComponent -

Returns:

List of areas Id's , updated by this component.

getAjaxAreasToProcess

public static Set<String> getAjaxAreasToProcess(javax.faces.component.UIComponent component)

Returns set of areas to be processed as a result of this component action invocation

Parameters:

component -

Returns:

set of IDs that should be processed as a

Since:

3.3.0

asSimpleSet

public static Set<String> asSimpleSet(Object valueToSet)

asIdsSet

public static Set<String> asIdsSet(Object valueToSet)

isAjaxLimitRender

public static boolean isAjaxLimitRender(javax.faces.component.UIComponent component)

Calculate, must be component render only given areas, or all sended from server.

Parameters:

component -

Returns:

true if client must render ONLY given areas.

getAjaxOncomplete

public static String getAjaxOncomplete(javax.faces.component.UIComponent component)

Get function name for call on completed ajax request.

Parameters:

component - for wich calculate function name

Returns:

name of JavaScript function or null

getAjaxOnBeforeDomUpdate

public static String getAjaxOnBeforeDomUpdate(javax.faces.component.UIComponent component)

Get function name for call before update DOM.

Parameters:

component - for wich calculate function name

Returns:

name of JavaScript function or null

getAjaxData

public static Object getAjaxData(javax.faces.component.UIComponent component)

Parameters:

component -

Returns:

Since:

4.0