Package com.microstrategy.web.app.beans

Interface TabBean

    • Field Detail

      • TAB_REPRESENTED_NOT_SPECIFIED

        static final int TAB_REPRESENTED_NOT_SPECIFIED
        Constant to represent the tab identifier this instance represents has not been specified yet
        See Also:
        Constant Field Values

    • Method Detail

      • setTabRepresented

        void setTabRepresented​(int tab)
        Each instance of this class represents a tab in the TabManagerBean. This method allows to specify which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.
        Parameters:
        tab - an identifier of the tab this instance represents.

      • getTabRepresented

        int getTabRepresented()
        Each instance of this class represents a tab in the TabManagerBean. This method allows to get which tab this instance will represent, so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab the user requested.
        Returns:
        the identifier of the tab this instance represents

      • setRequireSingleSelector

        void setRequireSingleSelector​(boolean requireSingleSelector)
        Each instance of this class represents a tab in the TabManagerBean. This method allows to specify whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.
        Parameters:
        requireSingleSelector - boolean indicating whether a single selection on selector control is required for the tab to be available or not.
        Since:
        MicroStrategy Web 8.1.2

      • getRequireSingleSelector

        boolean getRequireSingleSelector()
        Each instance of this class represents a tab in the TabManagerBean. This method inidicates whether this tab instance's availability relies on the selection of exactly one selector control among all the units the user has selected.
        Returns:
        indicates whether a single selection on selector control is required for the tab to be available or not.
        Since:
        MicroStrategy Web 8.1.2

      • setTabName

        void setTabName​(java.lang.String tabName)
        Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.
        Parameters:
        tabName - the name identifier of the tab this instance represents
        Since:
        MicroStrategy Web 9.0.0

      • getTabName

        java.lang.String getTabName()
        Each instance of this class represents a tab in the TabManagerBean. This method allows an alternative other than getTabRepresented() to get which tab this instance presents , so the TabManagerBean manager knows how to transfer render control to the child, depending on which tab name the user requested.
        Returns:
        the name identifier of the tab this instance represents
        Since:
        MicroStrategy Web 9.0.0

      • isAvailable

        boolean isAvailable()
        This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.
        Returns:
        True if the instance is available for being displayed, if the user were to request it. Returns False otherwise.

      • setTabLabel

        void setTabLabel​(java.lang.String description)
        Set the description text to be used as title for the display of the tab.
        Parameters:
        description - String with the text to be used as title of the tab.

      • setTabLabelId

        void setTabLabelId​(java.lang.String descriptionId)
        Set the identifier of the descriptor to be used as title for the display of the tab.
        Parameters:
        descriptionId - String with the identifier of the descriptor to be used as title of the tab.

      • getTabLabel

        java.lang.String getTabLabel()
        Get the description text to be used as title for the display of the tab.
        Returns:
        String with the text to be used as title of the tab.

      • getTabLabelId

        java.lang.String getTabLabelId()
        Get the identifier of the descriptor to be used as title for the display of the tab.
        Returns:
        String with the identifier of the descriptor to be used as title of the tab.

      • getTabId

        java.lang.String getTabId()
        Returns a string can be used as the identifier of the tab.
        Returns:
        String with the text to be used as the id of the tab.
        Since:
        MicroStrategy Web 8.1.0

      • setSupportedTypes

        void setSupportedTypes​(java.lang.String supportedTYpes)
        Set the list of objects this tab can be associated with.
        Parameters:
        supportedTYpes - String list of the associated objectys i.e. obj.103, obj.102

      • getSupportedTypes

        java.lang.String getSupportedTypes()
        Get the list of objects this tab can be associated with.
        Returns:
        String with the a list of supported objects.

      • setEnabledCmdId

        void setEnabledCmdId​(java.lang.String value)
        Set the command id to be queried on the client site. This determines the availability of the tab.
        Parameters:
        value -

      • getEnabledCmdId

        java.lang.String getEnabledCmdId()
        Get the command id to be queried on the clioent site. This determines the availability of the tab.
        Returns:
        String with the tab's command id.

      • getViewBean

        ViewBean getViewBean()
        Utility method for obtaining the ViewBean indicated as target bean for this tab instance.
        Specified by:
        getViewBean in interface ViewBeanParserBean
        Returns:
        the ViewBean corresponding to the name specified on the ActiveViewKey property. Returns null if not found (or if bean type is not related with ViewBean).

      • getTabManager

        TabManagerBean getTabManager()
        Utility method for obtaining the parent tabe manager associated to this tab
        Returns:
        the TabManagerBean parent

      • setFeatures

        void setFeatures​(java.lang.String featureIds)
        Sets a list of feature ids that are required to enable the tab
        Parameters:
        featureIds - String featureIds separated by ","

      • getFeatures

        java.lang.String getFeatures()
        Gets a list of feature ids that are required to enable the tab
        Returns:
        String

      • setSwitchMode

        void setSwitchMode​(int switchMode)
        Sets the switch mode of the tab bean (client side switch or server side switch)
        Parameters:
        switchMode - int
        Since:
        MicroStrategy Web 9.0.0

      • getSwitchMode

        int getSwitchMode()
        Gets the switch mode of the tab bean
        Returns:
        int
        Since:
        MicroStrategy Web 9.0.0

      • setPartialUpdate

        void setPartialUpdate​(boolean paritalUpdate)
        Since:
        MicroStrategy Web 9.0.0

      • isPartialUpdate

        boolean isPartialUpdate()
        Since:
        MicroStrategy Web 9.0.0

      • setHelpTopic

        void setHelpTopic​(java.lang.String topic)
        set the help topic of the editor
        Parameters:
        topic - the help topic
        Since:
        MicroStrategy Web 9.0.0

      • getHelpTopic

        java.lang.String getHelpTopic()
        get the help topic of this tab
        Returns:
        the help topic of this tab needs to point to
        Since:
        MicroStrategy Web 9.0.0