er.ajax

Class AjaxModalContainer

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

All Implemented Interfaces:

IAjaxElement

public class AjaxModalContainer
extends AjaxDynamicElement

Shows a link and wraps an area that is later presented as a modal window. Alternately, when you bind action then the content is used as the link.

Author:

timo, ak

Bindings

Name	Description
label	label for the link
class	class for the link
style	style for the link
value	value for the link (??)
id	id for the link
containerID	container ID for non-Ajax WOComponentContent
closeLabel	string for the close link
title	title string for the link label and the window
href	when it is bound, the content of the url will be fetched into an iframe.
directActionName	the direct action to fetch
action	when it is bound, the content of the url will be fetched into a div
ajax	(optional) when true, the contents are only rendered during the Ajax request, using ajax=true is the preferred way to use this
open	if true, the container is rendered already opened (currently only workings, i think, with ajax=true)
locked	if true, the container will be "locked" and will not close unless you explicitly close it
secure	(only applicable for directAtionName) if true, the generated url will be https
skin	the name of the skin to use (lightbox or darkbox right now) If your content changes height and you want to autosize your iBox, you can add <script>iBox.contentChanged()</script> into your AjaxUpdateContainer to trigger an iBox resize.

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

Method Summary

Modifier and Type	Method and Description
protected String	_containerID(com.webobjects.appserver.WOContext context) Override this method and return an update container ID this element should react on.
protected void	addRequiredWebResources(com.webobjects.appserver.WOResponse response, 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).
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()).
boolean	shouldHandle(com.webobjects.appserver.WOContext context)

Methods inherited from class er.ajax.AjaxDynamicElement

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

Constructor Detail

AjaxModalContainer

public AjaxModalContainer(String name,
                          NSDictionary associations,
                          com.webobjects.appserver.WOElement children)

Method Detail

shouldHandle

public boolean shouldHandle(com.webobjects.appserver.WOContext context)

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

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

response - the current response

context - context of the transaction

_containerID

protected String _containerID(com.webobjects.appserver.WOContext context)

Description copied from class: AjaxDynamicElement

Override this method and return an update container ID this element should react on.

Overrides:

_containerID in class AjaxDynamicElement

Parameters:

context - context of the transaction

Returns:

null

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