Package com.microstrategy.web.app.gui

Interface GuiComponent

  • All Superinterfaces:
    GuiElement
    public interface GuiComponent
extends GuiElement

    Title: GuiComponent.

    Description: interface for gui component. Each gui component represents a gui unit like grid, report editor, object browser.

    Copyright: Copyright (c) 2002

    Company: Microstrategy, Inc.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • setGuiComponentInfo

        void setGuiComponentInfo​(WebGuiComponent newValue)
        set the WebGuiComponent info for this gui component. WebGuiComponent is one of the application configuration element
        Parameters:
        newValue - WebGuiComponent object

      • getGuiComponentInfo

        WebGuiComponent getGuiComponentInfo()
        get the WebGuiComponent info for this gui component.
        Returns:
        the associated WebGuiComponent object

      • setStyle

        void setStyle​(java.lang.String newValue)
        set the style name for the gui component. The style name is defined in the style catalog.
        Parameters:
        newValue - style name

      • setRootWebComponent

        void setRootWebComponent​(WebComponent newValue)
        set the root WebComponent for this gui component
        Parameters:
        newValue - the root WebComponent object

      • getRootWebComponent

        WebComponent getRootWebComponent()
        get the root WebComponent for this gui component
        Returns:
        the root WebComponent object

      • setPreferences

        void setPreferences​(Preferences newValue)
        set the Preferences object for this gui component
        Parameters:
        newValue - the Preferences object

      • getPreferences

        Preferences getPreferences()
        get the Preferences object for this gui component
        Returns:
        the Preferences object

      • setRequestKeys

        void setRequestKeys​(RequestKeys newValue)
        set the Request Keys object for this gui component
        Parameters:
        newValue - the RequestKeys object
        Since:
        MicroStrategy Web 8.0.2

      • getRequestKeys

        RequestKeys getRequestKeys()
        get the RequestKeys object for this gui component
        Returns:
        the RequestKeys object
        Since:
        MicroStrategy Web 8.0.2

      • setIsContainer

        void setIsContainer​(boolean newValue)
        set whether the gui component serves as a container for other gui components
        Parameters:
        newValue - whether the gui component serves as a container for other gui components

      • IsContainer

        boolean IsContainer()
        get whether the gui component serves as a container for other gui components
        Returns:
        whether the gui component serves as a container for other gui components

      • setDisplayMode

        void setDisplayMode​(java.lang.String newValue)
        set the display mode used when the GuiComponent renders itself
        Parameters:
        newValue - String the display mode: AppContext.DISPLAY_MODE_HTML - plain HTML AppContext.DISPLAY_MODE_JSON - the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated} or {id: if of the component, components: sub json blocks}

      • getDisplayMode

        java.lang.String getDisplayMode()
        get the display mode used when the GuiComponent renders itself

      • setRenderBlock

        void setRenderBlock​(boolean value)
        set the flag to signal whether this GuiComponent allows sub json blocks to render so that partial update happens within the original GuiComponent
        Parameters:
        value - boolean true if it allows sub json blocks' existence false if only plain HTML will be output as content

      • renderBlock

        boolean renderBlock()
        the boolean indicates whether this GuiComponent allows sub json blocks to update or just pure HTML
        Returns:
        the boolean flag

      • setIsIframeRequest

        void setIsIframeRequest​(boolean newValue)
        set whether the current request is an iframe request
        Parameters:
        newValue - whether the current request is an iframe request

      • getIsIframeRequest

        boolean getIsIframeRequest()
        get whether the current request is an iframe request
        Returns:
        whether the current request is an iframe request
        Since:
        MicroStrategy Web 8.0.0

      • setFormalParameter

        void setFormalParameter​(java.lang.String name,
                        java.lang.Object value)
        Set the formal parameter on the GUI component. These will be set on the transform which the GUI component is rendering.
        Parameters:
        name - The name of the formal paramter whose value we want to set
        value - The value of the formal parameter
        Since:
        MicroStrategy Web 8.0.1

      • IsIframeRequest

        @Deprecated
boolean IsIframeRequest()
        Deprecated.
        get whether the current request is an iframe request
        Returns:
        whether the current request is an iframe request

      • isAppendNewLine

        boolean isAppendNewLine()
        Return whether the GUI component is configured to render a new line character at the end of the output.
        Returns:

      • setAppendNewLine

        void setAppendNewLine​(boolean appendNewLine)
        Set whether the GUIComponent should render a new line character at the end of the output. By default this is set to true. You can use this method to disable rendering a new line.
        Parameters:
        appendNewLine -