er.ajax

Class AjaxBusySpinner

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxComponent

er.ajax.AjaxBusySpinner

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, IAjaxElement, Serializable, Cloneable

public class AjaxBusySpinner
extends AjaxComponent

AjaxBusySpinner provides various ways of performing operations when an Ajax request is in process. It uses http://fgnass.github.com/spin.js to render the spinner, and can be configured to the desired style using the optional bindings

See Also:

Serialized Form

Author:

qdolan

Bindings

Name	Description
busyClass	(optional) the CSS class to apply to the updating element during the request
divID	(optional) the id of the div to show and hide during the request
onCreate	(optional) the function to execute when the request starts
onComplete	(optional) the function to execute when the request ends
watchContainerID	(optional) if set, the other bindings will only apply when this container ID is being updated, which provides for per-element busy controls
id	(optional) if bound, you can provide a custom style for the generated busy image div
class	(optional) if bound, you can provide a custom style for the generated busy image div
style	(optional) if bound, you can provide a custom style for the generated busy image div
lines	(optional) number of lines to draw
length	(optional) length of each line
width	(optional) line thickness
radius	(optional) radius of the inner circle
color	(optional) #rgb or #rrggbb
speed	(optional) rounds per second
trail	(optional) afterglow percentage
shadow	(optional) whether to render a shadow
spinOpts	(optional) json style list of spinner options (explicit binding values take precedence)

Properties

Name	Description
er.extensions.ERXResponseRewriter.resource.Ajax.spin.js=Ajax.spin.min.js	replaces the normal spin.js file with the minified version

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
AjaxBusySpinner(WOContext context)

Method Summary

Modifier and Type	Method and Description
protected void	addRequiredWebResources(WOResponse res) Override this method to append the needed scripts for this component.
boolean	customStyle()
String	divID()
WOActionResults	handleRequest(WORequest request, WOContext context) Override this method to return the response for an Ajax request.
boolean	isStateless()
String	onComplete()
String	onCreate()
String	spinOpts()
String	style()

Methods inherited from class er.ajax.AjaxComponent

_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, appendTagAttributeToResponse, appendToResponse, booleanValueForBinding, invokeAction, safeElementID, shouldHandleRequest, valueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxBusySpinner

public AjaxBusySpinner(WOContext context)

Method Detail

isStateless

public boolean isStateless()

Overrides:

isStateless in class WOComponent

addRequiredWebResources

protected void addRequiredWebResources(WOResponse res)

Description copied from class: AjaxComponent

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

Specified by:

addRequiredWebResources in class AjaxComponent

Parameters:

res - the response to write to

customStyle

public boolean customStyle()

style

public String style()

divID

public String divID()

onCreate

public String onCreate()

onComplete

public String onComplete()

spinOpts

public String spinOpts()
                throws org.json.JSONException

Throws:

org.json.JSONException

handleRequest

public WOActionResults handleRequest(WORequest request,
                                     WOContext context)

Description copied from class: AjaxComponent

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

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxComponent

Parameters:

request - the request

context - the context