com.microstrategy.web.app.beans.ToolbarBean |
![]() |
Title: ToolbarBean.
Description: The toolbar bean represents a toolbar in the application, which is a control
that offers multiple options to users for manipulations in the form of buttons, combo boxes,
text, etc. This bean is designed to be used in combination with transforms such as
the ToolbarTransform
one to render
its interface.
The toolbar different elements are defined as a
ShortcutListSet
object which in turn is an XML definition of the different controls
it will include. These definitions are ultimately included on the pageConfig.xml
file under the
<toolbars>
section.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract String |
getDefaultState()
Returns the default state of the toolbar.
| ||||||||||
abstract String |
getInitialState()
Returns the initial state of the toolbar.
| ||||||||||
abstract ShortcutListSet |
getToolbarInfo()
Returns the shortcut list definition from the PageManager object.
| ||||||||||
abstract String |
getToolbarName()
Returns the name of the shortcut list associated with the bean.
| ||||||||||
abstract Map<String, String> |
getToolbarProps()
This object holds a collection of properties (key-value pairs) that are saved on the state of the bean.
| ||||||||||
abstract void |
setDefaultState(String value)
Sets the default state of the toolbar.
| ||||||||||
abstract void |
setInitialState(String value)
Sets the initial state of the toolbar.
| ||||||||||
abstract void |
setToolbarInfo(ShortcutListSet shortCutListSet)
Set the shortcut list set definition for this instance.
| ||||||||||
abstract void |
setToolbarName(String value)
Sets the name of the toolbar associated with the bean.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
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 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 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.
ShortcutListSet
instance containing the toolbar
definition associated with the toolbar bean.
Returns the name of the shortcut list associated with the bean. This is the name of a shortcut list in the Page Manager
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 WebEventSetToolbarProperty
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
value | String tooblar's default state |
---|
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
value | String tooblar's default state |
---|
Set the shortcut list set definition for this instance.
shortCutListSet | a ShortcutListSet instance containing the toolbar
definition to be associated with the toolbar bean.
|
---|
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.
value | PageManager name of the shortcut list. |
---|