Supported Bean: FormatTabManagerBean

This bean will be used for a tabbed control for formatting editor, for handling which tab should be shown, based on the children beans defined to this instance and the tab specification of each one of them. The manager should be used only when there's the possibility of multiple tabs being shown to the user as options. If it is for sure only one is to be shown, the manager is not required, since each child bean should be independent for processing the information and rendering its contents.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanFormatTabManager (72)

Application bean type for the format tab manager bean

Events

changeTarget, selectOBMgrTab, setTopLeft

changeTarget
Identifier for the event that allows users to change the target object to be formatted.

72001

EnumFormatTabManagerEvents.WebEventChangeFormattingTarget

axisPos

Identifier for the argument that includes the location of the target object to format. Usage:
The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as EnumDSSXMLAxisName.DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
If the second element of the string has as value GridWebFormatHelper.LOCAL_TARGET_ALL_METRICS or GridWebFormatHelper.LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

72001

EnumFormatTabManagerEvents.WebEventArgumentAxisPosition

level

Identifier of the argument that indicates at which level the target object will be modified. Usage:
Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as EnumWebFormatType.WebFormatTypeHeader, EnumWebFormatType.WebFormatTypeGrid, etc.
EnumWebFormatType.WebFormatTypeSubtotalGrid and EnumWebFormatType.WebFormatTypeSubtotalHeader do not apply when modifying metrics.

72002

EnumFormatTabManagerEvents.WebEventArgumentLevel

target

Identifier of the argument that indicates in which axis the target object is located Usage:
Possible values for this argument include elements from the EnumDSSXMLAxisName enumeration

72003

EnumFormatTabManagerEvents.WebEventArgumentAxis

selectOBMgrTab
Identifier for the event that allows users to switch the tab currently displayed on the Tab Manager.

49001

EnumTabManagerBeanEvents.WebEventBrowserSelectTab

*tab

Identifier for the argument that indicates the tab the user requested to be shown. Usage:
Possible values for this argument include those listed on the individual enumeration definitions for each one of the components, such as EnumObjectBrowserTabs enumeration for the Object Browser, which includes EnumObjectBrowserTabs.ObjectBrowserReportObjectsTab, EnumObjectBrowserTabs.ObjectBrowserAllObjectsTab, etc.

49001

EnumTabManagerBeanEvents.WebEventArgumentBrowserTab

renderTabContentOnly

Identifier for the argument that indicates whether the select tab needs to be rendered through the server side or not. Usage:
When a tab is set to cache its content on the client side the value should be set to false. When a tab needs to fetch its content through server the value should be set to true (default).

49002

EnumTabManagerBeanEvents.WebEventArgumentRenderTabContentOnly

setTopLeft
Event for setting the top left position of the component

73001

EnumAppComponentEvents.WebEventSetTopLeftPosition

*left

Event argument to define the left (x) position of the component

73002

EnumAppComponentEvents.WebEventArgumentLeftPosition

*top

Event argument to define the top (y) position of the component

73001

EnumAppComponentEvents.WebEventArgumentTopPosition


Notes

* denotes required field.