org.butterfaces.component.behavior

Class JsfAjaxRequest

java.lang.Object

org.butterfaces.component.behavior.JsfAjaxRequest

public class JsfAjaxRequest
extends Object

Builds an ajax request call that depends on the JSF Javascript API under https://docs.oracle.com/cd/E17802_01/j2ee/javaee/javaserverfaces/2.0/docs/js-api/symbols/jsf.ajax.html#.request

Author:

Lars Michaelis, Stephan Zerhusen

Constructor Summary

Constructors

Constructor and Description
JsfAjaxRequest(String source, boolean isIdString) Constructor.
JsfAjaxRequest(javax.faces.component.UIComponentBase component, javax.faces.component.behavior.AjaxBehavior ajaxBehavior, String event) Creates JsfAjaxRequest using given AjaxBehavior to set ajax parameters.

Method Summary

Modifier and Type	Method and Description
JsfAjaxRequest	addOnErrorHandler(String functionString)
JsfAjaxRequest	addOnEventHandler(String functionString)
JsfAjaxRequest	addRender(String render)
static List<String>	createRerenderIds(javax.faces.component.UIComponentBase component, String eventName)
JsfAjaxRequest	setBehaviorEvent(String behaviorEvent)
JsfAjaxRequest	setDelay(String delay)
JsfAjaxRequest	setEvent(String event)
JsfAjaxRequest	setExecute(String execute)
JsfAjaxRequest	setParams(String params)
JsfAjaxRequest	setRender(String render)
JsfAjaxRequest	setRender(javax.faces.component.UIComponentBase component, String eventName)
JsfAjaxRequest	setResetValues(boolean resetValues)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsfAjaxRequest

public JsfAjaxRequest(String source,
                      boolean isIdString)

Constructor.

Parameters:

source - the DOM element that triggered this Ajax request, or an id string of the element to use as the triggering element

isIdString - if set to true the source string will be wrapped in ''

JsfAjaxRequest

public JsfAjaxRequest(javax.faces.component.UIComponentBase component,
                      javax.faces.component.behavior.AjaxBehavior ajaxBehavior,
                      String event)

Creates JsfAjaxRequest using given AjaxBehavior to set ajax parameters.

TODO maybe remove AjaxBehavior and find it by myself by using event string?

Method Detail

setEvent

public JsfAjaxRequest setEvent(String event)

Parameters:

event - The DOM event that triggered this Ajax request.

Returns:

the actual instance of JsfAjaxRequest

setExecute

public JsfAjaxRequest setExecute(String execute)

Parameters:

execute - space seperated list of client identifiers

Returns:

the actual instance of JsfAjaxRequest

setDelay

public JsfAjaxRequest setDelay(String delay)

Parameters:

delay - delay in ms

Returns:

the actual instance of JsfAjaxRequest

setRender

public JsfAjaxRequest setRender(String render)

Parameters:

render - space seperated list of client identifiers

Returns:

the actual instance of JsfAjaxRequest

setRender

public JsfAjaxRequest setRender(javax.faces.component.UIComponentBase component,
                                String eventName)

setResetValues

public JsfAjaxRequest setResetValues(boolean resetValues)

addRender

public JsfAjaxRequest addRender(String render)

setParams

public JsfAjaxRequest setParams(String params)

Parameters:

params - object containing parameters to include in the request

Returns:

the actual instance of JsfAjaxRequest

setBehaviorEvent

public JsfAjaxRequest setBehaviorEvent(String behaviorEvent)

Parameters:

behaviorEvent - ??

Returns:

the actual instance of JsfAjaxRequest

addOnEventHandler

public JsfAjaxRequest addOnEventHandler(String functionString)

Parameters:

functionString - function to callback for event

Returns:

the actual instance of JsfAjaxRequest

addOnErrorHandler

public JsfAjaxRequest addOnErrorHandler(String functionString)

Parameters:

functionString - function to callback for error

Returns:

the actual instance of JsfAjaxRequest

toString

public String toString()

Overrides:

toString in class Object

createRerenderIds

public static List<String> createRerenderIds(javax.faces.component.UIComponentBase component,
                                             String eventName)