Package com.microstrategy.web.app.transforms

Class AbstractTabTransform

    • Field Detail

      • tabHeight

        public FormalParameter tabHeight
        Indicates the height of the tabs on the editor.

      • FP_TAB_HEIGHT

        public static final java.lang.String FP_TAB_HEIGHT
        Constant specifying the name of the formal parameter for specifying the height of the tabs on the editor
        See Also:
        Constant Field Values

      • cssPickers

        protected java.lang.String cssPickers
        Property with the name of the css class to use for the div including all pickers of this instance transform output. The value specified on the cssPrefix formal parameter will by default be added to this property value at initialization time (initializeCss())

      • cssPicker

        protected java.lang.String cssPicker
        Property with the name of the css class to use for the div including a single picker of this instance transform output. The value specified on the cssPrefix formal parameter will by default be added to this property value at initialization time (initializeCss())

      • cssFrame

        protected java.lang.String cssFrame
        Property with the name of the css class to use for the frame of this instance transform output. The value specified on the cssPrefix formal parameter will by default be added to this property value at initialization time (initializeCss())

      • cssBody

        protected java.lang.String cssBody
        Property with the name of the css class to use for the body of this instance transform output. The value specified on the cssPrefix formal parameter will by default be added to this property value at initialization time (initializeCss())

      • styFrame

        protected java.lang.String styFrame
        Property with the value of the sty attribute for the frame of this instance transform output

      • styBody

        protected java.lang.String styBody
        Property with the value of the sty attribute for the body of this instance transform output

      • tyFrame

        protected java.lang.String tyFrame
        Property with the value of the ty attribute for the frame of this instance transform output

      • tyBody

        protected java.lang.String tyBody
        Property with the value of the ty attribute for the body of this instance transform output

      • scriptClassFrame

        protected java.lang.String scriptClassFrame
        Property with the value of the scriptClass attribute for the frame of this instance transform output

      • scriptClassBody

        protected java.lang.String scriptClassBody
        Property with the value of the scriptClass attribute for the body of this instance transform output

    • Constructor Detail

      • AbstractTabTransform

        public AbstractTabTransform()
        Default no-argument constructor. Initializes formal parameters.

    • Method Detail

      • renderTabFrame

        public void renderTabFrame​(MarkupOutput out)
        Method that renders a frame for all the contents and sections of the bean that are to be displayed. Calls renderTabFrameBody()
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • isCurrentTab

        public boolean isCurrentTab()

        This method returns true whenever this Tab is selected.

        When the Tab is selected, the output will be generated and displayed to the user. When the Tab is not selected, the output will still be generated, but it will not get displayed (it will get displayed when the user selects the Tab in the TabManager using javascript).

        This method will determine if the Tab is selected by comparing the TabManagerBean's currentTab with the TabBean's getTabRepresented. This method will return true also for those cases when there is no TabManagerBean.
        Returns:
        boolean true when this is the current tab

      • getTabManagerBean

        protected TabManagerBean getTabManagerBean()
        Returns the TabManagerBean for this Tab. By default, this method just checks whether the parent is a TabManagerBean and returns it if so.
        Returns:
        TabManagerBean controlling this Tab.

      • getTabBean

        protected TabBean getTabBean()
        Returns the TabBean for this tab.
        Returns:
        TabBean for this tab.
        Since:
        MicroStrategy Web 8.1.0

      • renderContents

        public void renderContents​(MarkupOutput out)
        Method that renders a frame for the main contents of the transform, according to the information available on the bean. Calls renderContentsBody()
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • renderContentsBody

        public abstract void renderContentsBody​(MarkupOutput out)
        Method that renders the main contents of the transform, according to the information available on the bean. This method can be customized if users would like to obtain a different output for the same given bean.
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • renderTabSectionTitle

        @Deprecated
