Interface RWFrameBean

    • Field Detail

      • COMPONENT_OBJECT_BROWSER

        static final java.lang.String COMPONENT_OBJECT_BROWSER
        See Also:
        Constant Field Values
      • COMPONENT_MACROS_BROWSER

        static final java.lang.String COMPONENT_MACROS_BROWSER
        See Also:
        Constant Field Values
      • COMPONENT_GRAPH_TOOLBAR

        static final java.lang.String COMPONENT_GRAPH_TOOLBAR
        See Also:
        Constant Field Values
      • COMPONENT_CURRENT_EDITOR

        static final java.lang.String COMPONENT_CURRENT_EDITOR
        See Also:
        Constant Field Values
      • COMPONENT_LAST_UPDATE

        static final java.lang.String COMPONENT_LAST_UPDATE
        See Also:
        Constant Field Values
      • COMPONENT_EDITOR_MESSAGE

        static final java.lang.String COMPONENT_EDITOR_MESSAGE
        See Also:
        Constant Field Values
      • EDITABLE_VIEW_MODE_DEFAULT

        static final int EDITABLE_VIEW_MODE_DEFAULT
        Constat that represents the default view mode
        See Also:
        Constant Field Values
      • EDITABLE_VIEW_MODE_YES

        static final int EDITABLE_VIEW_MODE_YES
        Constat that represents that the RWD is in EDITABLE view mode
        See Also:
        Constant Field Values
      • EDITABLE_VIEW_MODE_NO

        static final int EDITABLE_VIEW_MODE_NO
        Constat that represents that the RWD is in NON EDITABLE view mode
        See Also:
        Constant Field Values
    • Method Detail

      • getRWBean

        RWBean getRWBean()
        Returns the RW bean associated with this RW frame bean.
        Returns:
        the RW bean associated with this RW frame bean
      • getRWObjectBrowserBean

        RWWorkingSetBrowserTabBean getRWObjectBrowserBean()
        Returns the ObjectBrowser bean associated with this RW frame bean.
        Returns:
        the ObjectBrowser bean associated with this RW frame bean
      • getDesignMode

        int getDesignMode()
        Returns the view mode of the RW frame bean (a value from EnumReportViewModes)
        Returns:
        the view mode of the RW frame bean (a value from EnumReportViewModes)
      • getIsDesignMode

        boolean getIsDesignMode()
        Returns whether the view mode of the RW frame bean (a value from EnumReportViewModes) is equal to EnumReportViewModes.ReportViewModeDesign
        Returns:
        boolean true if the the RW frame bean is in design mode
        Since:
        MicroStrategy Web 9.0.0
      • getIsDatasetAdded

        boolean getIsDatasetAdded()
        Returns whether a dataset hs been added to the RW frame bean
        Returns:
        a boolean indicating if a dataset has been added to the frame bean
        Since:
        MicroStrategy Web 8.0.1
      • setDesignMode

        void setDesignMode​(int designMode)
        Sets the view mode of the RW frame bean (a value from EnumReportViewModes)
        Parameters:
        designMode - the view mode of the RW frame bean (a value from EnumReportViewModes)
      • setIsDatasetAdded

        void setIsDatasetAdded​(boolean isDatasetAdded)
        Sets the the value of isDatasetAdded
        Parameters:
        isDatasetAdded - The boolean value indicating whether a dataset object has been added to the frame bean
        Since:
        MicroStrategy Web 8.0.1
      • getSelections

        java.lang.String getSelections()
        Returns the comma seperated list of client side selections
        Returns:
        the comma seperated list of client side selections
      • setSelections

        void setSelections​(java.lang.String selections)
        Sets the the comma seperated list of client side selections
        Parameters:
        selections - The comma seperated list of client side selections
      • getViewerScroll

        java.lang.String getViewerScroll()
        Returns the scroll top and left for the viewer. It is stored in a comma seperated format with the scroll top followed by the scroll left.
        Returns:
        The comma seperated value of the viewer top scroll and viewer left scroll
        Since:
        MicroStrategy Web 8.0.2
      • setViewerScroll

        void setViewerScroll​(java.lang.String scrollPosition)
        Set the scroll top and left for the viewer. It is stored in a comma seperated format with the scroll top followed by the scroll left.
        Parameters:
        scrollPosition - The comma seperated value of the viewer top scroll and viewer left scroll
        Since:
        MicroStrategy Web 8.0.2
      • isRulersOn

        boolean isRulersOn()
        Returns:
        boolean true if the rulers for the document should be on
      • setIsRulersOn

        void setIsRulersOn​(boolean value)
        Sets whether the rulers for the document should be on.
        Parameters:
        value - true if on.
      • isAlignmentGridOn

        boolean isAlignmentGridOn()
        Returns:
        boolean true if the alignment grid for the document should be on
      • setIsAlignmentGridOn

        void setIsAlignmentGridOn​(boolean value)
        Sets whether the alignment grid for the document should be on.
        Parameters:
        value - true if on.
      • isSectionDividersOn

        boolean isSectionDividersOn()
        Returns:
        boolean true if the section's dividers for the document should be on
      • setIsSectionDividersOn

        void setIsSectionDividersOn​(boolean value)
        Sets whether the section divider for the document should be on.
        Parameters:
        value - true if on.
      • getEditableViewMode

        int getEditableViewMode()
        Deprecated.
        Use getCurrentViewMedia instead.
        Returns current view mode of the RWD with respect to editable or non editable
        Returns:
        current view mode of the RWD with respect to editable or non editable
      • setEditableViewMode

        void setEditableViewMode​(int value)
        Deprecated.
        Use setCurrentViewMedia instead.
        Sets the current view mode of the RWD with respect to editable or non editable
        Parameters:
        value - The current view mode of the RWD with respect to editable or non editable
      • getPromptsContainerBean

        PromptsContainerBean getPromptsContainerBean()
        Get the Prompts Container Bean.
        Returns:
        the prompts container bean associated with the frame
        Since:
        MicroStrategy Web 9.0.0
      • getCurrentViewMode

        int getCurrentViewMode()
        Deprecated.
        please use getCurrentViewMedia
        Return the current view mode.
        Returns:
        Integer
        Since:
        MicroStrategy Web 8.1.0
      • getCurrentViewMedia

        int getCurrentViewMedia()
        Since:
        MicroStrategy Web 9.0.0
      • getAvailableViewModes

        int getAvailableViewModes()
        Deprecated.
        please use getAvailableViewMedia
        Return the current available view modes.
        Returns:
        Integer
        Since:
        MicroStrategy Web 8.1.0
      • getAvailableViewMedia

        int getAvailableViewMedia()
        Since:
        MicroStrategy Web 9.0.0
      • setCurrentViewMode

        void setCurrentViewMode​(int viewMode)
        Deprecated.
        please use setCurrentViewMedia
        Set the current view mode.
        Parameters:
        viewMode -
        Since:
        MicroStrategy Web 8.1.0
      • setCurrentViewMedia

        void setCurrentViewMedia​(int viewMedia)
        Since:
        MicroStrategy Web 9.0.0
      • convertIVEToDocument

        void convertIVEToDocument()
        Converts an IVE document to a Report Services Document
        Since:
        MicroStrategy Web 9.2.1