er.ajax.mootools

Class MTAjaxObserveField

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.mootools.MTAjaxObserveField

All Implemented Interfaces:

IAjaxElement

public class MTAjaxObserveField
extends AjaxDynamicElement

AjaxObserveField allows you to perform an Ajax submit (and optional update) based on the state of a form field changing. If you specify an observeFieldID, that single field will be observed for changes. If you also specify an updateContainerID, the given container will be refreshed after the field changes. If you do NOT specify an observeFieldID, all of the form fields contained within this component will be observed for changes instead. The list of form fields to observe is obtained on the client side, so you should not put AjaxUpdateContainers INSIDE of this component or any fields inside of the container will no be observed after an update. Instead, AjaxObserveFields should be surrounded by a container. If you leave of observeFieldID, AjaxObserveField must generate an HTML container, so that it can find the form fields that correspond to this component from the client side.

Bindings

Name	Description
id	the ID of the observe field container (only useful if you leave off observeFieldID).
elementName	element to use for the observe field container. Defaults to div. (Only used if you leave off observeFieldID)
observeFieldID	the ID of the field to observe
updateContainerID	the ID of the container to update. Specify "_parent" to use the nearest one.
action	the action to call when the observer fires
onBeforeSubmit	called prior to submitting the observed content; return false to deny the submit
observeFieldFrequency	the polling observe frequency (in seconds)
observeDelay	the minimum time between submits (in seconds)
fullSubmit	When false, only the value of the field that changed is sent to the server (partial submit), when true, the whole form is sent. Defaults to false. Caution: Partial submit doesn't work correctly if you manually set the name on your inputs.
class	CSS class to use on the container. (Only used if you leave off observeFieldID)
style	CSS style to use on the container. (Only used if you leave off observeFieldID)
onCreate	Takes a JavaScript function which is called after the form has been serialized, but befor the Ajax request is sent to the server. Useful e.g. if you want to disable the form while the ajax request is running.

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
MTAjaxObserveField(String name, NSDictionary<String,com.webobjects.appserver.WOAssociation> associations, com.webobjects.appserver.WOElement children)

Method Summary

Modifier and Type	Method and Description
protected void	addRequiredWebResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Override this method to append the needed scripts for this component.
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Overridden to call AjaxDynamicElement.addRequiredWebResources(WOResponse, WOContext).
static void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context, AjaxDynamicElement element, String observeFieldID, boolean observeDescendentFields, String updateContainerID, boolean fullSubmit, NSMutableDictionary options)
NSMutableDictionary	createAjaxOptions(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.
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 String	nameInContext(com.webobjects.appserver.WOContext context, com.webobjects.appserver.WOComponent component, AjaxDynamicElement element)

Methods inherited from class er.ajax.AjaxDynamicElement

_containerID, 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, takeValuesFromRequest, 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

MTAjaxObserveField

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

Method Detail

createAjaxOptions

public NSMutableDictionary createAjaxOptions(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

appendToResponse

public static void appendToResponse(com.webobjects.appserver.WOResponse response,
                                    com.webobjects.appserver.WOContext context,
                                    AjaxDynamicElement element,
                                    String observeFieldID,
                                    boolean observeDescendentFields,
                                    String updateContainerID,
                                    boolean fullSubmit,
                                    NSMutableDictionary options)

addRequiredWebResources

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

Description copied from class: AjaxDynamicElement

Override this method to append the needed scripts for this component.

Specified by:

addRequiredWebResources in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

nameInContext

public static String nameInContext(com.webobjects.appserver.WOContext context,
                                   com.webobjects.appserver.WOComponent component,
                                   AjaxDynamicElement element)

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

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