Class AbstractEditorTransform

    • Field Detail

      • FP_EDITOR_ELEMENTS

        public static final java.lang.String FP_EDITOR_ELEMENTS
        See Also:
        Constant Field Values
      • FP_TITLE_LABEL_ID

        public static final java.lang.String FP_TITLE_LABEL_ID
        See Also:
        Constant Field Values
      • FP_APPLY_LABEL_ID

        public static final java.lang.String FP_APPLY_LABEL_ID
        See Also:
        Constant Field Values
      • FP_NAVIGATE_ON_SUBMIT

        public static final java.lang.String FP_NAVIGATE_ON_SUBMIT
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values
      • FP_CANCEL_LABEL_ID

        public static final java.lang.String FP_CANCEL_LABEL_ID
        See Also:
        Constant Field Values
      • FP_CLOSE_LABEL_ID

        public static final java.lang.String FP_CLOSE_LABEL_ID
        See Also:
        Constant Field Values
      • FP_USE_JS_IN_BONE

        public static final java.lang.String FP_USE_JS_IN_BONE
        See Also:
        Constant Field Values
      • FP_CAN_AUTO_SIZE

        public static final java.lang.String FP_CAN_AUTO_SIZE
        See Also:
        Constant Field Values
      • FP_EDITOR_CONTENTS_STYLE

        public static final java.lang.String FP_EDITOR_CONTENTS_STYLE
        See Also:
        Constant Field Values
      • FP_EDITOR_SUBTYPE

        public static final java.lang.String FP_EDITOR_SUBTYPE
        See Also:
        Constant Field Values
      • FP_EDITOR_LAYOUT_FILE

        public static final java.lang.String FP_EDITOR_LAYOUT_FILE
        See Also:
        Constant Field Values
      • FP_INCLUDE_DYNAMIC_SCRIPT

        public static final java.lang.String FP_INCLUDE_DYNAMIC_SCRIPT
        See Also:
        Constant Field Values
      • FP_DISABLE_OK_BUTTON

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

        public FormalParameter titleLabelID
        Indicates the title id according to the application's resource buldles.
      • applyLabelID

        public FormalParameter applyLabelID
        Indicates the apply label id according to the application's resource buldles.
      • okLabelID

        public FormalParameter okLabelID
        Indicates the OK label id according to the application's resource buldles.
      • cancelLabelID

        public FormalParameter cancelLabelID
        Indicates the cancel label id according to the application's resource buldles.
      • closeLabelID

        public FormalParameter closeLabelID
        Indicates the close label id according to the application's resource buldles.
      • titleLabel

        public FormalParameter titleLabel
        Indicates the title when no title id is provided.
      • applyLabel

        public FormalParameter applyLabel
        Indicates the apply label when no title id is provided.
      • okLabel

        public FormalParameter okLabel
        Indicates the OK label when no title id is provided.
      • cancelLabel

        public FormalParameter cancelLabel
        Indicates the cancel label when no title id is provided.
      • closeLabel

        public FormalParameter closeLabel
        Indicates the close label when no title id is provided.
      • renderForm

        public FormalParameter renderForm
        Indicates whether the editor will create its own form.
      • editorLayoutFile

        public FormalParameter editorLayoutFile
        Indicates the name of the definition file associated with the editor.
      • applyJS

        public FormalParameter applyJS
        Indicates JavaScript functionality to be invoked when 'Apply' buttons is pressed.
      • okJS

        public FormalParameter okJS
        Indicates JavaScript functionality to be invoked when 'OK' buttons is pressed.
        JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
        If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
      • navigateOnSubmit

        public FormalParameter navigateOnSubmit
        Indicates if the editor will move to a new page after the user clicks on the OK button
        Since:
        MicroStrategy Web 8.0.2
      • cancelJS

        public FormalParameter cancelJS
        Indicates JavaScript functionality to be invoked when 'Cancel' buttons is pressed.
        JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
        If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
      • closeJS

        public FormalParameter closeJS
        Indicates JavaScript functionality to be invoked when 'Close' buttons is pressed.
        JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
        If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
      • closeEvent

        public FormalParameter closeEvent
        Indicates the close event to use by the close button.
      • dhtmlClose

        public FormalParameter dhtmlClose
        Indicates if the close action will be executed using dhtml.
      • canAutoSize

        public FormalParameter canAutoSize
        Indicates if editor should auto-size to show the contents.
      • editorContentsStyle

        public FormalParameter editorContentsStyle
        Indicates the style name to be used for the div containing the editor contents
      • editorSubType

        public FormalParameter editorSubType
        Indicates the subtype to be used for the STY attribute for the editor container
      • closeImage

        public FormalParameter closeImage
        Indicates the image to use in the close button.
      • includeDynamicScript

        public FormalParameter includeDynamicScript
        Indicates whether dynamic scripts will be included while rendering the page.
        Usage:
        This is a Boolean formal parameter, where true indicates that the dynamic javascripts will be included, false otherwise.
      • disableOKButton

        public FormalParameter disableOKButton
        Indicates whether to disable the OK button
        Since:
        MicroStrategy Web 9.0.0
      • _helpTopic

        protected java.lang.String _helpTopic
        Since:
        MicroStrategy Web 9.0.0
      • _helpType

        protected java.lang.String _helpType
        Since:
        MicroStrategy Web 9.0.0
      • helpPage

        public FormalParameter helpPage
        Deprecated.
        Indicates the sub-page for the help for the editor.
        Since:
        MicroStrategy Web 8.0.2
      • helpType

        public FormalParameter helpType
        Indicates the type of help topic this editor uses.
        Since:
        MicroStrategy Web 9.0.0
      • helpTopic

        public FormalParameter helpTopic
        Indicates the help topic for the help page of the editor.
        Since:
        MicroStrategy Web 8.0.2
      • FP_HELP_PAGE

        public static final java.lang.String FP_HELP_PAGE
        Deprecated.
        Constant specifying the name of the formal parameter for specifying the sub-page of the help for the editor
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values
      • FP_HELP_TYPE

        public static final java.lang.String FP_HELP_TYPE
        Constant specifying the type of the help file this editor should point to
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • FP_HELP_TOPIC

        public static final java.lang.String FP_HELP_TOPIC
        Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractEditorTransform

        public AbstractEditorTransform()
        Default no-args constructor, initialize formal parameters.
    • Method Detail

      • renderEditorContents

        public abstract void renderEditorContents​(MarkupOutput out)
        Generates the graphical output for the Editor
        Parameters:
        out - MarkupOutput instance where to create the HTML output
      • renderEditor

        public void renderEditor​(MarkupOutput out)
        Main method to render the output of an editor
        Parameters:
        out - MarkupOutput instance where to create the HTML output
      • generateForm

        protected Tag generateForm()
        Since:
        MicroStrategy Web 9.0.0
      • getOnSubmitJS

        protected java.lang.String getOnSubmitJS()
        Provides JS code to be executed on the "onsubmit" event of the HTML form.
        Used for customizations where an action is needed before the form is submitted.
        Note: this is only used when the editor uses an event and not JS on the OK/Apply buttons. For those cases use the "okJS" or "applyJS" formal parameters
        Returns:
        JS code to be executed on the "onsubmit" event of the HTML form.
        Since:
        MicroStrategy Web 8.1.2
      • initEditor

        protected void initEditor​(Editor editor)
        Initializes the editor with the global settings.
        Parameters:
        editor - the Editor to modify.
      • initHelp

        protected void initHelp​(Editor editor)
        Since:
        MicroStrategy Web 9.0.0
      • getEditorTitle

        protected java.lang.String getEditorTitle()
      • renderJavascript

        protected void renderJavascript​(MarkupOutput out)
        This method should be used by the Editor transforms to generate any javascript necessary.
        The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.
        Parameters:
        out - MarkupOutput where the output should be rendered.
      • getDivTagAroundContents

        public Tag getDivTagAroundContents()
        Wrap around the contents of an editor with a div that can set the overflow, style and subtype properties
        Returns:
        Tag DivTag instance that can be used to wrap around the contents
      • setFocusFieldId

        protected void setFocusFieldId​(java.lang.String value)
        Since:
        MicroStrategy Web 8.0.1