AjaxComponent Class Reference

Inherits com::webobjects::appserver::WOComponent, and er::ajax::IAjaxElement.

Inherited by AjaxAccordion, AjaxAutoComplete, AjaxBusyIndicator, AjaxDatePicker, AjaxDraggable, AjaxDragResize, AjaxDragResizeContainer, AjaxDroppable, AjaxExpansion, AjaxGMap, AjaxModalDialog, AjaxModalDialogOpener, AjaxProxy, AjaxSelectionList, AjaxSlider, and AjaxSortableList.

Collaboration diagram for AjaxComponent:

[legend]

List of all members.

Public Member Functions
	AjaxComponent (WOContext context)
void	appendTagAttributeToResponse (WOResponse response, String name, Object object)
void	appendToResponse (WOResponse res, WOContext ctx)
boolean	booleanValueForBinding (String name, boolean defaultValue)
abstract WOActionResults	handleRequest (WORequest request, WOContext context)
WOActionResults	invokeAction (WORequest request, WOContext context)
String	safeElementID ()
Object	valueForBinding (String name, Object defaultValue, WOComponent component)
Object	valueForBinding (String name, WOComponent component)
Object	valueForBinding (String name, Object defaultValue)
Protected Member Functions
String	_containerID (WOContext context)
abstract void	addRequiredWebResources (WOResponse res)
void	addScriptResourceInHead (WOResponse _response, String _framework, String _fileName)
void	addScriptResourceInHead (WOResponse _response, String _fileName)
void	addStylesheetResourceInHead (WOResponse _response, String _framework, String _fileName)
void	addStylesheetResourceInHead (WOResponse _response, String _fileName)
boolean	shouldHandleRequest (WORequest request, WOContext context)

---

Detailed Description

This abstract (by design) superclass component isolate general utility methods.

Author:

Jean-Francois Veillette <jean.francois.veillette@gmail.com>

Version:

$Revision $, $Date $
© 2006 OS communications informatiques, inc. http://www.os.ca Tous droits réservés.

---

Constructor & Destructor Documentation

AjaxComponent

(

WOContext

context

)

---

Member Function Documentation

String _containerID

(

WOContext

context

)

[protected]

Returns the ID that represents this container for the purposes of Ajax updates. In common cases, this corresponds to your updateContainerID.

Parameters:

context

the current context

Returns:

your container ID

Reimplemented in AjaxModalDialog.

abstract void addRequiredWebResources

(

WOResponse

res

)

[protected, pure virtual]

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

Parameters:

res

Implemented in AjaxAccordion, AjaxAutoComplete, AjaxBusyIndicator, AjaxDatePicker, AjaxDraggable, AjaxDragResize, AjaxDragResizeContainer, AjaxDroppable, AjaxExpansion, AjaxGMap, AjaxModalDialog, AjaxModalDialogOpener, AjaxProxy, AjaxSelectionList, AjaxSlider, AjaxSortableList, and Accordion.

void addScriptResourceInHead	(	WOResponse	_response,
		String	_framework,
		String	_fileName
	)			[protected]

void addScriptResourceInHead	(	WOResponse	_response,
		String	_fileName
	)			[protected]

void addStylesheetResourceInHead	(	WOResponse	_response,
		String	_framework,
		String	_fileName
	)			[protected]

void addStylesheetResourceInHead	(	WOResponse	_response,
		String	_fileName
	)			[protected]

void appendTagAttributeToResponse	(	WOResponse	response,
		String	name,
		Object	object
	)

void appendToResponse	(	WOResponse	res,
		WOContext	ctx
	)

Overridden to call addRequiredWebResources(WOResponse).

Reimplemented in AjaxAccordion, AjaxAutoComplete, AjaxDatePicker, AjaxDraggable, AjaxDragResize, AjaxDragResizeContainer, AjaxDroppable, AjaxModalDialog, AjaxModalDialogOpener, AjaxSlider, and AjaxSortableList.

boolean booleanValueForBinding	(	String	name,
		boolean	defaultValue
	)

Utility to get the boolean value of a binding or a default value if none is supplied. Handles non-boolean bindings Numbers, NSArray, String, NSKeyValueCoding.

Parameters:

	name	name of the binding
	defaultValue	value to return if unbound

Returns:

value for binding or defaultValue value if unbound

abstract WOActionResults handleRequest	(	WORequest	request,
		WOContext	context
	)			[pure virtual]

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

Parameters:

	request
	context

Implements IAjaxElement.

Implemented in AjaxAccordion, AjaxAutoComplete, AjaxBusyIndicator, AjaxDatePicker, AjaxDraggable, AjaxDragResize, AjaxDragResizeContainer, AjaxDroppable, AjaxExpansion, AjaxGMap, AjaxModalDialog, AjaxModalDialogOpener, AjaxProxy, AjaxSelectionList, AjaxSlider, and AjaxSortableList.

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()).

Reimplemented in AjaxModalDialog.

String safeElementID

(

)

boolean shouldHandleRequest	(	WORequest	request,
		WOContext	context
	)			[protected]

Reimplemented in AjaxModalDialog.

Object valueForBinding	(	String	name,
		Object	defaultValue,
		WOComponent	component
	)

Implements IAjaxElement.

Object valueForBinding	(	String	name,
		WOComponent	component
	)

Implements IAjaxElement.

Object valueForBinding	(	String	name,
		Object	defaultValue
	)

Utility to get the value of a binding or a default value if none is supplied.

Parameters:

	name	name of the binding
	defaultValue	value to return if unbound

Returns:

value for binding or defaultValue value if unbound

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxComponent.java