public interface

FormatTabManagerBean

implements TabManagerBean
com.microstrategy.web.app.beans.FormatTabManagerBean

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TabManagerBean
Public Methods
abstract String getActiveViewKey()
Returns the active view key.
abstract int getTargetAxis()
Get the axis where the target is located
abstract int getTargetLevel()
Get the level at which the formatting will be applied
abstract int getTargetPosition()
Get the position in the axis where the target is located
abstract ViewBean getViewBean()
Utility method for obtaining the ViewBean indicated as target bean for this tab instance.
abstract boolean isCrossTab()
Returns true if the selected object is a cross tab object.
abstract boolean isPanelStack()
abstract void setActiveViewKey(String activeViewKey)
Set the active view key.
abstract void setTargetAxis(int axis)
Set the axis where the target is located
abstract void setTargetAxisPosition(String axisPosition)
Set the axis and position of the target, based on a string with the value of the axis and the position separated by a comma.
abstract void setTargetLevel(int level)
Set the level at which the formatting will be applied
abstract void setTargetPosition(int position)
Set the position in the axis where the target is located
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TabManagerBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract String getActiveViewKey ()

Returns the active view key.

Returns
  • String activeViewKey The specific element to set as active.

public abstract int getTargetAxis ()

Get the axis where the target is located

Returns

public abstract int getTargetLevel ()

Get the level at which the formatting will be applied

Returns
  • Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

public abstract int getTargetPosition ()

Get the position in the axis where the target is located

Returns
  • the index where the target is located

public abstract ViewBean getViewBean ()

Utility method for obtaining the ViewBean indicated as target bean for this tab instance.

Returns
  • the ViewBean corresponding to the name specified on the ActiveViewKey property. Returns null if not found (or if bean type is not related with ViewBean).

public abstract boolean isCrossTab ()

Returns true if the selected object is a cross tab object.

Returns
  • true if the selected object is a cross tab object.

public abstract boolean isPanelStack ()

Returns
  • boolean value indicating if the selected object is a panel stack

public abstract void setActiveViewKey (String activeViewKey)

Set the active view key. It's used for initializing current bean from a view Bean.

Parameters
activeViewKey The specific element to set as active.

public abstract void setTargetAxis (int axis)

Set the axis where the target is located

Parameters
axis Element from the EnumDSSXMLAxisName enumeration

public abstract void setTargetAxisPosition (String axisPosition)

Set the axis and position of the target, based on a string with the value of the axis and the position separated by a comma. For example: 1,3 for the third element on the grid row.

Parameters
axisPosition String with value of the axis and position separated by a comma.

public abstract void setTargetLevel (int level)

Set the level at which the formatting will be applied

Parameters
level Element of the EnumWebFormatType enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level

public abstract void setTargetPosition (int position)

Set the position in the axis where the target is located

Parameters
position the index where the target is located