Richfaces UI Components UI 4.1.0.20110910-M2

org.richfaces.renderkit.util
Class AjaxRendererUtils

java.lang.Object
  extended by org.richfaces.renderkit.util.AjaxRendererUtils

public final class AjaxRendererUtils
extends java.lang.Object

Author:
shura

Some utilites for render AJAX components.


Field Summary
static java.lang.String AJAX_ABORT_ATTR
           
static java.lang.String AJAX_AREAS_RENDERED
           
static java.lang.String AJAX_DELAY_ATTR
           
static java.lang.String AJAX_QUEUE_ATTR
           
static java.lang.String AJAX_SINGLE_ATTR
           
static java.lang.String AJAX_SINGLE_PARAMETER_NAME
           
static java.lang.String BEGIN_EVENT_NAME
           
static java.lang.String ONBEGIN_ATTR_NAME
           
static java.lang.String ONCOMPLETE_CONTENT_ID
          Attribute for keep JavaScript function name for call after complete request.
static java.lang.String QUEUE_ID_ATTRIBUTE
           
static java.lang.String SIMILARITY_GROUPING_ID_ATTR
           
static java.lang.String STATUS_ATTR_NAME
          Attribute for keep clientId of status component
static java.lang.String VALUE_ATTR
           
 
Method Summary
static AjaxFunction buildAjaxFunction(javax.faces.component.behavior.ClientBehaviorContext behaviorContext, org.ajax4jsf.component.AjaxClientBehavior behavior)
           
static AjaxFunction buildAjaxFunction(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
          Create call to Ajax Submit function with first two parameters
static org.ajax4jsf.javascript.JSFunctionDefinition buildAjaxOnBeforeDomUpdate(java.lang.String body)
           
static org.ajax4jsf.javascript.JSFunctionDefinition buildAjaxOncomplete(java.lang.String body)
           
static AjaxOptions buildEventOptions(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
           
static java.lang.StringBuffer buildOnClick(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext)
          Build JavaScript onclick event for given component
static java.lang.StringBuffer buildOnClick(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext, boolean omitDefaultActionUrl)
          Build JavaScript onclick event for given component
static java.lang.StringBuffer buildOnEvent(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext, java.lang.String eventName)
          Build JavaScript event for component
static java.lang.StringBuffer buildOnEvent(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext, java.lang.String eventName, boolean omitDefaultActionUrl)
          Build JavaScript event for component
static java.lang.String getAjaxStatus(javax.faces.component.UIComponent component)
          Get status area Id for given component.
static java.lang.String getQueueId(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

BEGIN_EVENT_NAME

public static final java.lang.String BEGIN_EVENT_NAME
See Also:
Constant Field Values

AJAX_ABORT_ATTR

public static final java.lang.String AJAX_ABORT_ATTR
See Also:
Constant Field Values

AJAX_AREAS_RENDERED

public static final java.lang.String AJAX_AREAS_RENDERED
See Also:
Constant Field Values

AJAX_DELAY_ATTR

public static final java.lang.String AJAX_DELAY_ATTR
See Also:
Constant Field Values

AJAX_QUEUE_ATTR

public static final java.lang.String AJAX_QUEUE_ATTR
See Also:
Constant Field Values

AJAX_SINGLE_ATTR

public static final java.lang.String AJAX_SINGLE_ATTR
See Also:
Constant Field Values

AJAX_SINGLE_PARAMETER_NAME

public static final java.lang.String AJAX_SINGLE_PARAMETER_NAME
See Also:
Constant Field Values

ONBEGIN_ATTR_NAME

public static final java.lang.String ONBEGIN_ATTR_NAME
See Also:
Constant Field Values

ONCOMPLETE_CONTENT_ID

public static final java.lang.String ONCOMPLETE_CONTENT_ID
Attribute for keep JavaScript function name for call after complete request.

See Also:
Constant Field Values

SIMILARITY_GROUPING_ID_ATTR

public static final java.lang.String SIMILARITY_GROUPING_ID_ATTR
See Also:
Constant Field Values

STATUS_ATTR_NAME

public static final java.lang.String STATUS_ATTR_NAME
Attribute for keep clientId of status component

See Also:
Constant Field Values

VALUE_ATTR

public static final java.lang.String VALUE_ATTR
See Also:
Constant Field Values

QUEUE_ID_ATTRIBUTE

public static final java.lang.String QUEUE_ID_ATTRIBUTE
See Also:
Constant Field Values
Method Detail

buildOnClick

public static java.lang.StringBuffer buildOnClick(javax.faces.component.UIComponent uiComponent,
                                                  javax.faces.context.FacesContext facesContext)
Build JavaScript onclick event for given component

Parameters:
uiComponent - - component for build event
facesContext -
Returns:
StringBuffer with Javascript code

buildOnClick

public static java.lang.StringBuffer buildOnClick(javax.faces.component.UIComponent uiComponent,
                                                  javax.faces.context.FacesContext facesContext,
                                                  boolean omitDefaultActionUrl)
Build JavaScript onclick event for given component

Parameters:
uiComponent - - component for build event
facesContext -
omitDefaultActionUrl - - default action URL is not encoded if parameter is true
Returns:
StringBuffer with Javascript code

buildOnEvent

public static java.lang.StringBuffer buildOnEvent(javax.faces.component.UIComponent uiComponent,
                                                  javax.faces.context.FacesContext facesContext,
                                                  java.lang.String eventName)
Build JavaScript event for component

Parameters:
uiComponent - - component for build event
facesContext -
eventName - - name of event
Returns:
StringBuffer with Javascript code

buildOnEvent

public static java.lang.StringBuffer buildOnEvent(javax.faces.component.UIComponent uiComponent,
                                                  javax.faces.context.FacesContext facesContext,
                                                  java.lang.String eventName,
                                                  boolean omitDefaultActionUrl)
Build JavaScript event for component

Parameters:
uiComponent - - component for build event
facesContext -
eventName - - name of event
omitDefaultActionUrl - - default action URL is not encoded if parameter is true
Returns:
StringBuffer with Javascript code

buildEventOptions

public static AjaxOptions buildEventOptions(javax.faces.context.FacesContext facesContext,
                                            javax.faces.component.UIComponent component)

buildAjaxFunction

public static AjaxFunction buildAjaxFunction(javax.faces.context.FacesContext facesContext,
                                             javax.faces.component.UIComponent component)
Create call to Ajax Submit function with first two parameters

Parameters:
facesContext -
component -
Returns:

buildAjaxFunction

public static AjaxFunction buildAjaxFunction(javax.faces.component.behavior.ClientBehaviorContext behaviorContext,
                                             org.ajax4jsf.component.AjaxClientBehavior behavior)

getAjaxStatus

public static java.lang.String getAjaxStatus(javax.faces.component.UIComponent component)
Get status area Id for given component.

Parameters:
component -
Returns:
clientId of status area, or null

getQueueId

public static java.lang.String getQueueId(javax.faces.component.UIComponent component)

buildAjaxOncomplete

public static org.ajax4jsf.javascript.JSFunctionDefinition buildAjaxOncomplete(java.lang.String body)

buildAjaxOnBeforeDomUpdate

public static org.ajax4jsf.javascript.JSFunctionDefinition buildAjaxOnBeforeDomUpdate(java.lang.String body)

Richfaces UI Components UI 4.1.0.20110910-M2

Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.