Package com.microstrategy.web.app

Class JavaScriptInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.JavaScriptInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class JavaScriptInfo
extends AbstractConfigurationElement

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_BASE_BEAN
static java.lang.String	ATT_EVENT
static java.lang.String	ATT_FEATURE
static java.lang.String	ATT_JAVASCRIPT_CODE
static java.lang.String	ATT_NAME
static java.lang.String	NODE_JAVASCRIPT

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
JavaScriptInfo()	Empty constructor of a JavaScriptInfo initialize private fields with default values.
JavaScriptInfo(java.lang.String name)	Constructor for an JavaScriptInfo with the given the arguments.
JavaScriptInfo(org.w3c.dom.Node root)	Creates an JavaScriptInfo with the information in the xml node.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBaseBean()	Retrieve the base bean that is associated with the JavaScriptInfo.
java.lang.String	getEvent()	Retrieve the JavaScript event with which the JavaScriptInfo is associated with
java.lang.String	getFeature()	Retrieve the feature that is associated with the JavaScriptInfo.
java.lang.String	getJavaScriptCode()	Retrieve the JavaScript code that is associated with the JavaScriptInfo
protected java.lang.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.
java.lang.String	getName()	Retrieve the name of the JavaScriptInfo
protected void	initDefaultAttributes()	This method can be overridden to set default values for attributes.
void	setBaseBean(java.lang.String value)	Set the JavaScript base bean for the JavaScriptInfo
void	setEvent(java.lang.String value)	Set the JavaScript Event for the JavaScriptInfo
void	setFeature(java.lang.String value)	Set the JavaScript feature for the JavaScriptInfo
void	setJavaScriptCode(java.lang.String value)	Set the JavaScript Code for the JavaScriptInfo
void	setName(java.lang.String value)	Set the name of the javaScriptInfo

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_JAVASCRIPT

public static final java.lang.String NODE_JAVASCRIPT

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

See Also:

Constant Field Values

ATT_EVENT

public static final java.lang.String ATT_EVENT

See Also:

Constant Field Values

ATT_JAVASCRIPT_CODE

public static final java.lang.String ATT_JAVASCRIPT_CODE

See Also:

Constant Field Values

ATT_BASE_BEAN

public static final java.lang.String ATT_BASE_BEAN

See Also:

Constant Field Values

ATT_FEATURE

public static final java.lang.String ATT_FEATURE

See Also:

Constant Field Values

Constructor Detail

JavaScriptInfo

public JavaScriptInfo()

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

JavaScriptInfo

public JavaScriptInfo(org.w3c.dom.Node root)

Creates an JavaScriptInfo with the information in the xml node.

Parameters:

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

JavaScriptInfo

public JavaScriptInfo(java.lang.String name)

Constructor for an JavaScriptInfo with the given the arguments.

Parameters:

name - The name of the JavaScriptInfo object.

Method Detail

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

initDefaultAttributes

protected void initDefaultAttributes()

Description copied from class: AbstractConfigurationElement

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

Overrides:

initDefaultAttributes in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Retrieve the name of the JavaScriptInfo

Returns:

The name of the JavaScriptInfo

setName

public void setName(java.lang.String value)

Set the name of the javaScriptInfo

Parameters:

value - The new name for the JavaScriptInfo

Since:

MicroStrategy Web 9.0.0

getEvent

public java.lang.String getEvent()

Retrieve the JavaScript event with which the JavaScriptInfo is associated with

Returns:

The event of the JavaScriptInfo

setEvent

public void setEvent(java.lang.String value)

Set the JavaScript Event for the JavaScriptInfo

Parameters:

value - The value for the JavaScript Event

Since:

MicroStrategy Web 8.0.2

getJavaScriptCode

public java.lang.String getJavaScriptCode()

Retrieve the JavaScript code that is associated with the JavaScriptInfo

Returns:

The JavaScript code of the JavaScriptInfo

setJavaScriptCode

public void setJavaScriptCode(java.lang.String value)

Set the JavaScript Code for the JavaScriptInfo

Parameters:

value - The value for the JavaScript Code

Since:

MicroStrategy Web 8.0.2

getBaseBean

public java.lang.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

setBaseBean

public void setBaseBean(java.lang.String value)

Set the JavaScript base bean for the JavaScriptInfo

Parameters:

value - The value for the JavaScript base bean

Since:

MicroStrategy Web 9.0.0

getFeature

public java.lang.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

setFeature

public void setFeature(java.lang.String value)

Set the JavaScript feature for the JavaScriptInfo

Parameters:

value - The value for the JavaScriptInfo feature

Since:

MicroStrategy Web 9.0.0