com.microstrategy.web.app.beans.EnumGridFormatEditorEvents |
This enumeration contains the list of events and arguments handled by the
GridFormatEditorBean
.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | WebEventArgumentAllColor | ||||||||||
int | WebEventArgumentAllStyle | Identifier for the argument that indicates the format style to use for all the borders of the target object. | |||||||||
int | WebEventArgumentApplyAndCloseGridEditor | Identifier for the argument that indicates the user has requested to apply the changes and close the editor. | |||||||||
int | WebEventArgumentBorderLevel | Identifier for the argument that indicates the level of border customization the user has selected to apply. | |||||||||
int | WebEventArgumentBottomColor | Identifier for the argument that indicates the color to use for the bottom border of the target object. | |||||||||
int | WebEventArgumentBottomStyle | Identifier for the argument that indicates the format style to use for the bottom border of the target object. | |||||||||
int | WebEventArgumentCloseGridEditor | Identifier for the argument that indicates the user has requested to close the editor without applying the changes. | |||||||||
int | WebEventArgumentFontScript | Identifier for the argument that indicates the font script to apply includes strikeout or not. | |||||||||
int | WebEventArgumentFontStrikeOut | Identifier for the argument that indicates the font style to apply includes strikeout or not. | |||||||||
int | WebEventArgumentHorizontalAlign | Identifier for the argument that indicates the horizontal align to apply to the target object. | |||||||||
int | WebEventArgumentHorizontalInsideColor | Identifier for the argument that indicates the horizontal inside border color to apply. | |||||||||
int | WebEventArgumentHorizontalInsideStyle | Identifier for the argument that indicates the horizontal inside border style to apply. | |||||||||
int | WebEventArgumentLeftColor | Identifier for the argument that indicates the color to use for the left border of the target object. | |||||||||
int | WebEventArgumentLeftStyle | Identifier for the argument that indicates the format style to use for the left border of the target object. | |||||||||
int | WebEventArgumentNumberCategoryPrefix | Identifier for the argument that indicates the prefix to use for identifying the number category selected. | |||||||||
int | WebEventArgumentNumberCurrencySymbolPosition | Identifier for the argument that indicates the position where the currency symbol will be placed. | |||||||||
int | WebEventArgumentNumberCustom | Identifier for the argument that represents the custom formatting string the user has selected for the target object. | |||||||||
int | WebEventArgumentNumberDecimalPlaces | Identifier for the argument that indicates the number of decimal places to apply as part of the number formatting selected. | |||||||||
int | WebEventArgumentNumberNegativeNumbers | Identifier for the argument that indicates the type of negative number formatting to apply as part of the number category selected. | |||||||||
int | WebEventArgumentOriginalNumberCategory | Identifier for the argument that indicates the number category to use on the selected target object. | |||||||||
int | WebEventArgumentRightColor | Identifier for the argument that indicates the color to use for the right border of the target object. | |||||||||
int | WebEventArgumentRightStyle | Identifier for the argument that indicates the format style to use for the right border of the target object. | |||||||||
int | WebEventArgumentTab | Identifier for the argument that indicates the tab the user requested to be shown. | |||||||||
int | WebEventArgumentTextWrap | Identifier for the argument that indicates if text wrap should be applied on the cells or not. | |||||||||
int | WebEventArgumentTopColor | Identifier for the argument that indicates the color to use for the top border of the target object. | |||||||||
int | WebEventArgumentTopStyle | Identifier for the argument that indicates the format style to use for the top border of the target object. | |||||||||
int | WebEventArgumentVerticalAlign | Identifier for the argument that indicates the vertical align to apply to the target object. | |||||||||
int | WebEventArgumentVerticalInsideColor | Identifier for the argument that indicates the vertical inside border color to apply. | |||||||||
int | WebEventArgumentVerticalInsideStyle | Identifier for the argument that indicates the vertical inside border style to apply. | |||||||||
int | WebEventChangeFormattingTarget | Identifier for the event that allows users to change the target object to be formatted. | |||||||||
int | WebEventChangeNumberCategory | Identifier for the event that allows users to change the number category to be applied on the selected target object. | |||||||||
int | WebEventProcessBorderTabProperties | Identifier for the event that allows users to submit the indicated changes on the Border properties tab of the editor. | |||||||||
int | WebEventProcessCellTabProperties | Identifier for the event that allows users to submit the indicated changes on the Align properties tab of the editor. | |||||||||
int | WebEventProcessFontTabProperties | Identifier for the event that allows users to submit the indicated changes on the Font properties tab of the editor. | |||||||||
int | WebEventProcessNumberTabProperties | Identifier for the event that allows users to submit the indicated changes on the Number properties tab of the editor. | |||||||||
int | WebEventSwitchEditorTab | Identifier for the event that allows users to switch the tab currently displayed with the grid formatting information. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Identifier for the argument that indicates the format style to use for all the borders of the target object.
Usage:
This argument is used if BORDER_LEVEL_ALL
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be shown is included and read from the
WEB-INF/xml/BorderStyles.xml
configuration file. The value to assign to this argument can
be any of the values specified for the key
attribute.
Identifier for the argument that indicates the user has requested to apply the changes and close the editor.
Identifier for the argument that indicates the level of border customization the user has selected to apply.
Usage:
The user can specify formatting at different levels:
BORDER_LEVEL_NONE
- means no border will be displayed if the formatting is applied.BORDER_LEVEL_ALL
- means the user can select one style and one color
to apply to all the sides of the cells.BORDER_LEVEL_CUSTOM
- means the user can select different colors and styles for
each one of the sides of the cells.BORDER_LEVEL_DEFAULT
- means no change will be done on the current formatting.Identifier for the argument that indicates the color to use for the bottom border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be used is included and read from the
WEB-INF/xml/config/fillColorPicker.xml
configuration file. The value to assign to this argument can
be any valid color code (with the #RRGGBB
format still, for its proper display on the options combo
box, it is required that the value comes from of the XML file, specified by the key
attributes.
Identifier for the argument that indicates the format style to use for the bottom border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be shown is included and read from the
WEB-INF/xml/BorderStyles.xml
configuration file. The value to assign to this argument can
be any of the values specified for the key
attribute.
Identifier for the argument that indicates the user has requested to close the editor without applying the changes.
Identifier for the argument that indicates the font script to apply includes strikeout or not.
Usage:
This argument is not currently being applied on the grid.
Identifier for the argument that indicates the font style to apply includes strikeout or not.
Usage:
The possible values for this argument come from the EnumGridFormatGenericValues
enumeration,
including:
GridFormatGenericValuesDefault
- indicating no change will be peformed for this property,
GridFormatGenericValuesUseNo
- indicating the user requests not to use this style, and
GridFormatGenericValuesUseYes
- indicating the user requests to use this style.
Identifier for the argument that indicates the horizontal align to apply to the target object.
Usage:
The possible values for this argument come from the EnumGridHorizontalAlignmentType
enumeration,
including GridHorizontalAlignmentDefault
,
GridHorizontalAlignmentLeft
, etc. Sending the
GridHorizontalAlignmentDefault
value will indicate that no
change should be performed on this property, on the default event handler.
Identifier for the argument that indicates the horizontal inside border color to apply.
Usage:
This argument is not currently being applied on the grid.
Identifier for the argument that indicates the horizontal inside border style to apply.
Usage:
This argument is not currently being applied on the grid.
Identifier for the argument that indicates the color to use for the left border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be used is included and read from the
WEB-INF/xml/config/fillColorPicker.xml
configuration file. The value to assign to this argument can
be any valid color code (with the #RRGGBB
format still, for its proper display on the options combo
box, it is required that the value comes from of the XML file, specified by the key
attributes.
Identifier for the argument that indicates the format style to use for the left border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be shown is included and read from the
WEB-INF/xml/BorderStyles.xml
configuration file. The value to assign to this argument can
be any of the values specified for the key
attribute.
Identifier for the argument that indicates the prefix to use for identifying the number category selected.
This argument is used for prefixing the different possible values of the number
category format that can be selected by the user for the current target.
Usage:
To this prefix, the value of the number category to use will be appended. These values are defined
on the EnumGridFormatNumberCategory
enumeration, such as
GridFormatNumberCategoryGeneral
,
GridFormatNumberCategoryCurrency
, etc.
Identifier for the argument that indicates the position where the currency symbol will be placed.
Usage:
This argument applies only when the category selected is
GridFormatNumberCategoryCurrency
. The possible values that apply
for this argument are defined on the EnumGridNumberCurrencyPosition
enumeration and include
GRID_NUMBER_CURRENCY_POSITION_LEFT
,
GRID_NUMBER_CURRENCY_POSITION_RIGHT
, etc
Identifier for the argument that represents the custom formatting string the user has selected for the target object.
Usage:
This argument will hold a string with a custom formatting specification to be applied to the target object.
Identifier for the argument that indicates the number of decimal places to apply as part of the number formatting selected.
Identifier for the argument that indicates the type of negative number formatting to apply as part of the number category selected.
Usage:
The negative number formatting options depends on the number category selected, and applies only for
GridFormatNumberCategoryFixed
,
GridFormatNumberCategoryCurrency
and
GridFormatNumberCategoryPercentage
. The possible values that apply
for this argument are defined on the EnumGridNegativeNumbersFormat
enumeration and include
GridNegativeNumbersFormatRed
,
GridNegativeNumbersFormatParenthesis
, etc
Identifier for the argument that indicates the number category to use on the selected target object.
The difference between this argument and WebEventArgumentNumberCategoryPrefix
is that this argument represents the category selected by the user and the one to be applied if the user
decides to do so; the prefix argument is only for allowing the user to switch from one category to the other,
without actually changing the target object formatting at that time.
Usage:
The possible category values that can be assigned to this argument are defined
on the EnumGridFormatNumberCategory
enumeration, such as
GridFormatNumberCategoryGeneral
,
GridFormatNumberCategoryCurrency
, etc.
Identifier for the argument that indicates the color to use for the right border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be used is included and read from the
WEB-INF/xml/config/fillColorPicker.xml
configuration file. The value to assign to this argument can
be any valid color code (with the #RRGGBB
format still, for its proper display on the options combo
box, it is required that the value comes from of the XML file, specified by the key
attributes.
Identifier for the argument that indicates the format style to use for the right border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be shown is included and read from the
WEB-INF/xml/BorderStyles.xml
configuration file. The value to assign to this argument can
be any of the values specified for the key
attribute.
Identifier for the argument that indicates the tab the user requested to be shown.
Usage:
Possible values for this argument include those listed on the EnumGridFormatEditorTabs
enumeration, such as GridFormatFontTab
,
GridFormatBorderTab
, etc.
Identifier for the argument that indicates if text wrap should be applied on the cells or not.
Usage:
The possible values for this argument come from the EnumGridFormatGenericValues
enumeration,
including:
GridFormatGenericValuesDefault
- indicating no change will be peformed for this property,
GridFormatGenericValuesUseNo
- indicating the user requests not to use text wrap, and
GridFormatGenericValuesUseYes
- indicating the user requests to use text wrap.
Identifier for the argument that indicates the color to use for the top border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be used is included and read from the
WEB-INF/xml/config/fillColorPicker.xml
configuration file. The value to assign to this argument can
be any valid color code (with the #RRGGBB
format still, for its proper display on the options combo
box, it is required that the value comes from of the XML file, specified by the key
attributes.
Identifier for the argument that indicates the format style to use for the top border of the target object.
Usage:
This argument is used if BORDER_LEVEL_CUSTOM
formatting is
specified as the value of WebEventArgumentBorderLevel
.
The list of possible values that can be shown is included and read from the
WEB-INF/xml/BorderStyles.xml
configuration file. The value to assign to this argument can
be any of the values specified for the key
attribute.
Identifier for the argument that indicates the vertical align to apply to the target object.
Usage:
The possible values for this argument come from the EnumGridVerticalAlignmentType
enumeration,
including GridVerticalAlignmentDefault
,
GridVerticalAlignmentTop
, etc. Sending the
GridVerticalAlignmentDefault
value will indicate that no
change should be performed on this property, on the default event handler.
Identifier for the argument that indicates the vertical inside border color to apply.
Usage:
This argument is not currently being applied on the grid.
Identifier for the argument that indicates the vertical inside border style to apply.
Usage:
This argument is not currently being applied on the grid.
Identifier for the event that allows users to change the target object to be formatted.
Identifier for the event that allows users to change the number category to be applied on the selected target object. On the default event handler, changing the number category does not actually apply the change on the target object, but just allows to show specific settings for this formatting. The changes will get applied once the user selects the Apply or OK buttons.
Identifier for the event that allows users to submit the indicated changes on the Border properties tab of the editor.
Identifier for the event that allows users to submit the indicated changes on the Align properties tab of the editor.
Identifier for the event that allows users to submit the indicated changes on the Font properties tab of the editor.
Identifier for the event that allows users to submit the indicated changes on the Number properties tab of the editor.
Identifier for the event that allows users to switch the tab currently displayed with the grid formatting information.