Package com.microstrategy.web.app.beans

Interface FrameBean

    • Method Detail

      • setUseIFrame

        void setUseIFrame​(boolean value)
        Defines if the ReportFrame should use IFrame
        Parameters:
        value - if true, the ReportFrame will use IFrames

      • getUseIFrame

        boolean getUseIFrame()
        Returns if the ReportFrame uses IFrames
        Returns:
        true if frames are used.

      • getIFrameComponent

        java.lang.Object getIFrameComponent​(java.lang.String name)
        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.
        Parameters:
        name - the component's unique key
        Returns:
        the object associated with the key. Null if no component is defined for that key.
        Since:
        MicroStrategy Web 8.0.0

      • shouldDisplayContent

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

      • openElement

        void openElement​(FrameElement element)
        Mark as opened the corresponding FrameElement
        Parameters:
        element - the element to open

      • closeElement

        void closeElement​(FrameElement element)
        Mark as closed the corresponding FrameElement
        Parameters:
        element - the element to close

      • isOpen

        boolean isOpen​(FrameElement element)
        Checks if the given FrameElement is open
        Parameters:
        element - Element to check
        Returns:
        true if the element is open.

      • getTargetBean

        WebComponent getTargetBean()
        Returns the target bean associated with this FrameBean. The target bean is the one with the main data.
        Specified by:
        getTargetBean in interface WebComponent
        Returns:
        the target bean for this Frame.
        Since:
        MicroStrategy Web 8.0.0

      • getCurrentEditor

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

      • setEditorMessage

        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.
        Parameters:
        message - the message to be shown.
        Since:
        MicroStrategy Web 8.0.0

      • getEditorMessage

        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.
        Returns:
        the message to be shown.
        Since:
        MicroStrategy Web 8.0.0

      • getMenus

        Menu getMenus()
        Returns the menus for this FrameBean based on the dynamicMenuName property.
        Returns:
        a Menu object for this FrameBean.
        Since:
        MicroStrategy Web 8.0.0

      • setDynamicMenuName

        void setDynamicMenuName​(java.lang.String dynamicMenuName)
        Name of the Shortcut object to use as DynamicMenu
        Parameters:
        dynamicMenuName - the name ot use
        Since:
        MicroStrategy Web 8.0.0

      • getDynamicMenuName

        java.lang.String getDynamicMenuName()
        Name of the Shortcut object to use as Dynamic Menu
        Returns:
        the DynamicMenu name
        Since:
        MicroStrategy Web 8.0.0

      • setMessageBeforeData

        @Deprecated
void setMessageBeforeData​(java.lang.String message)
        Deprecated.
        use setEditorMessage(String)

      • getMessageBeforeData

        @Deprecated
java.lang.String getMessageBeforeData()
        Deprecated.
        use getEditorMessage()

      • setPromptStyle

        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.
        Parameters:
        style - String
        Since:
        MicroStrategy Web 7.5.1

      • getPromptStyle

        java.lang.String getPromptStyle()
        Indicates actual prompt style used.
        Returns:
        String name of prompt style.
        Since:
        MicroStrategy Web 7.5.1