er.ajax

Class AjaxSortableList

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxComponent

er.ajax.AjaxSortableList

All Implemented Interfaces:

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

public class AjaxSortableList
extends AjaxComponent

See Also:

Serialized Form

Author:

mschrag

Bindings

Name	Description
list	the list to allow reordering on (required)
item	the repetition item (required)
listItemIDKeyPath	the key path of the id of each item (required)
id	the id of the list (required)
listElementName	the HTML element name of the list (defaults to 'ul')
listItemElementName	the HTML element name of the list item (defaults to 'li')
listClass	the CSS class of the list
listStyle	the CSS style attribute of the list
listItemClass	the CSS class of the current list item
listItemStyle	the CSS style attribute of the current list item
startIndex	the start index of the list
action	the action to fire when the list is reordered
tag	tag
only	only
overlap	overlap
constraint	how to constraint moving elements, can take a value of vertical, horizontal or false with vertical as default
containment	containment
handle	if an element should only be draggable by an embedded handle, takes a class name
hoverclass	hoverclass
ghosting	shows ghosting copy during drag, defaults to false
movingClass	a CSS class assigned to the element when it is moving.
starteffect	Effect, defaults to Effect.Opacity. Defines the effect to use when the draggable starts being dragged
reverteffect	Effect, default to Effect.Move. Defines the effect to use when the draggable reverts back to its starting position
endeffect	Effect, defaults to Effect.Opacity. Defines the effect to use when the draggable stops being dragged
dropOnEmpty	dropOnEmpty
scroll	scroll
onChange	client side method, fires on updating the sort order during drag
onUpdate	client side method, fires on updating the sort order after dropping the element and order really changed
index	the repetition index

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
AjaxSortableList(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.
void	appendToResponse(WOResponse response, WOContext context) Overridden to call AjaxComponent.addRequiredWebResources(WOResponse).
NSDictionary<String,String>	createAjaxOptions()
WOActionResults	handleRequest(WORequest request, WOContext context) Override this method to return the response for an Ajax request.
String	id()
String	listElementName()
String	listItemElementName()
String	listItemID()
String	listItemID(String itemID)
String	onUpdate()
boolean	synchronizesVariablesWithBindings()

Methods inherited from class er.ajax.AjaxComponent

_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, appendTagAttributeToResponse, 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, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, 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

AjaxSortableList

public AjaxSortableList(WOContext context)

Method Detail

id

public String id()

listElementName

public String listElementName()

listItemElementName

public String listItemElementName()

listItemID

public String listItemID(String itemID)

listItemID

public String listItemID()

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class WOComponent

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Description copied from class: AjaxComponent

Overridden to call AjaxComponent.addRequiredWebResources(WOResponse).

Overrides:

appendToResponse in class AjaxComponent

Parameters:

response - the HTTP response that an application returns to a Web server to complete a cycle of the request-response loop

context - context of a transaction

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

createAjaxOptions

public NSDictionary<String,String> createAjaxOptions()

onUpdate

public String onUpdate()

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