Package com.microstrategy.web.app.beans

Class OptimizedTabBeanImpl

    • Constructor Detail

      • OptimizedTabBeanImpl

        public OptimizedTabBeanImpl()

    • Method Detail

      • compareChildsTargetWithCurrent

        protected boolean compareChildsTargetWithCurrent()
        Description copied from class: AbstractAppComponent
        The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
        Overrides:
        compareChildsTargetWithCurrent in class AbstractAppComponent
        Returns:
        a boolean to compare the children's target with the current target.

      • setTabRepresented

        public void setTabRepresented​(int tabRepresented)
        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.
        Specified by:
        setTabRepresented in interface TabBean
        Parameters:
        tabRepresented - an identifier of the tab this instance represents.

      • setRequireSingleSelector

        public 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.
        Specified by:
        setRequireSingleSelector in interface TabBean
        Parameters:
        requireSingleSelector - boolean indicating whether a single selection on selector control is required for the tab to be available or not.

      • getTabRepresented

        public 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.
        Specified by:
        getTabRepresented in interface TabBean
        Returns:
        the identifier of the tab this instance represents

      • getRequireSingleSelector

        public 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.
        Specified by:
        getRequireSingleSelector in interface TabBean
        Returns:
        indicates whether a single selection on selector control is required for the tab to be available or not.

      • setTabName

        public 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.
        Specified by:
        setTabName in interface TabBean
        Parameters:
        tabName - the name identifier of the tab this instance represents

      • getTabName

        public 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.
        Specified by:
        getTabName in interface TabBean
        Returns:
        the name identifier of the tab this instance represents

      • setSwitchMode

        public void setSwitchMode​(int switchMode)
        the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content
        Specified by:
        setSwitchMode in interface TabBean
        Parameters:
        switchMode - the switching mode to set for this tab instance

      • getSwitchMode

        public int getSwitchMode()
        the switching mode can be: CACHED - use the cached tab content on the client side FETCH - go back to the webserver to fetch the tab content
        Specified by:
        getSwitchMode in interface TabBean
        Returns:
        the switching mode of this tab instance uses

      • setTabLabel

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

      • setTabLabelId

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

      • getTabLabel

        public java.lang.String getTabLabel()
        Get the description text to be used as title for the display of the tab.
        Specified by:
        getTabLabel in interface TabBean
        Returns:
        String with the text to be used as title of the tab.

      • getTabLabelId

        public java.lang.String getTabLabelId()
        Get the identifier of the descriptor to be used as title for the display of the tab.
        Specified by:
        getTabLabelId in interface TabBean
        Returns:
        String with the identifier of the descriptor to be used as title of the tab.

      • getTabId

        public java.lang.String getTabId()
        Description copied from interface: TabBean
        Returns a string can be used as the identifier of the tab.
        Specified by:
        getTabId in interface TabBean
        Returns:
        String with the text to be used as the id of the tab.
        Since:
        MicroStrategy Web 8.1.0
        See Also:
        TabBean.getTabId()

      • isAvailable

        public 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.
        Specified by:
        isAvailable in interface TabBean
        Returns:
        True if the instance is available for being displayed, if the user were to request it. Returns False otherwise.

      • setSupportedTypes

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

      • getSupportedTypes

        public java.lang.String getSupportedTypes()
        Get the list of objects this tab can be associated with.
        Specified by:
        getSupportedTypes in interface TabBean
        Returns:
        String with the a list of supported objects.

      • setFeatures

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

      • getFeatures

        public java.lang.String getFeatures()
        Gets a list of feature ids that are required to enable the tab
        Specified by:
        getFeatures in interface TabBean
        Returns:
        String

      • getEnabledCmdId

        public java.lang.String getEnabledCmdId()
        Get the command id to be queried on the clioent site. This determines the availability of the tab.
        Specified by:
        getEnabledCmdId in interface TabBean
        Returns:
        String with the tab's command id.
Specified by:
getXMLStatus in interface WebComponent
Overrides:
getXMLStatus in class AbstractAppComponent
Returns:
an EnumRequestStatus enumeration value for the component.
See Also:
WebComponent.getXMLStatus()