public void renderTabSectionTitle​(MarkupOutput out,
                                  java.lang.String title)
        Deprecated.
        please use getFieldSetTag instead
        Convenience method that displays the HTML required for rendering the title of a section.
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        title - String that will be displayed as title

      • getFieldSetTag

        public Tag getFieldSetTag​(java.lang.String title)
        Convenience method that builds and returns a fieldset html tag.
        Parameters:
        title - String that will be displayed as the title
        Returns:
        fieldSet tag
        Since:
        MicroStrategy Web 9.0.0

      • renderJavascriptLinks

        public void renderJavascriptLinks​(MarkupOutput out)
        Used to dynamically include links to js files. Extend with the list of files your transform requires.
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • getDescription

        public java.lang.String getDescription()
        Returns the textual description of the transform
        Returns:
        the description of the transform

      • renderDropdown

        public void renderDropdown​(MarkupOutput out,
                           java.lang.String cmdId,
                           java.lang.String cmdValue,
                           ShortcutList picker,
                           java.lang.String value)
        This method renders a single dropdown list to be used within a tab.
        Parameters:
        out - MarkupOutput where the content should be generated
        cmdId - the dropdown's command id
        cmdValue - the dropdown's current command value.
        picker - the ShortcutList for the picker.
        value - the dropdown current value.

      • renderColorDropdown

        public void renderColorDropdown​(MarkupOutput out,
                                java.lang.String cmdId,
                                java.lang.String cmdValue,
                                ShortcutList picker)
        This method renders a single dropdown to be used with a color picker
        Parameters:
        out - MarkupOutput where the content should be generated
        cmdId - the dropdown's command id
        cmdValue - the dropdown's current command value.
        picker - the ShortcutList for the picker.

      • renderFlashWarning

        public void renderFlashWarning​(MarkupOutput out)

        Generates the HTML with a label that reads '(Flash Only)'. The label is invisible until the Tab Bone decides to make it visible.

        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        Since:
        MicroStrategy Web 8.1.0

      • getDropDownTag

        protected Tag getDropDownTag​(java.lang.String cmdId,
                             java.lang.String cmdValue,
                             ShortcutList picker,
                             java.lang.String type)
        Since:
        MicroStrategy Web 9.0.0

      • addPicker

        protected void addPicker​(ShortcutList picker)

      • getPickerId

        protected java.lang.String getPickerId​(ShortcutList picker)

      • renderPickers

        protected void renderPickers​(MarkupOutput out)
        This method needs to be overriden by those Transforms that has a picker. By default nothing is rendered
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be generated.

      • initializeJavaScriptAttributes

        public void initializeJavaScriptAttributes()
        For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments. This method assigns values to these attributes, so they can be displayed together with the tags they represent. If a value is set to be null, it won't be included on the HTML tag definition. By default, it includes the definition of values for properties such as styFrame, tyFrame and scriptClassFrame.

      • initializeCss

        public void initializeCss()
        Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.
        Overrides:
        initializeCss in class AbstractAppTransform

      • getAttributesFrame

        protected java.util.Map getAttributesFrame()
        This method return a Map (name/value pairs) of attributes to use for the div enclosing the content of the Tab. These attributes include those required for javascript and formatting (for example, "sty", "ty" and "scriptclass").
        Returns:
        Map with HTML attributes for the body div.

      • isIFrameEnabled

        protected boolean isIFrameEnabled()
        Whether iframe update technology is enabled for this Transform.
        Overrides:
        isIFrameEnabled in class AbstractAppTransform
        Returns:
        whether iframe is enabled
        Since:
        MicroStrategy Web 9.0.0

      • getAttributesBody

        protected java.util.Map getAttributesBody()
        This method return a Map (name/value pairs) of attributes to use for the div enclosing the body of the Tab. These attributes include those required for javascript and formatting (for example, "sty", "ty" and "scriptclass").
        Returns:
        Map with HTML attributes for the body div.

      • getArgumentName

        protected java.lang.String getArgumentName​(WebEvent event,
                                           int argumentId)
        Get the name of the argument assigned to the WebEvent, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.
        Overrides:
        getArgumentName in class AbstractAppTransform
        Parameters:
        event - WebEvent from where the argument name will be retrieved
        argumentId - int with the identifier of the argument to search for on the event
        Returns:
        the corresponding name of the event for the specified id. If it is not found, it will return null.

      • addJSValidationInfo

        public void addJSValidationInfo​(Tag inputTag,
                                java.lang.String type,
                                java.lang.String min,
                                java.lang.String max,
                                java.lang.String name,
                                java.lang.String errorMsg)
        Add the necessary JavaScript validation information
        Parameters:
        inputTag - Tag the Tag where the infortmation will be added
        type - String The type pof data to validate ('1'- Integer; '2'- float)
        min - String The minimum number allowed
        max - String The maximum number allowed
        name - String The name of the field. (Used on the error message)
        errorMsg - String The error message to display. This is only needed for custom messages, if no message is specified, the default one will be used.

      • getLabelTag

        protected Tag getLabelTag​(java.lang.String attFor,
                          java.lang.String labelDescriptor)
        Since:
        MicroStrategy Web 8.1.0

      • renderSingleOption

        protected void renderSingleOption​(MarkupOutput out,
                                  java.lang.String cmdId,
                                  java.lang.String propertyValue,
                                  java.lang.String msg,
                                  boolean isDisabled)
        Since:
        MicroStrategy Web 8.1.0

      • renderSingleOption

        protected void renderSingleOption​(MarkupOutput out,
                                  java.lang.String cmdId,
                                  boolean checked,
                                  java.lang.String msg,
                                  boolean isDisabled,
                                  boolean setCmdValue)
        Since:
        MicroStrategy Web 8.1.0

      • AddJSValidationInfo

        @Deprecated
public void AddJSValidationInfo​(Tag inputTag,
                                java.lang.String type,
                                java.lang.String min,
                                java.lang.String max,
                                java.lang.String name,
                                java.lang.String errorMsg)
        Deprecated.
        please use addJSValidationInfo(com.microstrategy.web.tags.Tag, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead
        Add the necessary JavaScript validation information
        Parameters:
        inputTag - Tag the Tag where the infortmation will be added
        type - String The type pof data to validate ('1'- Integer; '2'- float)
        min - String The minimum number allowed
        max - String The maximum number allowed
        name - String The name of the field. (Used on the error message)
        errorMsg - String The error message to display. This is only needed for custom messages, if no message is specified, the default one will be used.