AjaxUpdateLink Class Reference

Collaboration diagram for AjaxUpdateLink:

List of all members.

Public Member Functions

AjaxUpdateLink (String name, NSDictionary associations, WOElement children)

void appendToResponse (WOResponse response, WOContext context)

WOActionResults handleRequest (WORequest request, WOContext context)

String onClick (WOContext context, boolean generateFunctionWrapper)

Static Public Member Functions

static void addEffect (NSMutableDictionary options, String effect, String updateContainerID, String duration)

static String fullEffectName (String effectName)

Protected Member Functions

void addRequiredWebResources (WOResponse res, WOContext context)

NSMutableDictionary createAjaxOptions (WOComponent component)

Detailed Description

Updates a region on the screen by creating a request to an action, then returning a script that in turn creates an Ajax.Updater for the area. If you do not provide an action binding, it will just update the specified area.

action the action to call when the link executes directActionName the direct action to call when link executes onLoading JavaScript function to evaluate when the request begins onComplete JavaScript function to evaluate when the request has finished. onSuccess JavaScript function to evaluate when the request was successful. onFailure JavaScript function to evaluate when the request has failed. onException JavaScript function to evaluate when the request had errors. evalScripts boolean defining if the container update is expected to be a script. ignoreActionResponse boolean defining if the action's response should be thrown away (useful when the same action has both Ajax and plain links) onClickBefore if the given function returns true, the onClick is executed. This is to support confirm(..) dialogs. onClick JS function, called after the click on the client onClickServer JS returned from the server after the update updateContainerID the id of the AjaxUpdateContainer to update after performing this action replaceID the ID of the div (or other html element) whose contents will be replaced with the results of this action title title of the link style css style of the link class css class of the link id id of the link disabled boolean defining if the link renders the tag string string to get preprended to the contained elements function a custom function to call that takes a single parameter that is the action url elementName the element name to use (defaults to "a") functionName if set, the link becomes a javascript function button if true, this is rendered as a javascript button asynchronous boolean defining if the update request is sent asynchronously or synchronously, defaults to true accesskey hot key that should trigger the link (optional)

// PROTOTYPE EFFECTS effect synonym of afterEffect except it always applies to updateContainerID effectDuration the duration of the effect to apply before // PROTOTYPE EFFECTS beforeEffect the Scriptaculous effect to apply onSuccess ("highlight", "slideIn", "blindDown", etc); beforeEffectID the ID of the container to apply the "before" effect to (blank = try nearest container, then try updateContainerID) beforeEffectDuration the duration of the effect to apply before // PROTOTYPE EFFECTS afterEffect the Scriptaculous effect to apply onSuccess ("highlight", "slideIn", "blindDown", etc); afterEffectID the ID of the container to apply the "after" effect to (blank = try nearest container, then try updateContainerID) afterEffectDuration the duration of the effect to apply before

// PROTOTYPE EFFECTS insertion JavaScript function to evaluate when the update takes place (or effect shortcuts like "Effect.blind", or "Effect.BlindUp") insertionDuration the duration of the before and after insertion animation (if using insertion) beforeInsertionDuration the duration of the before insertion animation (if using insertion) afterInsertionDuration the duration of the after insertion animation (if using insertion)

Constructor & Destructor Documentation

AjaxUpdateLink	(	String	name,
		NSDictionary	associations,
		WOElement	children
	)

Member Function Documentation

static void addEffect	(	NSMutableDictionary	options,
		String	effect,
		String	updateContainerID,
		String	duration
	)			`[static]`

void addRequiredWebResources	(	WOResponse	response,
		WOContext	context
	)			`[protected, virtual]`

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

Implements AjaxDynamicElement.

void appendToResponse	(	WOResponse	response,
		WOContext	context
	)

Overridden to call addRequiredWebResources(WOResponse, WOContext).

Reimplemented from AjaxDynamicElement.

NSMutableDictionary createAjaxOptions ( WOComponent component ) [protected]

static String fullEffectName ( String effectName ) [static]

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

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

Parameters:

	request
	context

Implements AjaxDynamicElement.

String onClick	(	WOContext	context,
		boolean	generateFunctionWrapper
	)

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

/opt/source/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxUpdateLink.java


Public Member Functions
	AjaxUpdateLink (String name, NSDictionary associations, WOElement children)
void	appendToResponse (WOResponse response, WOContext context)
WOActionResults	handleRequest (WORequest request, WOContext context)
String	onClick (WOContext context, boolean generateFunctionWrapper)
Static Public Member Functions
static void	addEffect (NSMutableDictionary options, String effect, String updateContainerID, String duration)
static String	fullEffectName (String effectName)
Protected Member Functions
void	addRequiredWebResources (WOResponse res, WOContext context)
NSMutableDictionary	createAjaxOptions (WOComponent component)