er.ajax

Class AjaxUpdateContainer

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.ajax.AjaxDynamicElement

er.ajax.AjaxUpdateContainer

All Implemented Interfaces:

IAjaxElement

Direct Known Subclasses:

MTAjaxUpdateContainer

public class AjaxUpdateContainer
extends AjaxDynamicElement

observeFieldID requires ERExtensions, specifically ERXWOForm

Bindings

Name	Description
onRefreshComplete	the script to execute at the end of refreshing the container
action	the action to call when this updateContainer refreshes
insertion	JavaScript function to evaluate when the update takes place (or effect shortcuts like "Effect.blind", or "Effect.BlindUp")
insertionDuration	the duration of the before and after insertion animation (if using insertion)
beforeInsertionDuration	the duration of the before insertion animation (if using insertion)
afterInsertionDuration	the duration of the after insertion animation (if using insertion)
asynchronous	set to false to force a synchronous refresh of the container. Defaults to true.
optional	set to true if you want the container tags to be skipped if this is already in an update container (similar to ERXOptionalForm). If optional is true and there is a container, it's as if this AUC doesn't exist, and only its children will render to the page.
frequency	the frequency (in seconds) of a periodic update
decay	a multiplier (default is one) applied to the frequency if the response of the update is unchanged
stopped	determines whether a periodic update container loads as stopped.

Nested Class Summary

Nested classes/interfaces inherited from class er.extensions.components.ERXDynamicElement

ERXDynamicElement.ContextData<T>

Field Summary

Fields inherited from class er.extensions.components.ERXDynamicElement

log

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
AjaxUpdateContainer(String name, NSDictionary<String,com.webobjects.appserver.WOAssociation> associations, com.webobjects.appserver.WOElement children)

Method Summary

Modifier and Type	Method and Description
protected String	_containerID(com.webobjects.appserver.WOContext context) Override this method and return an update container ID this element should react on.
protected void	addRequiredWebResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Adds all required resources.
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Overridden to call AjaxDynamicElement.addRequiredWebResources(WOResponse, WOContext).
NSDictionary	createAjaxOptions(com.webobjects.appserver.WOComponent component)
NSMutableDictionary	createObserveFieldOptions(com.webobjects.appserver.WOComponent component)
static String	currentUpdateContainerID()
static String	expandInsertion(String originalInsertion, String beforeDuration, String afterDuration)
static void	expandInsertionFromOptions(NSMutableDictionary<String,String> options, IAjaxElement element, com.webobjects.appserver.WOComponent component)
com.webobjects.appserver.WOActionResults	handleRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Override this method to return the response for an Ajax request.
static boolean	hasUpdateContainerID(com.webobjects.appserver.WORequest request)
com.webobjects.appserver.WOActionResults	invokeAction(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Execute the request, if it's coming from our action, then invoke the ajax handler and put the key AJAX_REQUEST_KEY in the request userInfo dictionary (request.userInfo()).
static NSDictionary	removeDefaultOptions(NSDictionary options)
static void	safeUpdateContainerWithID(String updateContainerID, com.webobjects.appserver.WOContext context) Creates or updates Ajax response so that the indicated AUC will get updated when the response is processed in the browser.
static void	setCurrentUpdateContainerID(String updateContainerID)
static void	setUpdateContainerID(com.webobjects.appserver.WORequest request, String updateContainerID)
protected boolean	shouldRenderContainer(com.webobjects.appserver.WOComponent component)
void	takeValuesFromRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context)
static String	updateContainerID(AjaxDynamicElement element, String bindingName, com.webobjects.appserver.WOComponent component)
static String	updateContainerID(AjaxDynamicElement element, com.webobjects.appserver.WOComponent component)
static String	updateContainerID(String updateContainerID)
static String	updateContainerID(com.webobjects.appserver.WORequest request)
static void	updateContainerWithID(String updateContainerID, com.webobjects.appserver.WOContext context) Creates or updates Ajax response so that the indicated AUC will get updated when the response is processed in the browser.

Methods inherited from class er.ajax.AjaxDynamicElement

addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, shouldHandleRequest

Methods inherited from class er.extensions.components.ERXDynamicElement

