Package com.microstrategy.web.app.beans

Interface FormatTabBean

All Superinterfaces:

AppComponent, TabBean, Transformable, ViewBeanParserBean, WebComponent

All Known Subinterfaces:

FormatColorLinesTabBean, FormatNumberTabBean

public interface FormatTabBean
extends TabBean

This interface shall be used as base for creating tab beans that can be displayed by a TabManagerBean instance or on their own.

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.web.app.beans.TabBean

CACHED, FETCH, TAB_REPRESENTED_NOT_SPECIFIED

Method Summary

Modifier and Type	Method	Description
java.lang.String	getSelectedTypes()	set the list of object types selected in the client.
int	getTargetAxis()	Get the axis where the target is located
int	getTargetLevel()	Get the level at which the formatting will be applied
int	getTargetPosition()	Get the position in the axis where the target is located
void	setSelectedTypes(java.lang.String selectedTypes)	Set the list of object types selected in the client.
void	setTargetAxis(int axis)	Set the axis where the target is located
void	setTargetLevel(int level)	Set the level at which the formatting will be applied
void	setTargetPosition(int position)	Set the position in the axis where the target is located

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.web.app.beans.TabBean

getEnabledCmdId, getFeatures, getHelpTopic, getHelpType, getRequireSingleSelector, getSupportedTypes, getSwitchMode, getTabId, getTabLabel, getTabLabelId, getTabManager, getTabName, getTabRepresented, getViewBean, isAvailable, isPartialUpdate, setEnabledCmdId, setFeatures, setHelpTopic, setHelpType, setPartialUpdate, setRequireSingleSelector, setSupportedTypes, setSwitchMode, setTabLabel, setTabLabelId, setTabName, setTabRepresented

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.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, setActiveElementIndex, setActiveViewKey

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

getTargetAxis

int getTargetAxis()

Get the axis where the target is located

Returns:

Element from the EnumDSSXMLAxisName enumeration

setTargetAxis

void setTargetAxis(int axis)

Set the axis where the target is located

Parameters:

axis - Element from the EnumDSSXMLAxisName enumeration

getTargetPosition

int getTargetPosition()

Get the position in the axis where the target is located

Returns:

the index where the target is located

setTargetPosition

void setTargetPosition(int position)

Set the position in the axis where the target is located

Parameters:

position - the index where the target is located

getTargetLevel

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

setTargetLevel

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

setSelectedTypes

void setSelectedTypes(java.lang.String selectedTypes)

Set the list of object types selected in the client.

Parameters:

selectedTypes - String representing the list of selected objects.

getSelectedTypes

java.lang.String getSelectedTypes()

set the list of object types selected in the client.

Returns:

String representing the list of selected objects.