Package com.microstrategy.web.app.beans

Interface FormatTabManagerBean

  • All Superinterfaces:
    AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, TabManagerBean, Transformable, WebComponent
    public interface FormatTabManagerBean
extends TabManagerBean
    This bean will be used for a tabbed control for formatting editor, for handling which tab should be shown, based on the children beans defined to this instance and the tab specification of each one of them. The manager should be used only when there's the possibility of multiple tabs being shown to the user as options. If it is for sure only one is to be shown, the manager is not required, since each child bean should be independent for processing the information and rendering its contents.
    Since:
    MicroStrategy Web 8.0.0

    • Method Detail

      • setActiveViewKey

        void setActiveViewKey​(java.lang.String activeViewKey)
        Set the active view key. It's used for initializing current bean from a view Bean.
        Parameters:
        activeViewKey - The specific element to set as active.

      • getActiveViewKey

        java.lang.String getActiveViewKey()
        Returns the active view key.
        Returns:
        String activeViewKey The specific element to set as active.

      • getViewBean

        ViewBean getViewBean()
        Utility method for obtaining the ViewBean indicated as target bean for this tab instance.
        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).

      • getTargetAxis

        int getTargetAxis()
        Get the axis where the target is located
        Returns:
        Element from the EnumDSSXMLAxisName enumeration

      • setTargetAxis

        void setTargetAxis​(int axis)
        Set the axis where the target is located
        Parameters:
        axis - Element from the EnumDSSXMLAxisName enumeration

      • getTargetPosition

        int getTargetPosition()
        Get the position in the axis where the target is located
        Returns:
        the index where the target is located

      • setTargetPosition

        void setTargetPosition​(int position)
        Set the position in the axis where the target is located
        Parameters:
        position - the index where the target is located

      • getTargetLevel

        int getTargetLevel()
        Get the level at which the formatting will be applied
        Returns:
        Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

      • setTargetLevel

        void setTargetLevel​(int level)
        Set the level at which the formatting will be applied
        Parameters:
        level - Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

      • setTargetAxisPosition

        void setTargetAxisPosition​(java.lang.String axisPosition)
        Set the axis and position of the target, based on a string with the value of the axis and the position separated by a comma. For example: 1,3 for the third element on the grid row.
        Parameters:
        axisPosition - String with value of the axis and position separated by a comma.

      • isCrossTab

        boolean isCrossTab()
        Returns true if the selected object is a cross tab object.
        Returns:
        true if the selected object is a cross tab object.

      • isPanelStack

        boolean isPanelStack()
        Returns:
        boolean value indicating if the selected object is a panel stack
        Since:
        MicroStrategy Web 8.1.0