er.ajax

Class AjaxSubmitButton

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

All Implemented Interfaces:

IAjaxElement

Direct Known Subclasses:

AjaxDefaultSubmitButton

public class AjaxSubmitButton
extends AjaxDynamicElement

AjaxSubmitButton behaves just like a WOSubmitButton except that it submits in the background with an Ajax.Request.

Author:

anjo

Bindings

Name	Description
name	the HTML name of this submit button (optional)
value	the HTML value of this submit button (optional)
action	the action to execute when this button is pressed
id	the HTML ID of this submit button
class	the HTML class of this submit button
style	the HTML style of this submit button
tabindex	tab index of this submit button
title	the HTML title of this submit button
onClick	arbitrary Javascript to execute when the client clicks the button
onClickBefore	if the given function returns true, the onClick is executed. This is to support confirm(..) dialogs.
onClickServer	if the action defined in the action binding returns null, the value of this binding will be returned as javascript from the server
onComplete	JavaScript function to evaluate when the request has finished.
onSuccess	javascript to execute in response to the Ajax onSuccess event
onFailure	javascript to execute in response to the Ajax onFailure event
onLoading	javascript to execute when loading
evalScripts	evaluate scripts on the result
button	if false, it will display a link
useButtonTag	generate button tag even if the property er.extensions.foundation.ERXPatcher.DynamicElementsPatches.SubmitButton.useButtonTag is false (defaults to "false")
formName	if button is false, you must specify the name of the form to submit
functionName	if set, the link becomes a javascript function instead
updateContainerID	the id of the AjaxUpdateContainer to update after performing this action
replaceID	the ID of the div (or other html element) whose contents will be replaced with the results of this action
showUI	if functionName is set, the UI defaults to hidden; showUI re-enables it
formSerializer	the name of the javascript function to call to serialize the form
elementName	the element name to use (defaults to "a")
asynchronous	boolean defining if the request is sent asynchronously or synchronously, defaults to true
accesskey	hot key that should trigger the button (optional)
disabled	if true, the button will be disabled (defaults to false) // PROTOTYPE EFFECTS
effect	synonym of afterEffect except it always applies to updateContainerID
effectDuration	synonym of afterEffectDuration except it always applies to updateContainerID // PROTOTYPE EFFECTS
beforeEffect	the Scriptaculous effect to apply onSuccess ("highlight", "slideIn", "blindDown", etc);
beforeEffectID	the ID of the container to apply the "before" effect to (blank = try nearest container, then try updateContainerID)
beforeEffectDuration	the duration of the effect to apply before // PROTOTYPE EFFECTS
afterEffect	the Scriptaculous effect to apply onSuccess ("highlight", "slideIn", "blindDown", etc);
afterEffectID	the ID of the container to apply the "after" effect to (blank = try nearest container, then try updateContainerID)
afterEffectDuration	the duration of the effect to apply after // PROTOTYPE EFFECTS
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)

Properties

Name	Description
er.ajax.formSerializer	the default form serializer to use for all ajax submits
er.extensions.foundation.ERXPatcher.DynamicElementsPatches.SubmitButton.useButtonTag	er.extensions.foundation.ERXPatcher.DynamicElementsPatches.SubmitButton.useButtonTag

Nested Class Summary

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

ERXDynamicElement.ContextData<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AJAX_SUBMIT_BUTTON_NAME
static String	KEY_PARTIAL_FORM_SENDER_ID

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
AjaxSubmitButton(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 res, 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).
NSMutableDictionary	createAjaxOptions(com.webobjects.appserver.WOComponent component)
boolean	disabledInComponent(com.webobjects.appserver.WOComponent component)
static void	fillInAjaxOptions(IAjaxElement element, com.webobjects.appserver.WOComponent component, String submitButtonName, NSMutableDictionary options)
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 worequest, com.webobjects.appserver.WOContext wocontext) 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 boolean	isAjaxSubmit(com.webobjects.appserver.WORequest request)
String	nameInContext(com.webobjects.appserver.WOContext context, com.webobjects.appserver.WOComponent component)

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

Field Detail

KEY_AJAX_SUBMIT_BUTTON_NAME

public static final String KEY_AJAX_SUBMIT_BUTTON_NAME

See Also:

Constant Field Values

KEY_PARTIAL_FORM_SENDER_ID

public static final String KEY_PARTIAL_FORM_SENDER_ID

See Also:

Constant Field Values

Constructor Detail

AjaxSubmitButton

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

Method Detail

isAjaxSubmit

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

disabledInComponent

public boolean disabledInComponent(com.webobjects.appserver.WOComponent component)

nameInContext

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

createAjaxOptions

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

fillInAjaxOptions

public static void fillInAjaxOptions(IAjaxElement element,
                                     com.webobjects.appserver.WOComponent component,
                                     String submitButtonName,
                                     NSMutableDictionary options)

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

addRequiredWebResources

protected void addRequiredWebResources(com.webobjects.appserver.WOResponse res,
                                       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:

res - the current response

context - context of the transaction

invokeAction

public com.webobjects.appserver.WOActionResults invokeAction(com.webobjects.appserver.WORequest worequest,
                                                             com.webobjects.appserver.WOContext wocontext)

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:

worequest - the current request

wocontext - 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