Class 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
    • 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
      • 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