Package de.xima.fc.gui.common.model.push
Class AjaxCallPushData.Builder
- java.lang.Object
-
- de.xima.fc.gui.common.model.push.AjaxCallPushData.Builder
-
- All Implemented Interfaces:
org.apache.commons.lang3.builder.Builder<AjaxCallPushData>
- Enclosing class:
- AjaxCallPushData
public static class AjaxCallPushData.Builder extends Object implements org.apache.commons.lang3.builder.Builder<AjaxCallPushData>
Simple builder for creating aAjaxCallPushData
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
actionListener
public AjaxCallPushData.Builder actionListener(String actionListener)
- Parameters:
actionListener
- Action listener that should be invoked, e.g.myBean.someMethod(false)
. For this to work, you need to use the defaultsource(String)
(which is used automatically if you do not specify any source).- Returns:
- this builder for chaining.
-
appendProcess
public AjaxCallPushData.Builder appendProcess(String process)
- Parameters:
process
- Search expression for the components to process in the AJAX call. This is added to the existing search expression. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.- Returns:
- this builder for chaining.
-
appendUpdate
public AjaxCallPushData.Builder appendUpdate(String update)
- Parameters:
update
- Search expression for the components to update in the AJAX call. This is added to the existing search expression. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.- Returns:
- this builder for chaining.
-
async
public AjaxCallPushData.Builder async(boolean async)
- Parameters:
async
- Whether the AJAX call should be queued to ensure a bean's thread safety.- Returns:
- this builder for chaining.
-
build
public AjaxCallPushData build()
- Specified by:
build
in interfaceorg.apache.commons.lang3.builder.Builder<AjaxCallPushData>
-
delay
public AjaxCallPushData.Builder delay(int delay)
- Parameters:
delay
- Optional delay for the AJAX call. When not specified, no delay is applied.- Returns:
- this builder for chaining.
-
formId
public AjaxCallPushData.Builder formId(String formId)
- Parameters:
formId
-Client ID
of the form to use for submitting the AJAX call. When not specified, a fallback form is used.- Returns:
- this builder for chaining.
-
global
public AjaxCallPushData.Builder global(boolean global)
- Parameters:
global
- Whether the AJAX call should trigger globalAjaxStatus
handlers. Defaults totrue
.- Returns:
- this builder for chaining.
-
ignoreAutoUpdate
public AjaxCallPushData.Builder ignoreAutoUpdate(boolean ignoreAutoUpdate)
- Parameters:
ignoreAutoUpdate
- Whether the AJAX call should not include auto updates of components.- Returns:
- this builder for chaining.
-
oncomplete
public AjaxCallPushData.Builder oncomplete(String oncomplete)
- Parameters:
oncomplete
- A JavaScript function body that is invoked when the AJAX request completes. The function body is evaluated inside a function with the same parameters as the standard PrimeFacesoncomplete
handler.- Returns:
- this builder for chaining.
-
onerror
public AjaxCallPushData.Builder onerror(String onerror)
- Parameters:
onerror
- A JavaScript function body that is invoked when the AJAX request completes with an error. The function body is evaluated inside a function with the same parameters as the standard PrimeFacesonerror
handler.- Returns:
- this builder for chaining.
-
onstart
public AjaxCallPushData.Builder onstart(String onstart)
- Parameters:
onstart
- A JavaScript function body that is invoked when the AJAX request starts. The function body is evaluated inside a function with the same parameters as the standard PrimeFacesonstart
handler.- Returns:
- this builder for chaining.
-
onsuccess
public AjaxCallPushData.Builder onsuccess(String onsuccess)
- Parameters:
onsuccess
- A JavaScript function body that is invoked when the AJAX request completes. The function body is evaluated inside a function with the same parameters as the standard PrimeFacesonsuccess
handler. completes successfully.- Returns:
- this builder for chaining.
-
params
public AjaxCallPushData.Builder params(Map<String,Serializable> params)
- Parameters:
params
- Optional parameters to send with the AJAX request. Each key-value pairs corresponds to a PrimeFaces.ajax.RequestParameter.- Returns:
- this builder for chaining.
-
partialSubmit
public AjaxCallPushData.Builder partialSubmit(boolean partialSubmit)
- Parameters:
partialSubmit
- Whether the AJAX call should only submit data that is also processed. Defaults tofalse
.- Returns:
- this builder for chaining.
-
process
public AjaxCallPushData.Builder process(String process)
- Parameters:
process
- Search expression for the components to process in the AJAX call. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.- Returns:
- this builder for chaining.
-
source
public AjaxCallPushData.Builder source(String source)
- Parameters:
source
-Client ID
of the source element that triggered the AJAX request. When not specified, a fallback component is used.- Returns:
- this builder for chaining.
-
update
public AjaxCallPushData.Builder update(String update)
- Parameters:
update
- Search expression for the components to update in the AJAX call. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.- Returns:
- this builder for chaining.
-
-