Interface ToolbarBean

    • Method Detail

      • setToolbarName

        void setToolbarName​(java.lang.String value)
        Sets the name of the toolbar associated with the bean. The bean will search for a shortcut list in the PageManager that matches the name.
        Parameters:
        value - PageManager name of the shortcut list.
      • getToolbarName

        java.lang.String getToolbarName()
        Returns the name of the shortcut list associated with the bean. This is the name of a shortcut list in the Page Manager
        Returns:
        the Name of the shortcut list from the PageManager associated with the bean
      • getToolbarInfo

        ShortcutListSet getToolbarInfo()
        Returns the shortcut list definition from the PageManager object. The shortcut list from the PageManager must match by name with the toolbar name property of the toolbar bean instace.
        Returns:
        a ShortcutListSet instance containing the toolbar definition associated with the toolbar bean.
      • setToolbarInfo

        void setToolbarInfo​(ShortcutListSet shortCutListSet)
        Set the shortcut list set definition for this instance.
        Parameters:
        shortCutListSet - a ShortcutListSet instance containing the toolbar definition to be associated with the toolbar bean.
      • setDefaultState

        void setDefaultState​(java.lang.String value)
        Sets the default state of the toolbar. Allowed values are "open" - indicates the toolbar will be open by default "closed" - indicates the toolbar will be closed by default
        Parameters:
        value - String tooblar's default state
      • getDefaultState

        java.lang.String getDefaultState()
        Returns the default state of the toolbar. Allowed values are "open" - indicates the toolbar will be open by default "closed" - indicates the toolbar will be closed by default
        Returns:
        String tooblar's default state
      • setInitialState

        void setInitialState​(java.lang.String value)
        Sets the initial state of the toolbar. Allowed values are "open" - indicates the toolbar will be open by default "closed" - indicates the toolbar will be closed by default
        Parameters:
        value - String tooblar's default state
        Since:
        MicroStrategy Web 8.1.0
      • getInitialState

        java.lang.String getInitialState()
        Returns the initial state of the toolbar. Allowed values are "open" - indicates the toolbar will be open by default "closed" - indicates the toolbar will be closed by default
        Returns:
        String tooblar's default state
        Since:
        MicroStrategy Web 8.1.0
      • getToolbarProps

        java.util.Map<java.lang.String,​java.lang.String> getToolbarProps()
        This object holds a collection of properties (key-value pairs) that are saved on the state of the bean.
        Properties will be added to its respective toolbar bone for use on the client side.
        Properties can be set on this bean using event EnumToolbarBeanEvents.WebEventSetToolbarProperty
        Returns:
        the collection of toolbar properties
        Since:
        MicroStrategy Web 9.0.0