afterProcessing, appendTagAttributeToResponse, arrayValueForBinding, arrayValueForBinding, associations, beforeProcessing, bindingIsSettable, bindingNamed, booleanValueForBinding, booleanValueForBinding, hasBinding, id, integerValueForBinding, nameInContext, secureInContext, setValueForBinding, stringValueForBinding, stringValueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.ajax.IAjaxElement

valueForBinding, valueForBinding

Constructor Detail

AjaxUpdateContainer

public AjaxUpdateContainer(String name,
                           NSDictionary<String,com.webobjects.appserver.WOAssociation> associations,
                           com.webobjects.appserver.WOElement children)

Method Detail

addRequiredWebResources

protected void addRequiredWebResources(com.webobjects.appserver.WOResponse response,
                                       com.webobjects.appserver.WOContext context)

Adds all required resources.

Specified by:

addRequiredWebResources in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

shouldRenderContainer

protected boolean shouldRenderContainer(com.webobjects.appserver.WOComponent component)

takeValuesFromRequest

public void takeValuesFromRequest(com.webobjects.appserver.WORequest request,
                                  com.webobjects.appserver.WOContext context)

Overrides:

takeValuesFromRequest in class com.webobjects.appserver._private.WODynamicGroup

invokeAction

public com.webobjects.appserver.WOActionResults invokeAction(com.webobjects.appserver.WORequest request,
                                                             com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Execute the request, if it's coming from our action, then invoke the ajax handler and put the key AJAX_REQUEST_KEY in the request userInfo dictionary (request.userInfo()).

Overrides:

invokeAction in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

createAjaxOptions

public NSDictionary createAjaxOptions(com.webobjects.appserver.WOComponent component)

expandInsertionFromOptions

public static void expandInsertionFromOptions(NSMutableDictionary<String,String> options,
                                              IAjaxElement element,
                                              com.webobjects.appserver.WOComponent component)

expandInsertion

public static String expandInsertion(String originalInsertion,
                                     String beforeDuration,
                                     String afterDuration)

removeDefaultOptions

public static NSDictionary removeDefaultOptions(NSDictionary options)

createObserveFieldOptions

public NSMutableDictionary createObserveFieldOptions(com.webobjects.appserver.WOComponent component)

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Overridden to call AjaxDynamicElement.addRequiredWebResources(WOResponse, WOContext).

Overrides:

appendToResponse in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

handleRequest

public com.webobjects.appserver.WOActionResults handleRequest(com.webobjects.appserver.WORequest request,
                                                              com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Override this method to return the response for an Ajax request.

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

_containerID

protected String _containerID(com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Override this method and return an update container ID this element should react on.

Overrides:

_containerID in class AjaxDynamicElement

Parameters:

context - context of the transaction

Returns:

null

updateContainerID

public static String updateContainerID(com.webobjects.appserver.WORequest request)

setUpdateContainerID

public static void setUpdateContainerID(com.webobjects.appserver.WORequest request,
                                        String updateContainerID)

hasUpdateContainerID

public static boolean hasUpdateContainerID(com.webobjects.appserver.WORequest request)

currentUpdateContainerID

public static String currentUpdateContainerID()

setCurrentUpdateContainerID

public static void setCurrentUpdateContainerID(String updateContainerID)

updateContainerID

public static String updateContainerID(AjaxDynamicElement element,
                                       com.webobjects.appserver.WOComponent component)

updateContainerID

public static String updateContainerID(AjaxDynamicElement element,
                                       String bindingName,
                                       com.webobjects.appserver.WOComponent component)

updateContainerID

public static String updateContainerID(String updateContainerID)

updateContainerWithID

public static void updateContainerWithID(String updateContainerID,
                                         com.webobjects.appserver.WOContext context)

Creates or updates Ajax response so that the indicated AUC will get updated when the response is processed in the browser. Adds JavaScript like AUC.update('SomeContainerID');

Parameters:

updateContainerID - the HTML ID of the element implementing the AUC

context - WOContext for response

safeUpdateContainerWithID

public static void safeUpdateContainerWithID(String updateContainerID,
                                             com.webobjects.appserver.WOContext context)

Creates or updates Ajax response so that the indicated AUC will get updated when the response is processed in the browser. If the container element does not exist, does nothing. Adds JavaScript like if ( $('SomeContainerID') != null ) AUC.update('SomeContainerID');

Parameters:

updateContainerID - the HTML ID of the element implementing the AUC

context - WOContext for response