public interface

GridFormatEditorBean

implements GridFormatBean
com.microstrategy.web.app.beans.GridFormatEditorBean

Class Overview

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

Summary

Constants
int BORDER_LEVEL_ALL Border level that specifies the selected style and color of border will apply to all the edges of the target
int BORDER_LEVEL_CUSTOM Border level that specifies the selected style and color of border will be applied as given
int BORDER_LEVEL_DEFAULT Border level that specifies the target will use the default border properties
int BORDER_LEVEL_NONE Border level that specifies no border will be used for the requested target
int NUMBER_CATEGORY_UNKNOWN Number category to indicate nothing has been specified
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getCurrentTab()
Get the tab that it's currently selected for being displayed by the Grid Format Editor.
abstract int getNumberCategory()
Get the format number category that is assigned to the object (if applicable)
abstract void setBorderPicker(ShortcutList borderPicker)
abstract void setCurrentTab(int currentTab)
Set the tab to be displayed by the Grid Format Editor as current one.
abstract void setDatePicker(ShortcutList datePicker)
abstract void setFillColorPicker(ShortcutList fillColorPicker)
abstract void setFontColorPicker(ShortcutList fontColorPicker)
abstract void setFontPicker(ShortcutList fontPicker)
abstract void setFractionPicker(ShortcutList fractionPicker)
abstract void setNumberCategory(int category)
Set the format number category that is assigned to the object
abstract void setSizePicker(ShortcutList sizePicker)
abstract void setTimePicker(ShortcutList timePicker)
[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.FrameElement
From interface com.microstrategy.web.app.beans.GridFormatBean
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int BORDER_LEVEL_ALL

Border level that specifies the selected style and color of border will apply to all the edges of the target

Constant Value: 1 (0x00000001)

public static final int BORDER_LEVEL_CUSTOM

Border level that specifies the selected style and color of border will be applied as given

Constant Value: 2 (0x00000002)

public static final int BORDER_LEVEL_DEFAULT

Border level that specifies the target will use the default border properties

Constant Value: 3 (0x00000003)

public static final int BORDER_LEVEL_NONE

Border level that specifies no border will be used for the requested target

Constant Value: 0 (0x00000000)

public static final int NUMBER_CATEGORY_UNKNOWN

Number category to indicate nothing has been specified

Constant Value: -9999 (0xffffd8f1)

Public Methods

public abstract int getCurrentTab ()

Get the tab that it's currently selected for being displayed by the Grid Format Editor.

Returns

public abstract int getNumberCategory ()

Get the format number category that is assigned to the object (if applicable)

Returns

public abstract void setBorderPicker (ShortcutList borderPicker)

Parameters
borderPicker The borderPicker to set.

public abstract void setCurrentTab (int currentTab)

Set the tab to be displayed by the Grid Format Editor as current one.

Parameters
currentTab int value element from the EnumGridFormatEditorTabs enumeration

public abstract void setDatePicker (ShortcutList datePicker)

Parameters
datePicker The datePicker to set.

public abstract void setFillColorPicker (ShortcutList fillColorPicker)

Parameters
fillColorPicker The fillColorPicker to set.

public abstract void setFontColorPicker (ShortcutList fontColorPicker)

Parameters
fontColorPicker The fontColorPicker to set.

public abstract void setFontPicker (ShortcutList fontPicker)

Parameters
fontPicker The fontPicker to set.

public abstract void setFractionPicker (ShortcutList fractionPicker)

Parameters
fractionPicker The fractionPicker to set.

public abstract void setNumberCategory (int category)

Set the format number category that is assigned to the object

Parameters
category a value of the EnumGridFormatNumberCategory enumeration corresponding to the category

public abstract void setSizePicker (ShortcutList sizePicker)

Parameters
sizePicker The sizePicker to set.

public abstract void setTimePicker (ShortcutList timePicker)

Parameters
timePicker The timePicker to set.