Package com.microstrategy.web.app.transforms

Class ReportFlashTransform

    • Field Detail

      • VISUALIZATION_XML_ACCESS_METHOD_XML

        public static final java.lang.String VISUALIZATION_XML_ACCESS_METHOD_XML
        XML directly - "CustomXML" flashVar
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        Constant Field Values

      • VISUALIZATION_XML_ACCESS_METHOD_URL

        public static final java.lang.String VISUALIZATION_XML_ACCESS_METHOD_URL
        URL to get the XML - "CustomURL" flashVar
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        Constant Field Values

      • VISUALIZATION_XML_ACCESS_METHOD_TASK_URL

        public static final java.lang.String VISUALIZATION_XML_ACCESS_METHOD_TASK_URL
        URL to get the XML using the tasks infrastructure - "CustomURL" flashVar
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        Constant Field Values

      • VISUALIZATIONS_DEFAULT_LOCATION

        public static final java.lang.String VISUALIZATIONS_DEFAULT_LOCATION
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        Constant Field Values

      • HIDE_RESIZING_JS

        public static final java.lang.String HIDE_RESIZING_JS
        See Also:
        Constant Field Values

      • flashFile

        public FormalParameter flashFile
        The name of the flash SWF file to include. Allowed values: String values

      • extraFlashVars

        protected FormalParameter extraFlashVars
        Deprecated.
        to add extra flashvars please extend Transform and overwrite getFlashVars()
        The value of this parameter specifies a collection of extra flashVar variables that will be passed to the embedded flash object. These variables consist of name/value pairs in the following format:
        "name1=value1&name2=value2&name3=value3"
        If set through the styleCatalog.xml, the '&' must be encoded, so it should be "name1=value1&name2=value2&name3=value3"

      • includeBaseURL

        protected FormalParameter includeBaseURL
        Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.
        This link includes the session manager state which is used to restore the session

      • useJS

        protected FormalParameter useJS
        Whether to use Javascript to render the embeded Flash Object.
        Javascript is used validate that the proper version of Flash is installed on the client.
        Its value can be specified on the request as "useJS" and this will overwrite the existing value.
        Since:
        MicroStrategy Web 8.1.1

      • nodeKeys

        protected FormalParameter nodeKeys
        A list of grid keys to be requested by the Flash code when the visualization is applied to a grid in a document.
        This list may have multiple elements if Secondary Data Providers are enabled.
        The list is a comma separated list of keys and sliceIDs: "K44:0,W45:1,W46:2"

      • hideResizingJs

        protected FormalParameter hideResizingJs
        In this Transform's output we have some bone-based JavaScript Strings. These JavaScript are not used for Mojo Modes. So we use this boolean-typed FormalParameter to control whether we show the JavaScript or not.

      • BROWSER_INTERNET_EXPLORER

        public static final int BROWSER_INTERNET_EXPLORER
        See Also:
        Constant Field Values

    • Constructor Detail

      • ReportFlashTransform

        public ReportFlashTransform()
        Default no-args constructor, initializes formal parameters.

    • Method Detail

      • getFlashVars

        protected HashList getFlashVars()
        Returns the collection of flashVars to be added to the embedded Flash object. Based on the value of EnumWebPreferences.WebPreferenceVisualizationsXMLAccessMethod, it adds "customURL" or "customXML" with their corresponding values. It may also add a baseURL if specified in the formal parameter. This method can be overritten to add more flashVars.
        Returns:
        the collection of flashVars to be added to the embedded Flash object

      • renderEmbededFlashObjectTag

        protected void renderEmbededFlashObjectTag​(MarkupOutput out)
        Renders an embeded object flash file based on the values set on the formal parameters.
        Parameters:
        out - the Markup output

      • renderEmbededFlashObjectTag

        protected static void renderEmbededFlashObjectTag​(MarkupOutput out,
                                                  java.lang.String movie,
                                                  HashList flashVarsList,
                                                  java.lang.String extraFlashVars,
                                                  java.lang.String width,
                                                  java.lang.String height,
                                                  AppContext appContext,
                                                  java.lang.String beanPath)
        Renders an embeded object flash file.
        This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.
        Parameters:
        out - the Markup output
        movie - the flash movie path
        flashVarsList - the collection (value-name pair) of flashVars to include
        width - the width of the movie
        height - the height of the movie (if "-1", the flash will be resized when loaded on the browser)
        appContext - the AppContext object (only used when height is set to -1)
        Since:
        MicroStrategy Web 8.1.0

      • renderEmbededFlashObjectTag

        protected static void renderEmbededFlashObjectTag​(MarkupOutput out,
                                                  java.lang.String movie,
                                                  HashList flashVarsList,
                                                  java.lang.String extraFlashVars,
                                                  java.lang.String width,
                                                  java.lang.String height,
                                                  AppContext appContext,
                                                  java.lang.String beanPath,
                                                  java.lang.String containerID)
        Renders an embeded object flash file.
        This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.
        Parameters:
        out - the Markup output
        movie - the flash movie path
        flashVarsList - the collection (value-name pair) of flashVars to include
        width - the width of the movie
        height - the height of the movie (if "-1", the flash will be resized when loaded on the browser)
        appContext - the AppContext object (only used when height is set to -1)
        containerID - a unique identifier to use for the Div that will contain the FlashPlayer
        Since:
        MicroStrategy Web 8.1.0

      • renderEmbededFlashObjectTag

        protected static void renderEmbededFlashObjectTag​(MarkupOutput out,
                                                  java.lang.String movie,
                                                  HashList flashVarsList,
                                                  java.lang.String extraFlashVars,
                                                  java.lang.String width,
                                                  java.lang.String height,
                                                  AppContext appContext,
                                                  java.lang.String beanPath,
                                                  java.lang.String containerID,
                                                  boolean useJS)

      • renderEmbededFlashObjectTag

        protected static void renderEmbededFlashObjectTag​(MarkupOutput out,
                                                  java.lang.String movie,
                                                  HashList flashVarsList,
                                                  java.lang.String extraFlashVars,
                                                  java.lang.String width,
                                                  java.lang.String height,
                                                  AppContext appContext,
                                                  java.lang.String beanPath,
                                                  java.lang.String containerID,
                                                  boolean useJS,
                                                  boolean hideResizingJS)
        Renders an embeded object flash file.
        This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.
        Parameters:
        out - the Markup output
        movie - the flash movie path
        flashVarsList - the collection (value-name pair) of flashVars to include
        width - the width of the movie
        height - the height of the movie (if "-1", the flash will be resized when loaded on the browser)
        appContext - the AppContext object (only used when height is set to -1)
        containerID - a unique identifier to use for the Div that will contain the FlashPlayer
        useJS - Whether to use Javascript to render the embeded Flash Object.
        hideResizingJS - Whether to hide bone-based Javascript to render the embeded Flash Object.
        Since:
        MicroStrategy Web 8.1.1

      • renderJavascript

        protected void renderJavascript​(MarkupOutput out)
        Description copied from class: AbstractReportDataTransform
        This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokes renderRegisterBone which initializes and registers a grid's bone..
        Overrides:
        renderJavascript in class AbstractReportDataTransform
        Parameters:
        out - MarkupOutput to generate the HTML.

      • getVersion

        public static java.lang.String getVersion​(AppContext appContext)
        Generate a web version.
        Parameters:
        appContext - used to get the active session used to identify web version
        Returns:
        web version

      • renderEmbededFlashObjectTag

        protected static void renderEmbededFlashObjectTag​(MarkupOutput out,
                                                  java.lang.String movie,
                                                  HashList flashVarsList,
                                                  java.lang.String extraFlashVars,
                                                  java.lang.String imgWidth,
                                                  java.lang.String imgHeight,
                                                  int browserType)
        Deprecated.
        use renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath)
        Renders an embeded object flash file.
        This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.
        Parameters:
        out - the Markup output
        movie - the flash movie path
        flashVarsList - the collection (value-name pair) of flashVars to include
        imgWidth - the width of the movie
        imgHeight - the height of the movie
        browserType - for which browser to optimize the output: 1 means InternetExplorer (only <object> tag is generated), 2 means Firefox (only <embed> tag is generated). Any other value generates both tags.