com.liferay.faces.alloy.component.progressbar.internal

Class ProgressBarAjaxBehavior

java.lang.Object

javax.faces.component.behavior.BehaviorBase

javax.faces.component.behavior.ClientBehaviorBase

javax.faces.component.behavior.AjaxBehavior

com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

com.liferay.faces.alloy.component.progressbar.internal.ProgressBarAjaxBehavior

All Implemented Interfaces:

javax.faces.component.behavior.Behavior, javax.faces.component.behavior.ClientBehavior, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.FacesWrapper<javax.faces.component.behavior.AjaxBehavior>

public class ProgressBarAjaxBehavior
extends com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

Author:

Kyle Stiemann

Field Summary

Fields inherited from class javax.faces.component.behavior.AjaxBehavior

BEHAVIOR_ID

Constructor Summary

Constructors

Constructor and Description
ProgressBarAjaxBehavior(javax.faces.component.behavior.AjaxBehavior ajaxBehavior, String pollingOnsuccessCallback, String pollingOnerrorCallback)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getExecute()
String	getOnerror()
String	getOnevent() The intention of the JSF API for this method is to return the name of the JavaScript function that will be called in one of three circumstances: Before the Ajax request is dispatched (data.status==="begin") After the Ajax response is received (data.status==="complete") After the partial response has been parsed and the DOM has been updated (data.status==="success") In the case of progressBar, rather than returning a function name, this method needs to return an anonymous function that recursively calls the polling function when data.status==="success".
Collection<String>	getRender()
String	getScript(javax.faces.component.behavior.ClientBehaviorContext behaviorContext)
javax.faces.component.behavior.AjaxBehavior	getWrapped()

Methods inherited from class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

addAjaxBehaviorListener, broadcast, clearInitialState, decode, getDelay, getHints, getRendererType, getValueExpression, initialStateMarked, isDisabled, isImmediate, isImmediateSet, isResetValues, isResetValuesSet, isTransient, markInitialState, removeAjaxBehaviorListener, restoreState, saveState, setDelay, setDisabled, setExecute, setImmediate, setOnerror, setOnevent, setRender, setResetValues, setTransient, setValueExpression

Methods inherited from class javax.faces.component.behavior.ClientBehaviorBase

getRenderer

Methods inherited from class javax.faces.component.behavior.BehaviorBase

addBehaviorListener, removeBehaviorListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressBarAjaxBehavior

public ProgressBarAjaxBehavior(javax.faces.component.behavior.AjaxBehavior ajaxBehavior,
                       String pollingOnsuccessCallback,
                       String pollingOnerrorCallback)

Parameters:

ajaxBehavior - The wrapped AjaxBehavior.

pollingOnsuccessCallback - The name of the callback which should be executed after a successful Ajax call. This argument is used to facilitate a recursive call to the polling function of the progressBar.

pollingOnerrorCallback - The name of the callback which should be executed after an error within an Ajax call. This argument is used to stop polling the server when an error occurs.

Method Detail

getExecute

public Collection<String> getExecute()

Overrides:

getExecute in class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

getOnerror

public String getOnerror()

Overrides:

getOnerror in class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

getOnevent

public String getOnevent()

The intention of the JSF API for this method is to return the name of the JavaScript function that will be called in one of three circumstances:

1. Before the Ajax request is dispatched (data.status==="begin")
2. After the Ajax response is received (data.status==="complete")
3. After the partial response has been parsed and the DOM has been updated (data.status==="success")

In the case of progressBar, rather than returning a function name, this method needs to return an anonymous function that recursively calls the polling function when data.status==="success".

Overrides:

getOnevent in class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

getRender

public Collection<String> getRender()

Overrides:

getRender in class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

getScript

public String getScript(javax.faces.component.behavior.ClientBehaviorContext behaviorContext)

Specified by:

getScript in interface javax.faces.component.behavior.ClientBehavior

Overrides:

getScript in class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper

getWrapped

public javax.faces.component.behavior.AjaxBehavior getWrapped()

Specified by:

getWrapped in interface javax.faces.FacesWrapper<javax.faces.component.behavior.AjaxBehavior>

Overrides:

getWrapped in class com.liferay.faces.util.component.behavior.AjaxBehaviorWrapper