public class

JavaScriptInfo

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.JavaScriptInfo

Class Overview

JavaScriptInfo objects represent the JavaScript code to be executed based on the JavaScript event specified in the event argument for this node. Developers can write any piece of JavaScript they want to be executed.

Summary

Constants
String ATT_BASE_BEAN
String ATT_EVENT
String ATT_FEATURE
String ATT_JAVASCRIPT_CODE
String ATT_NAME
String NODE_JAVASCRIPT
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
JavaScriptInfo()
Empty constructor of a JavaScriptInfo initialize private fields with default values.
JavaScriptInfo(Node root)
Creates an JavaScriptInfo with the information in the xml node.
JavaScriptInfo(String name)
Constructor for an JavaScriptInfo with the given the arguments.
Public Methods
String getBaseBean()
Retrieve the base bean that is associated with the JavaScriptInfo.
String getEvent()
Retrieve the JavaScript event with which the JavaScriptInfo is associated with
String getFeature()
Retrieve the feature that is associated with the JavaScriptInfo.
String getJavaScriptCode()
Retrieve the JavaScript code that is associated with the JavaScriptInfo
String getName()
Retrieve the name of the JavaScriptInfo
void setBaseBean(String value)
Set the JavaScript base bean for the JavaScriptInfo
void setEvent(String value)
Set the JavaScript Event for the JavaScriptInfo
void setFeature(String value)
Set the JavaScript feature for the JavaScriptInfo
void setJavaScriptCode(String value)
Set the JavaScript Code for the JavaScriptInfo
void setName(String value)
Set the name of the javaScriptInfo
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
void initDefaultAttributes()
This method can be overridden to set default values for attributes.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_BASE_BEAN

Constant Value: "base-bean"

public static final String ATT_EVENT

Constant Value: "event"

public static final String ATT_FEATURE

Constant Value: "feature-id"

public static final String ATT_JAVASCRIPT_CODE

Constant Value: "javascript-code"

public static final String ATT_NAME

Constant Value: "name"

public static final String NODE_JAVASCRIPT

Constant Value: "javascript"

Public Constructors

public JavaScriptInfo ()

Empty constructor of a JavaScriptInfo initialize private fields with default values.

public JavaScriptInfo (Node root)

Creates an JavaScriptInfo with the information in the xml node.

Parameters
root An XML Node with the information for this JavaScript node.

public JavaScriptInfo (String name)

Constructor for an JavaScriptInfo with the given the arguments.

Parameters
name The name of the JavaScriptInfo object.

Public Methods

public String getBaseBean ()

Retrieve the base bean that is associated with the JavaScriptInfo. This is used as a dependecy object to evaluate the feature which will determine if we need to execute the JavaScript code associated with the JavaScriptInfo.

Returns
  • The base bean of the JavaScriptInfo

public String getEvent ()

Retrieve the JavaScript event with which the JavaScriptInfo is associated with

Returns
  • The event of the JavaScriptInfo

public String getFeature ()

Retrieve the feature that is associated with the JavaScriptInfo. The feature will determine if we need to execute the JavaScript code associated with the JavaScriptInfo.

Returns
  • The feature of the JavaScriptInfo

public String getJavaScriptCode ()

Retrieve the JavaScript code that is associated with the JavaScriptInfo

Returns
  • The JavaScript code of the JavaScriptInfo

public String getName ()

Retrieve the name of the JavaScriptInfo

Returns
  • The name of the JavaScriptInfo

public void setBaseBean (String value)

Set the JavaScript base bean for the JavaScriptInfo

Parameters
value The value for the JavaScript base bean

public void setEvent (String value)

Set the JavaScript Event for the JavaScriptInfo

Parameters
value The value for the JavaScript Event

public void setFeature (String value)

Set the JavaScript feature for the JavaScriptInfo

Parameters
value The value for the JavaScriptInfo feature

public void setJavaScriptCode (String value)

Set the JavaScript Code for the JavaScriptInfo

Parameters
value The value for the JavaScript Code

public void setName (String value)

Set the name of the javaScriptInfo

Parameters
value The new name for the JavaScriptInfo

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

protected void initDefaultAttributes ()

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)