Package com.microstrategy.web.app.beans
Class ControlToolbarBeanImpl
- java.lang.Object
-
- com.microstrategy.utils.serialization.AbstractPersistable
-
- com.microstrategy.web.beans.AbstractTransformable
-
- com.microstrategy.web.beans.AbstractWebComponent
-
- com.microstrategy.web.app.beans.AbstractAppComponent
-
- com.microstrategy.web.app.beans.AbstractPersistableAppComponent
-
- com.microstrategy.web.app.beans.AbstractPersistableFrameElement
-
- com.microstrategy.web.app.beans.ControlToolbarBeanImpl
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AppComponent
,ControlToolbarBean
,ToolbarBean
,RequestPersistable
,Transformable
,WebComponent
public class ControlToolbarBeanImpl extends AbstractPersistableFrameElement implements ControlToolbarBean
- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
STATE_DELIMITOR, STATE_ITEM_SEPARATOR
-
Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent
_features, _hasJustOpened
-
Fields inherited from class com.microstrategy.web.beans.AbstractTransformable
_beanContext
-
Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable
scriptEndTagEncoder
-
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
-
-
Constructor Summary
Constructors Constructor Description ControlToolbarBeanImpl()
Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Utility method for collecting the bean's state and save it on a string representationjava.lang.String
getControl()
java.lang.String
getDefaultState()
Returls the default state of the toolbar.java.lang.String
getInitialState()
Returls the initial state of the toolbar.int
getLock()
Returns the initial state of the lock button on the control toolbarShortcutListSet
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.HashMap<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.boolean
isOpen()
Returns a boolean value indicating if the instance is marked as opened or closed.protected WebEventHandler
newDefaultEventHandler()
void
setControl(java.lang.String control)
Sets the id of initial selected control button on the control toolbarvoid
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
setLock(int lock)
Sets the initial state of the lock button on the control 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 class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
doCollectData, getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isEditor, isGridDataNecessary, isIFrameEnabled, setIsOpen, setUseIFrame
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent
addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setLeft, setOutputFormat, setTop
-
Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent
addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler
-
Methods inherited from class com.microstrategy.web.beans.AbstractTransformable
addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform
-
Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable
doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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.app.beans.ToolbarBean
getDefaultState, getInitialState, getToolbarInfo, getToolbarName, getToolbarProps, setDefaultState, setInitialState, setToolbarInfo, setToolbarName
-
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
-
getControl
public java.lang.String getControl()
- Specified by:
getControl
in interfaceControlToolbarBean
- 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 interfaceControlToolbarBean
- 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 interfaceControlToolbarBean
- 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 interfaceControlToolbarBean
- 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
instancehowMuchState
-int
value indicating how much state should be saved for the beantokenizer
-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 interfaceToolbarBean
- Returns:
- a
ShortcutListSet
instance containing the toolbar definition associated with the toolbar bean. - See Also:
ToolbarBean.getToolbarInfo()
-
setToolbarInfo
public void setToolbarInfo(ShortcutListSet shortCutListSet)
Description copied from interface:ToolbarBean
Set the shortcut list set definition for this instance.- Specified by:
setToolbarInfo
in interfaceToolbarBean
- Parameters:
shortCutListSet
- aShortcutListSet
instance containing the toolbar definition to be associated with the toolbar bean.- See Also:
ToolbarBean.setToolbarInfo(ShortcutListSet)
-
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 interfaceToolbarBean
- 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 interfaceToolbarBean
- 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 interfaceToolbarBean
- 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 interfaceToolbarBean
- 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 interfaceToolbarBean
- 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 interfaceToolbarBean
- 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 interfaceAppComponent
- Overrides:
isOpen
in classAbstractPersistableFrameElement
- Returns:
boolean
value ofTrue
if the instance is marked as opened, it will returnFalse
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 eventEnumToolbarBeanEvents.WebEventSetToolbarProperty
- Specified by:
getToolbarProps
in interfaceToolbarBean
- Returns:
- the collection of toolbar properties
-
-