ControlToolbarBean (Web API 2021)

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, ToolbarBean, Transformable, WebComponent

All Known Implementing Classes:

ControlToolbarBeanImpl
```
public interface ControlToolbarBean
extends ToolbarBean
```
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`	`getControl()`
`int`	`getLock()`	Returns the initial state of the lock button on the control toolbar
`void`	`setControl(java.lang.String control)`	Sets the id of initial selected control button on the control toolbar
`void`	`setLock(int lock)`	Sets the initial state of the lock button on the control toolbar.

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
  - setLock
```
void setLock(int lock)
```
    Sets the initial state of the lock button on the control toolbar.
    
    Parameters:
    
    lock - int
  - getLock
```
int getLock()
```
    Returns the initial state of the lock button on the control toolbar
    
    Returns:
    
    int -1 - doesn't apply 0 - Lock is off 1 - Lock is on
  - setControl
```
void setControl(java.lang.String control)
```
    Sets the id of initial selected control button on the control toolbar
    
    Parameters:
    
    control - String
  - getControl
```
java.lang.String getControl()
```
    Returns:
    
    the id of initial selected control button on the control toolbar