er.ajax.mootools

Class MTAjaxUpdateLink

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.AjaxUpdateLink

er.ajax.mootools.MTAjaxUpdateLink

All Implemented Interfaces:

IAjaxElement

public class MTAjaxUpdateLink
extends AjaxUpdateLink

Updates a region on the screen by creating a request to an action, then returning a script that in turn creates an Ajax.Updater for the area. If you do not provide an action binding, it will just update the specified area.

Bindings

Name	Description
action	the action to call when the link executes
directActionName	the direct action to call when link executes
updateContainerID	the id of the AjaxUpdateContainer to update after performing this action
title	title of the link
style	css style of the link
class	css class of the link
id	of the link
disabled	boolean defining if the link renders the tag
string	string to get preprended to the contained elements
function	a custom function to call that takes a single parameter that is the action url
elementName	the element name to use (defaults to "a")
functionName	if set, the link becomes a javascript function
button	if true, this is rendered as a javascript button
async	boolean defining if the update request is sent asynchronously or synchronously, defaults to true
accesskey	hot key that should trigger the link (optional)
onCancel	Fired when a request has been cancelled.
onClickBefore	if the given function returns true, the onClick is executed. This is to support confirm(..) dialogs.
onClick	JS function, called after the click on the client
onComplete	Fired when the Request is completed.
onException	Fired when setting a request header fails.
onFailure	Fired when the request failed (error status code).
onRequest	Fired when the Request is sent.
onSuccess(responseTree,	responseElements, responseHTML, responseJavaScript) Fired when the Request is completed successfully.
useSpinner	(boolean) use the Spinner class with this request
defaultSpinnerClass	inclue the default spinner css class in the headers - if false provide your own.
spinnerOptions	- (object) the options object for the Spinner class
spinnerTarget	- (mixed) a string of the id for an Element or an Element reference to use instead of the one specifed in the update option. This is useful if you want to overlay a different area (or, say, the parent of the one being updated).

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

Method Summary

Modifier and Type	Method and Description
static void	addEffect(NSMutableDictionary options, String effect, String updateContainerID, String effectProperty, String effectStart, String duration, String mode)
void	addRequiredWebResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Override this method to append the needed scripts for this component.
protected NSMutableDictionary<String,String>	createAjaxOptions(com.webobjects.appserver.WOComponent component)
String	onClick(com.webobjects.appserver.WOContext context, boolean generateFunctionWrapper)

Methods inherited from class er.ajax.AjaxUpdateLink

addEffect, appendToResponse, fullEffectName, handleRequest

Methods inherited from class er.ajax.AjaxDynamicElement

_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, invokeAction, 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

MTAjaxUpdateLink

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

Method Detail

createAjaxOptions

protected NSMutableDictionary<String,String> createAjaxOptions(com.webobjects.appserver.WOComponent component)

Overrides:

createAjaxOptions in class AjaxUpdateLink

addRequiredWebResources

public 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.

Overrides:

addRequiredWebResources in class AjaxUpdateLink

Parameters:

response - the current response

context - context of the transaction

onClick

public String onClick(com.webobjects.appserver.WOContext context,
                      boolean generateFunctionWrapper)

Overrides:

onClick in class AjaxUpdateLink

addEffect

public static void addEffect(NSMutableDictionary options,
                             String effect,
                             String updateContainerID,
                             String effectProperty,
                             String effectStart,
                             String duration,
                             String mode)