AjaxHighlight Class Reference

Inherits com::webobjects::appserver::_private::WODynamicGroup.

Collaboration diagram for AjaxHighlight:

[legend]

List of all members.

Classes
class	HighlightMetadata
Public Member Functions
	AjaxHighlight (String name, NSDictionary associations, WOElement template)
void	appendToResponse (WOResponse response, WOContext context)
Static Public Member Functions
static final void	highlight (Object obj, boolean isNew)
static final void	highlight (Object obj)
static HighlightMetadata	highlightMetadataForObject (Object obj)
static final void	highlightNew (Object obj)
static final void	highlightUpdate (Object obj)
Static Protected Member Functions
static Object	highlightedValue (Object obj)
Private Attributes
NSDictionary	_associations
WOAssociation	_delay
WOAssociation	_duration
WOAssociation	_effect
WOAssociation	_elementName
WOAssociation	_hidden
WOAssociation	_hideDelay
WOAssociation	_hideDuration
WOAssociation	_hideEffect
WOAssociation	_id
WOAssociation	_newDuration
WOAssociation	_newEffect
WOAssociation	_newHidden
WOAssociation	_showDuration
WOAssociation	_showEffect
WOAssociation	_updateDuration
WOAssociation	_updateEffect
WOAssociation	_updateHidden
WOAssociation	_value
Static Private Attributes
static final String	HIGHLIGHTED_KEY = "er.ajax.AjaxHighlight.highlighted"

---

Detailed Description

AjaxHighlight provides a convenient way to queue up an object as highlighted so that it gets a highlight effect when the next page renders.

In the action prior to returning the page that will show a highlight, you can call AjaxHighlight.highlight(theObject). The object you highlight could be a String, an EO, or whatever object makes sense in your context.

Then you simply bind value = .. on this component on the following page. If the value matches an object that was flagged as highlighted, the container you specify will receive the highlight effect. This component can also generate its own container if you do not specify another container id.

value the value to check for highlighting id the optional id to highlight (if blank, a container will be generated) elementName the element name of the generated container (if specified, a container will be generated); defaults to div effect the name of the scriptaculous effect to render (defaults to "Highlight", "none" = no effect) newEffect the name of the scriptaculous effect to render (defaults to "Highlight", "none" = no effect) for new objects updateEffect the name of the scriptaculous effect to render (defaults to "Highlight", "none" = no effect) for updated objects class the CSS class of the generated container style the CSS style of the generated container onMouseOver string with javascript to execute onMouseOut string with javascript to execute duration the duration of the highlight effect (in seconds) hidden if true, when the value is highlighted, the element will be display: none newHidden if true, when the value is highlighted, the element will be display: none for new objects updateHidden if true, when the value is highlighted, the element will be display: none for updated objects delay if set, the delay that is applied before the effect is executed showEffect if set, the highlighed elemented with have this effect applied prior to the highlight (i.e. "Appear") showDuration the duration of the show effect (in seconds) hideEffect if set, the highlighed elemented with have this effect applied after the highlight (i.e. "Fade") hideDuration the duration of the hide effect (in seconds)

Author:

mschrag

---

Constructor & Destructor Documentation

AjaxHighlight	(	String	name,
		NSDictionary	associations,
		WOElement	template
	)

---

Member Function Documentation

void appendToResponse	(	WOResponse	response,
		WOContext	context
	)

static final void highlight	(	Object	obj,
		boolean	isNew
	)			[static]

static final void highlight

(

Object

obj

)

[static]

static Object highlightedValue

(

Object

obj

)

[static, protected]

static HighlightMetadata highlightMetadataForObject

(

Object

obj

)

[static]

static final void highlightNew

(

Object

obj

)

[static]

static final void highlightUpdate

(

Object

obj

)

[static]

---

Member Data Documentation

NSDictionary _associations [private]

WOAssociation _delay [private]

WOAssociation _duration [private]

WOAssociation _effect [private]

WOAssociation _elementName [private]

WOAssociation _hidden [private]

WOAssociation _hideDelay [private]

WOAssociation _hideDuration [private]

WOAssociation _hideEffect [private]

WOAssociation _id [private]

WOAssociation _newDuration [private]

WOAssociation _newEffect [private]

WOAssociation _newHidden [private]

WOAssociation _showDuration [private]

WOAssociation _showEffect [private]

WOAssociation _updateDuration [private]

WOAssociation _updateEffect [private]

WOAssociation _updateHidden [private]

WOAssociation _value [private]

final String HIGHLIGHTED_KEY = "er.ajax.AjaxHighlight.highlighted" [static, private]

---

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

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