public class

ControlToolbarBeanImpl

extends AbstractPersistableFrameElement
implements ControlToolbarBean ToolbarBean
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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
ControlToolbarBeanImpl()
Default constructor
Public Methods
String getControl()
String getDefaultState()
Returls the default state of the toolbar.
String getInitialState()
Returls the initial state of the toolbar.
int getLock()
Returns the initial state of the lock button on the control toolbar
ShortcutListSet getToolbarInfo()
Returns the shortcut list definition from the PageManager object.
String getToolbarName()
Returns the name of the shortcut list associated with the bean.
HashMap<String, 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.
void setControl(String control)
Sets the id of initial selected control button on the control toolbar
void setDefaultState(String value)
Sets the default state of the toolbar.
void setInitialState(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(String value)
Sets the name of the toolbar associated with the bean.
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Utility method for collecting the bean's state and save it on a string representation
WebEventHandler newDefaultEventHandler()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ControlToolbarBean
From interface com.microstrategy.web.app.beans.ToolbarBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Constructors

public ControlToolbarBeanImpl ()

Default constructor

Public Methods

public String getControl ()

public 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

Returns
  • String tooblar's default state

public 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

Returns
  • String tooblar's default state

public 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

public 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.
See Also

public 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
See Also

public HashMap<String, 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 event WebEventSetToolbarProperty

Returns
  • the collection of toolbar properties

public boolean isOpen ()

Returns a boolean value indicating if the instance is marked as opened or closed.

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.

public void setControl (String control)

Sets the id of initial selected control button on the control toolbar

Parameters
control String

public void setDefaultState (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

public void setInitialState (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

public void setLock (int lock)

Sets the initial state of the lock button on the control toolbar.

Parameters
lock int

public void setToolbarInfo (ShortcutListSet shortCutListSet)

Set the shortcut list set definition for this instance.

Parameters
shortCutListSet a ShortcutListSet instance containing the toolbar definition to be associated with the toolbar bean.

public void setToolbarName (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.

Protected Methods

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

protected WebEventHandler newDefaultEventHandler ()