Class AbstractAppTransform

    • Field Detail

      • FP_SCRIPT_CLASS

        public static final java.lang.String FP_SCRIPT_CLASS
        Constant for the name of the scriptClass formal parameter.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        scriptClass, Constant Field Values
      • FP_DEBUG_FLAGS

        public static final java.lang.String FP_DEBUG_FLAGS
        Constant for the name of the debugFlags Formal Parameter.
        See Also:
        debugFlags, Constant Field Values
      • FP_DEBUG_ERROR_FLAGS

        public static final java.lang.String FP_DEBUG_ERROR_FLAGS
        Constant for the name of the debugErrorFlags Formal Parameter.
        See Also:
        debugErrorFlags, Constant Field Values
      • FP_CSS_FILE

        public static final java.lang.String FP_CSS_FILE
        Constant for the name of the cssFile Formal Parameter.
        See Also:
        cssFile, Constant Field Values
      • FP_CSS_PREFIX

        public static final java.lang.String FP_CSS_PREFIX
        Constant for the name of the cssPrefix Formal Parameter.
        See Also:
        cssPrefix, Constant Field Values
      • FP_EXTRA_URL

        public static final java.lang.String FP_EXTRA_URL
        Constant for the name of the extraUrl Formal Parameter.
        See Also:
        extraUrl, Constant Field Values
      • FP_EXTRA_INPUT

        public static final java.lang.String FP_EXTRA_INPUT
        Constant for the name of the extraInput Formal Parameter.
        See Also:
        extraInput, Constant Field Values
      • FP_IMG_WAIT

        @Deprecated
        public static final java.lang.String FP_IMG_WAIT
        Deprecated.
        The wait image is generated using css.
        Constant for the name of the imgWait Formal Parameter.
        See Also:
        imgWait, Constant Field Values
      • FP_INITIAL_INDENT

        @Deprecated
        public static final java.lang.String FP_INITIAL_INDENT
        Deprecated.
        Indentation is not generated by Transforms anymore.
        Constant for the name of the initialIndent Formal Parameter.
        See Also:
        initialIndent, Constant Field Values
      • FP_CSS_ERROR_TITLE

        @Deprecated
        public static final java.lang.String FP_CSS_ERROR_TITLE
        Deprecated.
        The css class to use cannot be controlled through a formal parameter anymore.
        Constant for the name of the globalCssErrorTitle Formal Parameter.
        See Also:
        globalCssErrorTitle, Constant Field Values
      • FP_CSS_ERROR_MESSAGE

        @Deprecated
        public static final java.lang.String FP_CSS_ERROR_MESSAGE
        Deprecated.
        The css class to use cannot be controlled through a formal parameter anymore.
        Constant for the name of the imgWait Formal Parameter.
        See Also:
        imgWait, Constant Field Values
      • FP_IFRAME_ENABLED

        public static final java.lang.String FP_IFRAME_ENABLED
        Constant for the name of the iframeEnabled Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        iframeEnabled, Constant Field Values
      • FP_WIDTH

        public static final java.lang.String FP_WIDTH
        Constant for the name of the width Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        width, Constant Field Values
      • FP_HEIGHT

        public static final java.lang.String FP_HEIGHT
        Constant for the name of the height Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        height, Constant Field Values
      • FP_ORIENTATION

        public static final java.lang.String FP_ORIENTATION
        Constant for the name of the orientation Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        orientation, Constant Field Values
      • FP_ORIENTATIONS_ALLOWED

        public static final java.lang.String FP_ORIENTATIONS_ALLOWED
        Constant for the name of the orientationsAllowed Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        orientationsAllowed, Constant Field Values
      • FP_DRAG_MODE

        public static final java.lang.String FP_DRAG_MODE
        Constant for the name of the dragMode Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        dragMode, Constant Field Values
      • FP_APPLIES_TO

        public static final java.lang.String FP_APPLIES_TO
        Constant for the name of the appliesTo Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        appliesTo, Constant Field Values
      • FP_TYPE

        public static final java.lang.String FP_TYPE
        Constant for the name of the type Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        type, Constant Field Values
      • FP_PARTIAL_IFRAME_UPDATE

        public static final java.lang.String FP_PARTIAL_IFRAME_UPDATE
        Constant for the name of the partialIframeUpdate Formal Parameter.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        partialIframeUpdate, Constant Field Values
      • FP_RESIZE_LEVEL

        public static final java.lang.String FP_RESIZE_LEVEL
        Constant for the name of the resizeLevel Formal Parameter.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        resizeLevel, Constant Field Values
      • FP_CONTEXT_MENUS

        public static final java.lang.String FP_CONTEXT_MENUS
        Constant for the name of the contextMenus Formal Parameter.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        contextMenus, Constant Field Values
      • RESIZE_NONE

        public static final int RESIZE_NONE
        Constant to indicate that the component cannot be resized. Used with the resizeLevel Formal Parameter.
        Value: 0.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        resizeLevel, Constant Field Values
      • RESIZE_VERTICAL

        public static final int RESIZE_VERTICAL
        Constant to indicate that the component can be resized vertically. Used with the resizeLevel Formal Parameter.
        Value: 2.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        resizeLevel, Constant Field Values
      • RESIZE_HORIZONTAL

        public static final int RESIZE_HORIZONTAL
        Constant to indicate that the component can be resized horizontally. Used with the resizeLevel Formal Parameter.
        Value: 2.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        resizeLevel, Constant Field Values
      • RESIZE_ALL

        public static final int RESIZE_ALL
        Constant to indicate that the component can be resized both, horizontally and vertically. Used with the resizeLevel Formal Parameter.
        Value: 3.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        resizeLevel, Constant Field Values
      • FP_USE_DHTML

        public static final java.lang.String FP_USE_DHTML
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • imgWait

        @Deprecated
        public FormalParameter imgWait
        Deprecated.
        This value is not used anymore by the Transform as the wait image is included using css.
        Name of the image for the Processing icon on the Wait page.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
      • _imgWait

        @Deprecated
        protected java.lang.String _imgWait
        Deprecated.
        This value is not used anymore by the Transform as the wait image is included using css.
        Property corresponding to the value of the imgWait formal parameter
        See Also:
        imgWait
      • scriptClass

        public FormalParameter scriptClass
        Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
        By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
        Since:
        MicroStrategy Web 9.0.0
      • cssFile

        public FormalParameter cssFile
        CSS file that includes the style definition.
        If defined, this file will be included as Link.
      • _cssPrefix

        protected java.lang.String _cssPrefix
        Property corresponding to the value of the cssPrefix formal parameter
      • cssPrefix

        public FormalParameter cssPrefix
        Prefix to append to all css class names.
      • iframeEnabled

        public FormalParameter iframeEnabled
        Indicates whether the transform supports iframe manipulations.
        Since:
        MicroStrategy Web 8.0.0
      • debugErrorFlags

        public FormalParameter debugErrorFlags
        Indicates which extra debug information to include in case of an error.
        The flags are taken from the EnumWebAppDebugFlags enumeration.
      • extraUrl

        public FormalParameter extraUrl
        Indicates any extra parameters to be included in the links generated by the transform.
      • extraInput

        public FormalParameter extraInput
        Indicates any extra inputs to be included in the forms generated by the transform.
      • width

        public FormalParameter width
        Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
        Since:
        MicroStrategy Web 8.0.0
      • height

        public FormalParameter height
        Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
        Since:
        MicroStrategy Web 8.0.0
      • initialIndent

        @Deprecated
        public FormalParameter initialIndent
        Deprecated.
        Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
        Indicates the initial indentation of the HTML generated.
      • globalCssErrorTitle

        @Deprecated
        public FormalParameter globalCssErrorTitle
        Deprecated.
        The css class to use cannot be controlled through a formal parameter anymore.
        CSS to be used in all Error titles.
      • globalCssErrorMessage

        @Deprecated
        public FormalParameter globalCssErrorMessage
        Deprecated.
        The css class to use cannot be controlled through a formal parameter anymore.
        CSS to be used in all error messages.
      • orientation

        public FormalParameter orientation
        Indicates the orientation the dialog to render will have.
        Usage:
        Possible values for this property and their meaning include:
      • 0 = not docked
      • 1 = docked horizontally
      • 2 = docked vertically
Since:
MicroStrategy Web 8.0.0
Since:
MicroStrategy Web 8.0.0