Package com.microstrategy.web.app.beans

Interface GridFormatBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameElement, Persistable, ReportFrameElement, RequestPersistable, Transformable, WebComponent

All Known Subinterfaces:

GridFormatEditorBean, GridFormatToolbarBean

public interface GridFormatBean
extends ReportFrameElement, RequestPersistable

This class provides the basic grid formatting component interface for modifying the looks of the grid currently being displayed to the user.

Since:

MicroStrategy Web 7.3.1 or earlier

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

Modifier and Type	Method	Description
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	setTargetAxis(int axis)	Set the axis where the target is located
void	setTargetAxisPosition(java.lang.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.
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.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean, isGridDataNecessary

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

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, 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, 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

setTargetAxisPosition

void setTargetAxisPosition(java.lang.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.