er.ajax

Class AjaxExpansion

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxComponent

er.ajax.AjaxExpansion

All Implemented Interfaces:

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

Direct Known Subclasses:

MTAjaxExpansion

public class AjaxExpansion
extends AjaxComponent

AjaxExpansion provides an easy way to make expansion areas that appear and disappear by clicking a link. (For instance, expandable options areas). The simple implementation of an expansion area would include wrapping the toggle link in the AjaxUpdateContainer. The problem with this approach is that if you want to animate the appearance of the contents, the animation affects the link as well as the contents. AjaxExpansion instead only updates the contents, and applies an "expanded" class to the link, which you can use to change the expansion icon in a stylesheet. (See AjaxExample2's ToggleDetails example).

You can use an openedLabel and closedLabel binding to change the link text. Or, if you want to use something fancier than a string as link label, you can put an ERXWOTemplate with templateName='label' inside the component. If present, that will replace the label provided by the string binding.

Example

 <wo:AjaxExpansion id="contact" class="contact" insertion="Effect.blind"
                   insertionDuration="0.1" string="Contact" action="$hitMe">
   <dl>
     <dt>Phone</dt>
     <dd>804.555.1212</dd>
     <dt>Address</dt>
     <dd>
       123 Somewhere Rd.<br />
       Richmond, VA 23233 
     </dd>
   </dl>
 </wo:AjaxExpansion>
 

See Also:

Serialized Form

Author:

mschrag

Bindings

Name	Description
id	the id of the contents div
linkID	the id of the toggle link (defaults to "[id]Link")
class	the class of the contents div
linkClass	the class of the toggle link (always gets "expansion" added, and "expanded" when opened)
expanded	optionally allows controlling the expansion state of the contents
initiallyExpanded	optionally allows controlling the initial expansion state when the "expanded" binding is not used
string	the string displayed for the link. For something fancier than a plain string, see above.
openedLabel	the string to display when expanded. An alternative to the string binding.
closedLabel	the string to display when not expanded. An alternative to the string binding.
insertion	the insertion effect (see AjaxUpdateLink)
insertionDuration	the insertion effect duration (see AjaxUpdateLink)
action	the action to fire when the hyperlink is clicked (that is, on expansion and contraction)
onLoading	JavaScript function to evaluate when the update request begins
onComplete	JavaScript function to evaluate when the update request has finished
onSuccess	JavaScript function to evaluate when the update request was successful
onFailure	JavaScript function to evaluate when the update request has failed
onException	JavaScript function to evaluate when the update request had errors
accesskey	hot key that should toggle the expansion (optional)
onExpansionComplete	value for the AjaxUpdateContainer onRefreshComplete binding when the contents are expanded

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
AjaxExpansion(WOContext context) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addRequiredWebResources(WOResponse response) Adds required resources for this component.
WOActionResults	handleRequest(WORequest request, WOContext context) Returns null.
String	id() Returns ID for AjaxUpdateContainer.
boolean	isAjaxRequest() Is this request an Ajax request?
boolean	isExpanded() Is the component currently expanded?
String	jsEscapedString() Returns an escaped version of string() using ERXStringUtilities.escapeJavascriptApostrophes(String).
String	linkClass() Returns CSS class attribute value applied to the AjaxUpdateLink, and the corresponding HTML hyperlink element.
String	linkID() Returns ID for AjaxUpdateLink.
String	onExpansionComplete() Returns value of onExpansionComplete binding, or null if the component is not currently expanded.
void	setExpanded(boolean expanded) Sets the current expansion state of the component to expanded.
String	string() Returns the label to render for the hyperlink, based on the string or openedLabel and closedLabel bindings.
boolean	synchronizesVariablesWithBindings()
WOActionResults	toggle() Toggles the current state of the component.

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

AjaxExpansion

public AjaxExpansion(WOContext context)

Constructor

Parameters:

context - a WOContext

Method Detail

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class WOComponent

linkID

public String linkID()

Returns ID for AjaxUpdateLink.

Returns:

value of linkID binding if set, otherwise value of id() with "Link" appended

linkClass

public String linkClass()

Returns CSS class attribute value applied to the AjaxUpdateLink, and the corresponding HTML hyperlink element.

Returns:

CSS class

id

public String id()

Returns ID for AjaxUpdateContainer.

Returns:

ID value

string

public String string()

Returns the label to render for the hyperlink, based on the string or openedLabel and closedLabel bindings.

Returns:

label to render for the hyperlink

isAjaxRequest

public boolean isAjaxRequest()

Is this request an Ajax request?

Returns:

true if this request is an Ajax request, otherwise false

jsEscapedString

public String jsEscapedString()

Returns an escaped version of string() using ERXStringUtilities.escapeJavascriptApostrophes(String).

Returns:

escaped string

addRequiredWebResources

protected void addRequiredWebResources(WOResponse response)

Adds required resources for this component.

Specified by:

addRequiredWebResources in class AjaxComponent

Parameters:

response - the response to write to

handleRequest

public WOActionResults handleRequest(WORequest request,
                                     WOContext context)

Returns null.

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxComponent

Parameters:

request - the request

context - the context

Returns:

null

isExpanded

public boolean isExpanded()

Is the component currently expanded?

Returns:

true if the component is currently expanded, otherwise false

setExpanded

public void setExpanded(boolean expanded)

Sets the current expansion state of the component to expanded.

Parameters:

expanded - desired current expansion state

toggle

public WOActionResults toggle()

Toggles the current state of the component.

Returns:

null

onExpansionComplete

public String onExpansionComplete()

Returns value of onExpansionComplete binding, or null if the component is not currently expanded.

Returns:

value of onExpansionComplete binding, or null