Package com.microstrategy.web.app.beans
Interface ToolbarBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebComponent
- All Known Subinterfaces:
ControlToolbarBean
,FormatToolbarBean
- All Known Implementing Classes:
ControlToolbarBeanImpl
public interface ToolbarBean extends AppComponent, RequestPersistable
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 thepageConfig.xml
file under the
<toolbars>
section.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDefaultState()
Returns the default state of the toolbar.java.lang.String
getInitialState()
Returns the initial state of the toolbar.ShortcutListSet
getToolbarInfo()
Returns the shortcut list definition from the PageManager object.java.lang.String
getToolbarName()
Returns the name of the shortcut list associated with the bean.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.void
setDefaultState(java.lang.String value)
Sets the default state of the toolbar.void
setInitialState(java.lang.String value)
Sets the initial state of the toolbar.void
setToolbarInfo(ShortcutListSet shortCutListSet)
Set the shortcut list set definition for this instance.void
setToolbarName(java.lang.String value)
Sets the name of the toolbar associated with the bean.-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
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
- aShortcutListSet
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 eventEnumToolbarBeanEvents.WebEventSetToolbarProperty
- Returns:
- the collection of toolbar properties
- Since:
- MicroStrategy Web 9.0.0
-
-