Package com.microstrategy.web.app.beans

Class ReportFrameBeanImpl

    • Field Detail

      • REPORT_FILTER_NAME

        protected static final java.lang.String REPORT_FILTER_NAME
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • REPORT_LIMIT_NAME

        protected static final java.lang.String REPORT_LIMIT_NAME
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • VIEW_FILTER_NAME

        protected static final java.lang.String VIEW_FILTER_NAME
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • VIEW_LIMIT_NAME

        protected static final java.lang.String VIEW_LIMIT_NAME
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • _editor

        protected java.lang.String _editor
        Local property which value reflects the current editor
        Since:
        MicroStrategy Web 8.0.0

      • _promptStyle

        protected java.lang.String _promptStyle
        Local property which stores the actual prompt style used.
        Since:
        MicroStrategy Web 7.5.1

    • Method Detail

      • getIFrameComponent

        public java.lang.Object getIFrameComponent​(java.lang.String name)
        Description copied from interface: FrameBean
        Returns the associated object associated with the iFrame component. An iFrame component is any part of the interface that can be refreshed independently when using iFrames, for example a Bean, the current editor, the menus or the editor's message.
        Specified by:
        getIFrameComponent in interface FrameBean
        Parameters:
        name - String with the name of the iframe component to look for
        Returns:
        the corresponding iFrame component for the given name
        Since:
        MicroStrategy Web 8.0.0

      • getDesignMode

        public int getDesignMode()
        Returns the view mode of the report frame bean (a value from EnumReportViewModes)
        Specified by:
        getDesignMode in interface ReportFrameBean
        Returns:
        the view mode of the report frame bean (a value from EnumReportViewModes)

      • getExecutionMode

        public int getExecutionMode()
        Returns the view mode of the report frame bean (a value from EnumReportViewModes)
        Specified by:
        getExecutionMode in interface ReportFrameBean
        Returns:
        the view mode of the report frame bean (a value from EnumReportViewModes)

      • setDesignMode

        public void setDesignMode​(int designMode)
        Sets the view mode of the report frame bean (a value from EnumReportViewModes)
        Specified by:
        setDesignMode in interface ReportFrameBean
        Parameters:
        designMode - the view mode of the report frame bean (a value from EnumReportViewModes)

      • setExecutionMode

        public void setExecutionMode​(int executeMode)
        Sets the view mode of the report frame bean (a value from EnumReportViewModes)
        Specified by:
        setExecutionMode in interface ReportFrameBean
        Parameters:
        executeMode - the view mode of the report frame bean (a value from EnumReportViewModes)

      • setDesignModeStage

        public void setDesignModeStage​(int designModeStage)
        Sets the design mode stage of the report frame bean
        Specified by:
        setDesignModeStage in interface ReportFrameBean
        Parameters:
        designModeStage - the design mode stage of the report frame bean (a value from EnumReportDesignMode)

      • getDesignModeStage

        public int getDesignModeStage()
        Check the preferences for the name of the editor that will be displayed with this request.
        Specified by:
        getDesignModeStage in interface ReportFrameBean
        Returns:
        the name of the editor to be displayed for this frame

      • getCurrentEditor

        public FrameElement getCurrentEditor()
        It returns which is the current editor to be displayied. Formatting editors (Grid or Graph), if current, are not considered.
        Specified by:
        getCurrentEditor in interface FrameBean
        Returns:
        the current editor,

      • shouldDisplayContent

        public boolean shouldDisplayContent​(java.lang.String name)
        Description copied from interface: FrameBean
        Returns false if an iFrame component needs not to be rendered in an iFrame request.
        Specified by:
        shouldDisplayContent in interface FrameBean
        Parameters:
        name - the component to render
        Returns:
        false if the component should not be rendered, true otherwise.

      • isReportToolbarEnabled

        public boolean isReportToolbarEnabled()
        Description copied from interface: ReportFrameBean
        Returns true if the report toolbar should be enabled
        Specified by:
        isReportToolbarEnabled in interface ReportFrameBean
        Returns:
        isReportToolbarEnabled

      • isOpen

        public boolean isOpen​(FrameElement element)
        Identifies if the given ReportFrameElement is open. To identify whether a FrameElement is open, The ReportFrameBean checks the following:
        Specified by:
        isOpen in interface FrameBean
        Parameters:
        element - FrameElement instance to check if it's opened or not
        Returns:
        true if the element is open.

      • isObjectBrowserOpen

        protected boolean isObjectBrowserOpen()
        Checks if the given ObjectBrowserManagerBean is open
        Returns:
        true if the element is open.
        Since:
        MicroStrategy Web 8.0.0

      • doCollectData

        public void doCollectData()
        For performance, this method overrides the default collectData() by checking if the ReportBean will be displayed, and if not it will not trigger it's collectData().
        Overrides:
        doCollectData in class AbstractAppComponent
        Since:
        MicroStrategy Web 8.0.0

      • addChildStateInfo

        public void addChildStateInfo​(ParameterBuilder paramBldr,
                              int howMuchState)
        Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized. Overrides addChildStateInfo() for the smartCollectData case: When doing smartCollectData we change some settings in the Result flags or the WindowSettings of the report data to bring less information. We don't want these changes to be saved in the state of the report bean, so its state is saved before this changes and this method appends that state, instead of the current one.
        Specified by:
        addChildStateInfo in interface WebComponent
        Overrides:
        addChildStateInfo in class AbstractPersistableAppComponent
        Parameters:
        paramBldr - The ParameterBuilder instance which has child state information added to it.
        howMuchState - How much persistable state of EnumWebPersistableState to return from its children.
        Since:
        MicroStrategy Web 8.0.0

      • getReportStyleLocalizedName

        public java.lang.String getReportStyleLocalizedName()
        Specified by:
        getReportStyleLocalizedName in interface ReportFrameBean
        Returns:
        the report bean's localized style name. It's used for old-formatting reports to apply style first before other formattig manipulation. For new-formatting reports, it returns "".

      • setXMLStatus

        public void setXMLStatus​(int value)
        Sets the EnumRequestStatus status of the bean.
        Specified by:
        setXMLStatus in interface ReportFrameBean
        Parameters:
        value - The XML status value ofor this bean.

      • getObjectBrowserBean

        public ObjectBrowserBean getObjectBrowserBean()
        Deprecated.
        This method should no longer be used. Use getObjectBrowserTabMgrBean instead.
        Returns the ObjectBrowser bean associated with this report frame bean.
        Specified by:
        getObjectBrowserBean in interface ReportFrameBean
        Returns:
        the DynamicMenu bean associated with this report frame bean

      • getObjectBrowserTabMgrBean

        public ObjectBrowserManagerBean getObjectBrowserTabMgrBean()
        Returns the ObjectBrowser bean associated with this report frame bean. The Object Browser is now a TabManager bean.
        Specified by:
        getObjectBrowserTabMgrBean in interface ReportFrameBean
        Returns:
        TabManagerBean
        Since:
        MicroStrategy Web 8.0.0

      • setReportEditorName

        public void setReportEditorName​(java.lang.String value)
        Sets the name of the report editor to be open
        Specified by:
        setReportEditorName in interface ReportFrameBean
        Parameters:
        value - The name of the report editor to be open
        Since:
        MicroStrategy Web 8.0.0

      • getReportEditorName

        public java.lang.String getReportEditorName()
        Retrieves the name of the current open report editor
        Specified by:
        getReportEditorName in interface ReportFrameBean
        Returns:
        The name of the current open report editor
        Since:
        MicroStrategy Web 8.0.0

      • getChild

        public WebComponent getChild​(java.lang.String key)
        Get the child instance based on the key passed as argument
        Specified by:
        getChild in interface WebComponent
        Overrides:
        getChild in class AbstractWebComponent
        Parameters:
        key - String value with the name to look for
        Returns:
        WebComponent instance corresponding to the key
        Since:
        MicroStrategy Web 8.0.0

      • isEventNeedsToCollectData

        public boolean isEventNeedsToCollectData()
        Returns:
        Returns the _eventNeedsToCollectData.
        Since:
        MicroStrategy Web 8.0.1

      • setEventNeedsToCollectData

        public void setEventNeedsToCollectData​(boolean needsToCollectData)
        Parameters:
        needsToCollectData - The _eventNeedsToCollectData to set.
        Since:
        MicroStrategy Web 8.0.1

      • setRefreshGrid

        public void setRefreshGrid​(boolean value)
        Description copied from interface: ReportFrameBean
        Sets a flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.
        Specified by:
        setRefreshGrid in interface ReportFrameBean
        Since:
        MicroStrategy Web 8.1.1

      • getRefreshGrid

        public boolean getRefreshGrid()
        Description copied from interface: ReportFrameBean
        Retrieves the flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.
        Specified by:
        getRefreshGrid in interface ReportFrameBean
        Since:
        MicroStrategy Web 8.1.1

      • addChild

        public void addChild​(java.lang.String key,
                     WebComponent child)
        Description copied from class: AbstractWebComponent
        Adds a child component to the current WebComponent. This call invalidates the cached states.
        Specified by:
        addChild in interface WebComponent
        Overrides:
        addChild in class AbstractWebComponent
        Parameters:
        key - the key mapped to the child component.
        child - the child component to add.
        Since:
        MicroStrategy Web 9.0.0

      • setNoActionFlagRemoved

        public void setNoActionFlagRemoved​(boolean noActionFlagRemoved)
        Description copied from interface: ReportFrameBean
        Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode
        Specified by:
        setNoActionFlagRemoved in interface ReportFrameBean
        Parameters:
        noActionFlagRemoved - boolean true indicates we just remove the noAction flag from the executionFlags when switch a report from design mode to view mode

      • isNoActionFlagRemoved

        public boolean isNoActionFlagRemoved()
        Specified by:
        isNoActionFlagRemoved in interface ReportFrameBean
        Returns:
        whether we have just removed the noAction flag from the executionFlags when switch a report from design mode to view mode

      • isIframeEnabled

        public boolean isIframeEnabled()
        Determines if the instance is enabled to work on IFrame environments
        Returns:
        boolean value indicating whether IFrame is enabled for this component

      • setUseIFrame

        public void setUseIFrame​(boolean value)
        Description copied from interface: FrameBean
        Defines if the ReportFrame should use IFrame
        Specified by:
        setUseIFrame in interface FrameBean
        Parameters:
        value - if true, the ReportFrame will use IFrames

      • getUseIFrame

        public boolean getUseIFrame()
        Description copied from interface: FrameBean
        Returns if the ReportFrame uses IFrames
        Specified by:
        getUseIFrame in interface FrameBean
        Returns:
        true if frames are used.

      • isIFrameRequest

        protected boolean isIFrameRequest()
        Description copied from class: AbstractAppComponent
        Utility method that determines if it's an IFrame type of request.
        Overrides:
        isIFrameRequest in class AbstractAppComponent
        Returns:
        boolean value indicating if the request is of type IFrame or not. By default it is based only on information available on the RequestKeys associated with this instance.

      • setEditorMessage

        public void setEditorMessage​(java.lang.String message)
        This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.
        Specified by:
        setEditorMessage in interface FrameBean
        Parameters:
        message - the message to be shown.
        Since:
        MicroStrategy Web 8.0.0

      • getEditorMessage

        public java.lang.String getEditorMessage()
        This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.
        Specified by:
        getEditorMessage in interface FrameBean
        Returns:
        the message to be shown.
        Since:
        MicroStrategy Web 8.0.0

      • getFormulaBarBean

        public FormulaBarBean getFormulaBarBean()
        Returns the formular bar bean within this report frame bean.
        Returns:
        the formular bar bean within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getGridFormatToolbarBean

        public GridFormatToolbarBean getGridFormatToolbarBean()
        Returns the grid format toolbar bean within this report frame bean.
        Returns:
        the grid format toolbar within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getGraphFormatToolbarBean

        public GraphFormatToolbarBean getGraphFormatToolbarBean()
        Returns the graph format toolbar bean within this report frame bean.
        Returns:
        the graph format toolbar within this report frame bean
        Since:
        MicroStrategy Web 8.0.0

      • getReportFilterEditor

        public FilterEditorBean getReportFilterEditor()
        Returns the report filter editor bean within this report frame bean.
        Returns:
        the report filter editor bean within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getViewFilterEditor

        public FilterEditorBean getViewFilterEditor()
        Returns the view filter editor bean within this report frame bean.
        Returns:
        the view filter editor bean within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getGridFormatEditorBean

        public GridFormatEditorBean getGridFormatEditorBean()
        Returns the grid format editor bean within this report frame bean.
        Returns:
        the grid format editor within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getGraphFormatEditorBean

        public GraphFormatEditorBean getGraphFormatEditorBean()
        Returns the graph format editor bean within this report frame bean.
        Returns:
        the graph format editor within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getDrillEditorBean

        public DrillEditorBean getDrillEditorBean()
        Returns the drill editor bean within this report frame bean.
        Returns:
        the drill editor bean within this report frame bean.
        Since:
        MicroStrategy Web 8.0.0

      • getSortEditorBean

        public SortEditorBean getSortEditorBean()
        Returns:
        SortEditorBean instance associated with this bean
        Since:
        MicroStrategy Web 8.0.0

      • getResizeEditorBean

        public ResizeEditorBean getResizeEditorBean()
        Returns:
        ResizeEditorBean instance associated with this bean
        Since:
        MicroStrategy Web 8.0.0

      • getMenus

        public Menu getMenus()
        Description copied from interface: FrameBean
        Returns the menus for this FrameBean based on the dynamicMenuName property.
        Specified by:
        getMenus in interface FrameBean
        Returns:
        Menu instance associated with this bean
        Since:
        MicroStrategy Web 8.0.0

      • setDynamicMenuName

        public void setDynamicMenuName​(java.lang.String dynamicMenuName)
        Set the name of the dynamic menu to be associated with this instance
        Specified by:
        setDynamicMenuName in interface FrameBean
        Parameters:
        dynamicMenuName - String with the name of the dynamic menu to be associated with this bean
        Since:
        MicroStrategy Web 8.0.0

      • getDynamicMenuName

        public java.lang.String getDynamicMenuName()
        Description copied from interface: FrameBean
        Name of the Shortcut object to use as Dynamic Menu
        Specified by:
        getDynamicMenuName in interface FrameBean
        Returns:
        the name of the dynamic menu associated with this instance
        Since:
        MicroStrategy Web 8.0.0

      • getReportBean

        public ReportBean getReportBean()
        Returns the report bean associated with this report frame bean.
        Returns:
        the report bean associated with this report frame bean
        Since:
        MicroStrategy Web 8.0.0

      • getDocumentBean

        public DocumentBean getDocumentBean()
        Returns the report bean associated with this report frame bean.
        Returns:
        the report bean associated with this report frame bean
        Since:
        MicroStrategy Web 8.0.0

      • getRWBean

        public RWBean getRWBean()
        Returns the rw bean associated with this report frame bean.
        Returns:
        the rw bean associated with this report frame bean
        Since:
        MicroStrategy Web 8.0.0

      • setCookie

        protected void setCookie​(java.lang.String key,
                         java.lang.String value)
        Set a cookie value as specified
        Parameters:
        key - name of the cookie to modify
        value - String with the value to assign to the specified cookie key
        Since:
        MicroStrategy Web 8.0.0

      • setPromptStyle

        public void setPromptStyle​(java.lang.String style)
        Specifies which style to use for prompt transforms.
        This property indicates what prompt style to use when transforming a prompted Bean.
        Specified by:
        setPromptStyle in interface FrameBean
        Parameters:
        style - String
        Since:
        MicroStrategy Web 7.5.1

      • getPromptStyle

        public java.lang.String getPromptStyle()
        Indicates actual prompt style used.
        Specified by:
        getPromptStyle in interface FrameBean
        Returns:
        String name of prompt style.
        Since:
        MicroStrategy Web 7.5.1

      • searchChildByClass

        protected WebComponent searchChildByClass​(java.lang.Class beanClass)