er.ajax

Class AjaxDynamicElement

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.ajax.AjaxDynamicElement

All Implemented Interfaces:

IAjaxElement

Direct Known Subclasses:

AjaxBehaviour, AjaxHyperlink, AjaxIncludeScript, AjaxInPlaceEditor, AjaxModalContainer, AjaxObserveField, AjaxRemoteLogging, AjaxRoundEffect, AjaxSessionPing, AjaxSubmitButton, AjaxTabbedPanel, AjaxTabbedPanelTab, AjaxTextHinter, AjaxUpdateContainer, AjaxUpdateLink, CCGoogleMap, CCGoogleMapMarker, CCRating, CCTagEditor, MTAjaxModalContainer, MTAjaxObserveField, MTAjaxSubmitButton, MTAjaxTabbedPanel, MTAjaxTabbedPanelTab, MTJSSlider, MTMediaBox

public abstract class AjaxDynamicElement
extends ERXDynamicElement
implements IAjaxElement

AjaxDynamicElement provides a common base class for dynamic Ajax elements.

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
AjaxDynamicElement(String name, NSDictionary<String,WOAssociation> associations, NSMutableArray<WOElement> children)
AjaxDynamicElement(String name, NSDictionary<String,WOAssociation> associations, WOElement template)

Method Summary

Modifier and Type	Method and Description
protected String	_containerID(WOContext context) Override this method and return an update container ID this element should react on.
protected abstract void	addRequiredWebResources(WOResponse response, WOContext context) Override this method to append the needed scripts for this component.
protected void	addScriptResourceInHead(WOContext context, WOResponse response, String fileName) Adds a script link tag with a correct resource URL in the HTML head tag if it isn't already present in the response.
protected void	addScriptResourceInHead(WOContext context, WOResponse response, String framework, String fileName) Adds a script link tag with a correct resource URL in the HTML head tag if it isn't already present in the response.
protected void	addStylesheetResourceInHead(WOContext context, WOResponse response, String fileName) Adds a stylesheet link tag with a correct resource URL in the HTML head tag if it isn't already present in the response.
protected void	addStylesheetResourceInHead(WOContext context, WOResponse response, String framework, String fileName) Adds a stylesheet link tag with a correct resource URL in the HTML head tag if it isn't already present in the response.
void	appendToResponse(WOResponse response, WOContext context) Overridden to call addRequiredWebResources(WOResponse, WOContext).
abstract WOActionResults	handleRequest(WORequest request, WOContext context) Override this method to return the response for an Ajax request.
WOActionResults	invokeAction(WORequest request, WOContext context) 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()).
protected boolean	shouldHandleRequest(WORequest request, WOContext context) Checks if the current request should be handled by this element.

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

AjaxDynamicElement

public AjaxDynamicElement(String name,
                          NSDictionary<String,WOAssociation> associations,
                          WOElement template)

AjaxDynamicElement

public AjaxDynamicElement(String name,
                          NSDictionary<String,WOAssociation> associations,
                          NSMutableArray<WOElement> children)

Method Detail

invokeAction

public WOActionResults invokeAction(WORequest request,
                                    WOContext context)

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 com.webobjects.appserver._private.WODynamicGroup

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

_containerID

protected String _containerID(WOContext context)

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

Parameters:

context - context of the transaction

Returns:

null

shouldHandleRequest

protected boolean shouldHandleRequest(WORequest request,
                                      WOContext context)

Checks if the current request should be handled by this element.

Parameters:

request - the current request

context - context of the transaction

Returns:

true if we should handle the request

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Overridden to call addRequiredWebResources(WOResponse, WOContext).

Overrides:

appendToResponse in class com.webobjects.appserver._private.WODynamicGroup

Parameters:

response - the current response

context - context of the transaction

addRequiredWebResources

protected abstract void addRequiredWebResources(WOResponse response,
                                                WOContext context)

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

Parameters:

response - the current response

context - context of the transaction

handleRequest

public abstract WOActionResults handleRequest(WORequest request,
                                              WOContext context)

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

Specified by:

handleRequest in interface IAjaxElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

addScriptResourceInHead

protected void addScriptResourceInHead(WOContext context,
                                       WOResponse response,
                                       String framework,
                                       String fileName)

Adds a script link tag with a correct resource URL in the HTML head tag if it isn't already present in the response.

Parameters:

context - context of the transaction

response - the current response

framework - name of the framework that contains the file

fileName - script file name

addScriptResourceInHead

protected void addScriptResourceInHead(WOContext context,
                                       WOResponse response,
                                       String fileName)

Adds a script link tag with a correct resource URL in the HTML head tag if it isn't already present in the response. The script file will be searched within the Ajax framework.

Parameters:

context - context of the transaction

response - the current response

fileName - script file name

addStylesheetResourceInHead

protected void addStylesheetResourceInHead(WOContext context,
                                           WOResponse response,
                                           String framework,
                                           String fileName)

Adds a stylesheet link tag with a correct resource URL in the HTML head tag if it isn't already present in the response.

Parameters:

context - context of the transaction

response - the current response

framework - name of the framework that contains the file

fileName - CSS file name

addStylesheetResourceInHead

protected void addStylesheetResourceInHead(WOContext context,
                                           WOResponse response,
                                           String fileName)

Adds a stylesheet link tag with a correct resource URL in the HTML head tag if it isn't already present in the response. The CSS file will be searched within the Ajax framework.

Parameters:

context - context of the transaction

response - the current response

fileName - CSS file name