er.ajax

Class AjaxHighlight

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.ajax.AjaxHighlight

public class AjaxHighlight
extends com.webobjects.appserver._private.WODynamicGroup

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.

Author:

mschrag

Bindings

Name	Description
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)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AjaxHighlight.HighlightMetadata

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
static void	highlight(Object obj)
static void	highlight(Object obj, boolean isNew)
protected static Object	highlightedValue(Object obj)
static AjaxHighlight.HighlightMetadata	highlightMetadataForObject(Object obj)
static void	highlightNew(Object obj)
static void	highlightUpdate(Object obj)

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeAction, invokeChildrenAction, takeChildrenValuesFromRequest, takeValuesFromRequest, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AjaxHighlight

public AjaxHighlight(String name,
                     NSDictionary<String,com.webobjects.appserver.WOAssociation> associations,
                     com.webobjects.appserver.WOElement template)

Method Detail

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Overrides:

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

highlightedValue

protected static Object highlightedValue(Object obj)

highlightMetadataForObject

public static AjaxHighlight.HighlightMetadata highlightMetadataForObject(Object obj)

highlight

public static final void highlight(Object obj)

highlightNew

public static final void highlightNew(Object obj)

highlightUpdate

public static final void highlightUpdate(Object obj)

highlight

public static final void highlight(Object obj,
                                   boolean isNew)