Package com.microstrategy.web.app.gui

Interface Toolbar

  • All Superinterfaces:
    GuiElement
    public interface Toolbar
extends GuiElement

    Title: Toolbar.

    This GuiElement represents a toolbar object to be displayed on the interface to the user. A toolbar is a series of buttons, combo boxes and other options that are provided for the user to submit requests or manipulations with a single click action. This class is used by the ToolbarBean and its related transforms such as ToolbarTransform

    Since:
    MicroStrategy Web 8.0.0

    • Method Detail

      • setToolbarCss

        void setToolbarCss​(java.lang.String css)
        Define the css class to use for the global formatting of the toolbar to be displayed by this component.
        Parameters:
        css - String value with the name of the css class to use.

      • getToolbarCss

        java.lang.String getToolbarCss()
        Get the css class to use for the global formatting of the toolbar to be displayed by this component.
        Returns:
        String value with the name of the css class to use.

      • setBodyCss

        void setBodyCss​(java.lang.String css)
        Define the css class to use for the formatting of the body contents of the toolbar to be displayed by this component.
        Parameters:
        css - String value with the name of the css class to use.

      • getBodyCss

        java.lang.String getBodyCss()
        Get the css class to use for the formatting of the body contents of the toolbar to be displayed by this component.
        Returns:
        String value with the name of the css class to use.

      • setPickersCss

        void setPickersCss​(java.lang.String css)
        Define the css class to use for the formatting of the pickers that will be available on the toolbar
        Parameters:
        css - String value with the name of the css class to use

      • getPickersCss

        java.lang.String getPickersCss()
        Get the css class to use for the formatting of the pickers that will be available on the toolbar
        Returns:
        String value with the name of the css class to use

      • getBoneProps

        JsonGenerator getBoneProps()
        Generate an instance of JsonGenerator where properties of the toolbar will be saved for future use with JavaScript code defined for handling manipulations and requests on client side.
        Returns:
        JsonGenerator initialized instance where properties of the JavaScript component for this Toolbar can be defined.

      • setToolbar

        void setToolbar​(ShortcutListSet links)
        Set the list of ShortcutList elements which are to be rendered by this toolbar.
        Parameters:
        links - a ShortcutListSet instance with the list of ShortcutList elements that include the options this toolbar will provide.