nextapp.echoservlet.ui
Class RolloverScript

java.lang.Object
  nextapp.echoservlet.ui.RolloverScript

public class RolloverScript

extends java.lang.Object

A utility class that wraps JavaScript code required to create mouse rollover effects in HTML pages on the client without server interaction.

Nested Class Summary

static class

RolloverScript.MultipleRolloverScriptElement A data object used to describe a rollover action when multiple actions are required for a rollover effect.

Field Summary

static Service

SERVICE_ROLLOVER_SCRIPT A service containing JavaScript code used to create rollover effects.

Method Summary

static java.lang.String	getScriptMultiRollover(Connection conn, RolloverScript.MultipleRolloverScriptElement[] elements) Returns the necessary script to produce a button rollover effect where multiple elements will be modified.
static java.lang.String	getScriptRollover(Connection conn, java.lang.String id, java.lang.String imageUri, java.lang.String styleName) Returns the necessary script to produce a button rollover effect.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_ROLLOVER_SCRIPT

public static final Service SERVICE_ROLLOVER_SCRIPT

A service containing JavaScript code used to create rollover effects.

Method Detail

getScriptRollover

public static java.lang.String getScriptRollover(Connection conn,
                                                 java.lang.String id,
                                                 java.lang.String imageUri,
                                                 java.lang.String styleName)

Returns the necessary script to produce a button rollover effect.

Parameters:

conn - The connection whose response the generated script will be written to.

id - The Id of the button that will be given the rollover effect.

imageUri - The URI of the replacement image.

styleName - The URI of the replacement style.

Returns:

A JavaScript method call that should be invoked in the rollover event listener.

getScriptMultiRollover

public static java.lang.String getScriptMultiRollover(Connection conn,
                                                      RolloverScript.MultipleRolloverScriptElement[] elements)

Returns the necessary script to produce a button rollover effect where multiple elements will be modified.

Parameters:

conn - The connection whose response the generated script will be written to.

elements - An array of MultipleRolloverScriptElements describing the rollover action.