Package com.github.bordertech.wcomponents

Class AjaxOperation

java.lang.Object

com.github.bordertech.wcomponents.AjaxOperation

All Implemented Interfaces:

Serializable

public final class AjaxOperation
extends Object
implements Serializable

AjaxOperation describes an AJAX operation, which can replace one or more components.

See setTargetContainerId(String) for details on how to set up lazy-loading.

Since:

1.0.0

Author:

Yiannis Paschalidis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AjaxOperation.AjaxAction	AJAX actions.

Constructor Summary

Constructors

Constructor	Description
AjaxOperation(String triggerId)	Creates an AjaxOperation for Internal AJAX Operation.
AjaxOperation(String triggerId, String targetId)	Creates an AjaxOperation.
AjaxOperation(String triggerId, List<String> targetIds)	Creates an AjaxOperation.

Method Summary

Modifier and Type	Method	Description
AjaxOperation.AjaxAction	getAction()
String	getTargetContainerId()
List<String>	getTargets()
String	getTriggerId()
boolean	isInternalAjaxRequest()
void	setAction(AjaxOperation.AjaxAction action)
void	setTargetContainerId(String targetContainerId)	Sets the target container id.

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxOperation

public AjaxOperation(String triggerId)

Creates an AjaxOperation for Internal AJAX Operation.

Parameters:

triggerId - the trigger id. WServlet uses this as a look-up to obtain the correct AjaxOperation.

AjaxOperation

public AjaxOperation(String triggerId,
                     String targetId)

Creates an AjaxOperation.

Parameters:

triggerId - the trigger id. WServlet uses this as a look-up to obtain the correct AjaxOperation.

targetId - the id of the target component.

AjaxOperation

public AjaxOperation(String triggerId,
                     List<String> targetIds)

Creates an AjaxOperation.

Parameters:

triggerId - the trigger id. WServlet uses this as a look-up to obtain the correct AjaxOperation.

targetIds - the ids of the target components.

Method Detail

setTargetContainerId

public void setTargetContainerId(String targetContainerId)

Sets the target container id. Allows you to replace a child component without affecting the parent. This is necessary for lazy loading components, where child content is not initially present, and can therefore not be replaced.

Parameters:

targetContainerId - the target container's id.

getTargetContainerId

public String getTargetContainerId()

Returns:

the target container's id

getTriggerId

public String getTriggerId()

Returns:

Returns the trigger id.

getTargets

public List<String> getTargets()

Returns:

Returns the target.

setAction

public void setAction(AjaxOperation.AjaxAction action)

Parameters:

action - the AJAX action

getAction

public AjaxOperation.AjaxAction getAction()

Returns:

the AJAX action

isInternalAjaxRequest

public boolean isInternalAjaxRequest()

Returns:

true if AJAX operation is an internal AJAX request