Package com.microstrategy.web.app.beans

Class ControlToolbarBeanImpl

    • Constructor Detail

      • ControlToolbarBeanImpl

        public ControlToolbarBeanImpl()
        Default constructor

    • Method Detail

      • getControl

        public java.lang.String getControl()
        Specified by:
        getControl in interface ControlToolbarBean
        Returns:
        the id of initial selected control button on the control toolbar

      • setControl

        public void setControl​(java.lang.String control)
        Description copied from interface: ControlToolbarBean
        Sets the id of initial selected control button on the control toolbar
        Specified by:
        setControl in interface ControlToolbarBean
        Parameters:
        control - String

      • getLock

        public int getLock()
        Description copied from interface: ControlToolbarBean
        Returns the initial state of the lock button on the control toolbar
        Specified by:
        getLock in interface ControlToolbarBean
        Returns:
        int -1 - doesn't apply 0 - Lock is off 1 - Lock is on

      • setLock

        public void setLock​(int lock)
        Description copied from interface: ControlToolbarBean
        Sets the initial state of the lock button on the control toolbar.
        Specified by:
        setLock in interface ControlToolbarBean
        Parameters:
        lock - int

      • doFlatState

        protected void doFlatState​(FlatStateSerializer serializer,
                           int howMuchState,
                           FlatStateTokenizer tokenizer)
        Utility method for collecting the bean's state and save it on a string representation
        Parameters:
        serializer - FlatStateSerializer instance
        howMuchState - int value indicating how much state should be saved for the bean
        tokenizer - FlatStateTokenizer instance

      • newDefaultEventHandler

        protected WebEventHandler newDefaultEventHandler()
        Since:
        MicroStrategy Web 9.0.0

      • getToolbarInfo

        public ShortcutListSet getToolbarInfo()
        Description copied from interface: ToolbarBean
        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.
        Specified by:
        getToolbarInfo in interface ToolbarBean
        Returns:
        a ShortcutListSet instance containing the toolbar definition associated with the toolbar bean.
        See Also:
        ToolbarBean.getToolbarInfo()

      • setToolbarName

        public void setToolbarName​(java.lang.String value)
        Description copied from interface: ToolbarBean
        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.
        Specified by:
        setToolbarName in interface ToolbarBean
        Parameters:
        value - PageManager name of the shortcut list.
        See Also:
        ToolbarBean.setToolbarName(String)

      • getToolbarName

        public java.lang.String getToolbarName()
        Description copied from interface: ToolbarBean
        Returns the name of the shortcut list associated with the bean. This is the name of a shortcut list in the Page Manager
        Specified by:
        getToolbarName in interface ToolbarBean
        Returns:
        the Name of the shortcut list from the PageManager associated with the bean
        See Also:
        ToolbarBean.getToolbarName()

      • setDefaultState

        public 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
        Specified by:
        setDefaultState in interface ToolbarBean
        Parameters:
        value - String tooblar's default state

      • getDefaultState

        public java.lang.String getDefaultState()
        Returls 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
        Specified by:
        getDefaultState in interface ToolbarBean
        Returns:
        String tooblar's default state

      • setInitialState

        public 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
        Specified by:
        setInitialState in interface ToolbarBean
        Parameters:
        value - String tooblar's default state
        Since:
        MicroStrategy Web 8.1.0

      • getInitialState

        public java.lang.String getInitialState()
        Returls 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
        Specified by:
        getInitialState in interface ToolbarBean
        Returns:
        String tooblar's default state
        Since:
        MicroStrategy Web 8.1.0

      • isOpen

        public boolean isOpen()
        Returns a boolean value indicating if the instance is marked as opened or closed.
        Specified by:
        isOpen in interface AppComponent
        Overrides:
        isOpen in class AbstractPersistableFrameElement
        Returns:
        boolean value of True if the instance is marked as opened, it will return False otherwise. By default, instances not marked as dialogs (isDialog() property returning False) will have a browser setting associated with them that should indicate if they are opened or closed. The parent hierarchy is also tested to be in opened state as well as dependent beans not to be in error.
        Since:
        MicroStrategy Web 8.0.0

      • getToolbarProps

        public java.util.HashMap<java.lang.String,​java.lang.String> getToolbarProps()
        Description copied from interface: ToolbarBean
        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
        Specified by:
        getToolbarProps in interface ToolbarBean
        Returns:
        the collection of toolbar properties