|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ajax4jsf.renderkit.AjaxRendererUtils
public final class AjaxRendererUtils
Field Summary | |
---|---|
static java.lang.String |
AJAX_ABORT_ATTR
|
static java.lang.String |
AJAX_AREAS_RENDERED
|
static java.lang.String |
AJAX_COMPONENT_ID_PARAMETER
|
static java.lang.String |
AJAX_DELAY_ATTR
|
static java.lang.String |
AJAX_FUNCTION_NAME
Name Javasript function for submit AJAX request |
static java.lang.String |
AJAX_PROCESS_ATTRIBUTE
|
static java.lang.String |
AJAX_QUEUE_ATTR
|
static java.lang.String |
AJAX_REGIONS_ATTRIBUTE
|
static java.lang.String |
AJAX_SINGLE_ATTR
|
static java.lang.String |
AJAX_SINGLE_PARAMETER_NAME
|
static java.lang.String |
ALL
|
static java.lang.String |
BEHAVIOR_EVENT_PARAMETER
|
static java.lang.String |
DATA_ATTR_NAME
|
static java.lang.String |
EXTENSION_ID
|
static java.lang.String |
FORM
|
static java.util.Set<java.lang.String> |
GLOBAL_META_COMPONENTS
|
static java.lang.String |
LIMITRENDER_ATTR_NAME
Attribute to keep |
static java.lang.String |
NONE
|
static java.lang.String |
ONBEFOREDOMUPDATE_ATTR_NAME
Attribute for keep JavaScript function name for call before updating DOM tree. |
static java.lang.String |
ONBEGIN_ATTR_NAME
|
static java.lang.String |
ONCOMPLETE_ATTR_NAME
Attribute for keep JavaScript function name for call after complete request. |
static java.lang.String |
ONCOMPLETE_CONTENT_ID
Attribute for keep JavaScript function name for call after complete request. |
static java.lang.String |
REGION
|
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 |
THIS
|
static java.lang.String |
VALUE_ATTR
|
Method Summary | |
---|---|
static void |
addRegionByName(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component,
java.lang.String id)
TODO: add deprecation |
static void |
addRegionsFromComponent(javax.faces.component.UIComponent component,
javax.faces.context.FacesContext facesContext)
|
static java.lang.String[] |
asArray(java.lang.String valuesSet)
Split parameter string into array of strings. |
static java.util.Set<java.lang.String> |
asSet(java.lang.Object valueToSet)
Convert parameter ( Collection, List, array, String, comma-separated String, whitespace-separate String) to set of strings. |
static org.ajax4jsf.javascript.JSFunction |
buildAjaxFunction(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent,
java.lang.String functionName)
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 AjaxEventOptions |
buildEventOptions(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
|
static AjaxEventOptions |
buildEventOptions(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component,
org.ajax4jsf.component.AjaxClientBehavior ajaxBehavior)
|
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 void |
encodeAjaxBegin(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Encode declaration for AJAX response. |
static void |
encodeAjaxEnd(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
End encoding of AJAX response. |
static void |
encodeAreas(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Encode rendered areas as special HTML tag ( span in current release ) |
static org.ajax4jsf.component.AjaxContainer |
findAjaxContainer(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
|
static java.lang.String |
getAbsoluteId(javax.faces.component.UIComponent component)
Replacement for buggy in MyFaces RendererUtils |
protected static java.lang.String |
getAjaxActionUrl(javax.faces.context.FacesContext facesContext)
|
static java.util.Set<java.lang.String> |
getAjaxAreas(javax.faces.component.UIComponent uiComponent)
Get list of clientId's for given component |
static java.util.Set<java.lang.String> |
getAjaxAreasToProcess(javax.faces.component.UIComponent component)
Returns set of areas to be processed as a result of this component action invocation |
static java.lang.Object |
getAjaxData(javax.faces.component.UIComponent component)
|
static java.lang.String |
getAjaxOnBeforeDomUpdate(javax.faces.component.UIComponent component)
Get function name for call before update DOM. |
static java.lang.String |
getAjaxOnBegin(javax.faces.component.UIComponent component)
|
static java.lang.String |
getAjaxOncomplete(javax.faces.component.UIComponent component)
Get function name for call on completed ajax request. |
static java.lang.String |
getAjaxStatus(javax.faces.component.UIComponent component)
Get status area Id for given component. |
static javax.faces.component.UIComponent |
getNestingForm(javax.faces.component.UIComponent component)
Find nested form for given component |
static boolean |
isAjaxLimitRender(javax.faces.component.UIComponent component)
Calculate, must be component render only given areas, or all sended from server. |
static boolean |
isAjaxRequest(javax.faces.context.FacesContext facesContext)
|
static void |
loadBundles(javax.faces.context.FacesContext context)
Find all instances of UILoadBundle in view tree and load bundles
to request-scope map. |
static void |
renderAjaxExtensions(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
|
static void |
writeState(javax.faces.context.FacesContext context)
Write state saving markers to context, include MyFaces view sequence. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String AJAX_ABORT_ATTR
public static final java.lang.String AJAX_AREAS_RENDERED
public static final java.lang.String AJAX_DELAY_ATTR
public static final java.lang.String AJAX_FUNCTION_NAME
public static final java.lang.String AJAX_PROCESS_ATTRIBUTE
public static final java.lang.String AJAX_QUEUE_ATTR
public static final java.lang.String AJAX_REGIONS_ATTRIBUTE
public static final java.lang.String AJAX_SINGLE_ATTR
public static final java.lang.String AJAX_SINGLE_PARAMETER_NAME
public static final java.lang.String ALL
public static final java.lang.String FORM
public static final java.lang.String THIS
public static final java.lang.String REGION
public static final java.lang.String NONE
public static final java.util.Set<java.lang.String> GLOBAL_META_COMPONENTS
public static final java.lang.String LIMITRENDER_ATTR_NAME
public static final java.lang.String ONBEFOREDOMUPDATE_ATTR_NAME
public static final java.lang.String ONBEGIN_ATTR_NAME
public static final java.lang.String ONCOMPLETE_ATTR_NAME
public static final java.lang.String DATA_ATTR_NAME
public static final java.lang.String ONCOMPLETE_CONTENT_ID
public static final java.lang.String SIMILARITY_GROUPING_ID_ATTR
public static final java.lang.String STATUS_ATTR_NAME
public static final java.lang.String VALUE_ATTR
public static final java.lang.String EXTENSION_ID
public static final java.lang.String AJAX_COMPONENT_ID_PARAMETER
public static final java.lang.String BEHAVIOR_EVENT_PARAMETER
Method Detail |
---|
public static java.lang.StringBuffer buildOnClick(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext)
uiComponent
- -
component for build eventfacesContext
-
StringBuffer
with Javascript codepublic static java.lang.StringBuffer buildOnClick(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext, boolean omitDefaultActionUrl)
uiComponent
- -
component for build eventfacesContext
- omitDefaultActionUrl
- - default action URL is not encoded if parameter is true
StringBuffer
with Javascript codepublic static java.lang.StringBuffer buildOnEvent(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext, java.lang.String eventName)
uiComponent
- -
component for build eventfacesContext
- eventName
- -
name of event
StringBuffer
with Javascript codepublic static java.lang.StringBuffer buildOnEvent(javax.faces.component.UIComponent uiComponent, javax.faces.context.FacesContext facesContext, java.lang.String eventName, boolean omitDefaultActionUrl)
uiComponent
- -
component for build eventfacesContext
- eventName
- -
name of eventomitDefaultActionUrl
- - default action URL is not encoded if parameter is true
StringBuffer
with Javascript codepublic static AjaxEventOptions buildEventOptions(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
public static AjaxEventOptions buildEventOptions(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, org.ajax4jsf.component.AjaxClientBehavior ajaxBehavior)
public static org.ajax4jsf.javascript.JSFunction buildAjaxFunction(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, java.lang.String functionName)
facesContext
- uiComponent
- functionName
-
public static java.util.Set<java.lang.String> getAjaxAreas(javax.faces.component.UIComponent uiComponent)
uiComponent
-
public static java.util.Set<java.lang.String> getAjaxAreasToProcess(javax.faces.component.UIComponent component)
component
-
public static java.lang.String[] asArray(java.lang.String valuesSet)
valuesSet
-
public static java.util.Set<java.lang.String> asSet(java.lang.Object valueToSet)
valueToSet
- -
object for conversion to Set.
public static java.lang.String getAjaxStatus(javax.faces.component.UIComponent component)
component
-
null
public static org.ajax4jsf.javascript.JSFunctionDefinition buildAjaxOncomplete(java.lang.String body)
public static org.ajax4jsf.javascript.JSFunctionDefinition buildAjaxOnBeforeDomUpdate(java.lang.String body)
public static java.lang.String getAjaxOncomplete(javax.faces.component.UIComponent component)
component
- for wich calculate function name
null
public static java.lang.String getAjaxOnBeforeDomUpdate(javax.faces.component.UIComponent component)
component
- for wich calculate function name
null
public static java.lang.String getAjaxOnBegin(javax.faces.component.UIComponent component)
public static java.lang.Object getAjaxData(javax.faces.component.UIComponent component)
component
-
public static boolean isAjaxLimitRender(javax.faces.component.UIComponent component)
component
-
true
if client must render ONLY given areas.public static java.lang.String getAbsoluteId(javax.faces.component.UIComponent component)
RendererUtils
component
-
public static javax.faces.component.UIComponent getNestingForm(javax.faces.component.UIComponent component)
component
-
UIForm
component, or null
protected static java.lang.String getAjaxActionUrl(javax.faces.context.FacesContext facesContext)
public static org.ajax4jsf.component.AjaxContainer findAjaxContainer(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
facesContext
- uiComponent
-
public static void encodeAreas(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) throws java.io.IOException
context
- component
-
java.io.IOException
public static void writeState(javax.faces.context.FacesContext context) throws java.io.IOException
context
-
java.io.IOException
public static void encodeAjaxBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) throws java.io.IOException
context
- component
-
java.io.IOException
public static void encodeAjaxEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) throws java.io.IOException
context
- component
-
java.io.IOException
public static void loadBundles(javax.faces.context.FacesContext context)
UILoadBundle
in view tree and load bundles
to request-scope map.
context
-
java.io.IOException
public static boolean isAjaxRequest(javax.faces.context.FacesContext facesContext)
facesContext
-
public static void addRegionByName(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, java.lang.String id)
facesContext
- component
- id
- public static void addRegionsFromComponent(javax.faces.component.UIComponent component, javax.faces.context.FacesContext facesContext)
facesContext
- component
- public static void renderAjaxExtensions(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) throws java.io.IOException
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |