Package com.microstrategy.web.app.beans
Interface GridFormatEditorBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,FrameElement
,GridFormatBean
,Persistable
,ReportFrameElement
,RequestPersistable
,Transformable
,WebComponent
public interface GridFormatEditorBean extends GridFormatBean
This class provides the grid formatting editor 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 Modifier and Type Field Description static int
BORDER_LEVEL_ALL
Border level that specifies the selected style and color of border will apply to all the edges of the targetstatic int
BORDER_LEVEL_CUSTOM
Border level that specifies the selected style and color of border will be applied as givenstatic int
BORDER_LEVEL_DEFAULT
Border level that specifies the target will use the default border propertiesstatic int
BORDER_LEVEL_NONE
Border level that specifies no border will be used for the requested targetstatic int
NUMBER_CATEGORY_UNKNOWN
Number category to indicate nothing has been specified-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCurrentTab()
Get the tab that it's currently selected for being displayed by the Grid Format Editor.int
getNumberCategory()
Get the format number category that is assigned to the object (if applicable)void
setBorderPicker(ShortcutList borderPicker)
void
setCurrentTab(int currentTab)
Set the tab to be displayed by the Grid Format Editor as current one.void
setDatePicker(ShortcutList datePicker)
void
setFillColorPicker(ShortcutList fillColorPicker)
void
setFontColorPicker(ShortcutList fontColorPicker)
void
setFontPicker(ShortcutList fontPicker)
void
setFractionPicker(ShortcutList fractionPicker)
void
setNumberCategory(int category)
Set the format number category that is assigned to the objectvoid
setSizePicker(ShortcutList sizePicker)
void
setTimePicker(ShortcutList timePicker)
-
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.web.app.beans.GridFormatBean
getTargetAxis, getTargetLevel, getTargetPosition, setTargetAxis, setTargetAxisPosition, setTargetLevel, setTargetPosition
-
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
-
-
-
-
Field Detail
-
BORDER_LEVEL_NONE
static final int BORDER_LEVEL_NONE
Border level that specifies no border will be used for the requested target- See Also:
- Constant Field Values
-
BORDER_LEVEL_ALL
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- See Also:
- Constant Field Values
-
BORDER_LEVEL_CUSTOM
static final int BORDER_LEVEL_CUSTOM
Border level that specifies the selected style and color of border will be applied as given- See Also:
- Constant Field Values
-
BORDER_LEVEL_DEFAULT
static final int BORDER_LEVEL_DEFAULT
Border level that specifies the target will use the default border properties- See Also:
- Constant Field Values
-
NUMBER_CATEGORY_UNKNOWN
static final int NUMBER_CATEGORY_UNKNOWN
Number category to indicate nothing has been specified- See Also:
- Constant Field Values
-
-
Method Detail
-
getCurrentTab
int getCurrentTab()
Get the tab that it's currently selected for being displayed by the Grid Format Editor.- Returns:
int
value element from theEnumGridFormatEditorTabs
enumeration representing the current tab.
-
setCurrentTab
void setCurrentTab(int currentTab)
Set the tab to be displayed by the Grid Format Editor as current one.- Parameters:
currentTab
-int
value element from theEnumGridFormatEditorTabs
enumeration
-
getNumberCategory
int getNumberCategory()
Get the format number category that is assigned to the object (if applicable)- Returns:
- a value from the
EnumGridFormatNumberCategory
corresponding to the number category property
-
setNumberCategory
void setNumberCategory(int category)
Set the format number category that is assigned to the object- Parameters:
category
- a value of theEnumGridFormatNumberCategory
enumeration corresponding to the category
-
setBorderPicker
void setBorderPicker(ShortcutList borderPicker)
- Parameters:
borderPicker
- The borderPicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setDatePicker
void setDatePicker(ShortcutList datePicker)
- Parameters:
datePicker
- The datePicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setFillColorPicker
void setFillColorPicker(ShortcutList fillColorPicker)
- Parameters:
fillColorPicker
- The fillColorPicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setFontColorPicker
void setFontColorPicker(ShortcutList fontColorPicker)
- Parameters:
fontColorPicker
- The fontColorPicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setFontPicker
void setFontPicker(ShortcutList fontPicker)
- Parameters:
fontPicker
- The fontPicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setFractionPicker
void setFractionPicker(ShortcutList fractionPicker)
- Parameters:
fractionPicker
- The fractionPicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setSizePicker
void setSizePicker(ShortcutList sizePicker)
- Parameters:
sizePicker
- The sizePicker to set.- Since:
- MicroStrategy Web 8.0.0
-
setTimePicker
void setTimePicker(ShortcutList timePicker)
- Parameters:
timePicker
- The timePicker to set.- Since:
- MicroStrategy Web 8.0.0
-
-