public interface

EnumGridFormatEvents

implements EnumFrameEditorEvents
com.microstrategy.web.app.beans.EnumGridFormatEvents
Known Indirect Subclasses

Class Overview

This enumeration contains the list of events and arguments handled by the Grid Format beans, such as the GridFormatEditorBean and the GridFormatToolbarBean

Summary

Constants
int WebEventArgumentApplyGridFormatChanges Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.
int WebEventArgumentAxisPosition Identifier for the argument that includes the location of the target object to format.
int WebEventArgumentFontBackgroundColor Identifier for the argument that indicates the background color to apply to the target object.
int WebEventArgumentFontBold Identifier for the argument that indicates if font style bold is to be applied to the target object.
int WebEventArgumentFontColor Identifier for the argument that indicates the font color to apply to the target object.
int WebEventArgumentFontItalic Identifier for the argument that indicates if font style italic is to be applied to the target object.
int WebEventArgumentFontName Identifier for the argument that indicates the font name to apply to the target object.
int WebEventArgumentFontSize Identifier for the argument that indicates the font size to apply to the target object.
int WebEventArgumentFontUnderline Identifier for the argument that indicates the font underline style to apply to the target object.
int WebEventArgumentLevel Identifier of the argument that indicates at which level the target object will be modified.
int WebEventArgumentNumberCurrencySymbol Identifier for the argument that specifies the symbol to be used for currency on the target object.
int WebEventArgumentOldStyle Identifier for the argument that includes the name of the Old Style formatting used on the report.
int WebEventArgumentThousandSeparator Identifier for the argument that specifies if Thousand Separator will be used on the target object.
int WebEventArgumentUnit Identifier for the argument that indicates the type of unit selected as target object.
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumFrameEditorEvents
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final int WebEventArgumentApplyGridFormatChanges

Identifier for the argument that indicates the user has requested to apply the changes and leave the editor opened.

Constant Value: 29039 (0x0000716f)

public static final int WebEventArgumentAxisPosition

Identifier for the argument that includes the location of the target object to format. Usage:
The possible values for this argument include strings that specify the axis and position location of the object to be formatted, separated by comma: axis,position.
Valid values for the axis section of the value include those defined on the EnumDSSXMLAxisName enumeration, such as DssXmlAxisNameRows, so an argument value defined as 1,2 represents the second element on the rows axis.
If the second element of the string (representing position) is zero, then the axis value indicates which full axis will be formatted, for example, 1,0 represents the row axis.
If the second element of the string is a -1 the code represents a metric, and its position on the array of metrics is indicated on the first element of the value, for example 1,-1 represents the second metric on the grid.
If the second element of the string has as value LOCAL_TARGET_ALL_METRICS or LOCAL_TARGET_ALL_REPORT then this indicates the formatting object that will be modified.

Constant Value: 29002 (0x0000714a)

public static final int WebEventArgumentFontBackgroundColor

Identifier for the argument that indicates the background color to apply to the target object. Usage:
The background color specified here will be used as part of the CSS definition of the final style to apply to the target object.

Constant Value: 29012 (0x00007154)

public static final int WebEventArgumentFontBold

Identifier for the argument that indicates if font style bold is to be applied to the target object. Usage:
The possible values of this argument include:

  • GridFormatGenericValuesUseYes - indicates bold will be part of the style to use.
  • GridFormatGenericValuesUseNo - indicates bold will not be applied to the target object.
  • GridFormatGenericValuesDefault - indicates no change will be done to the value currently defined for the property of the target object.

  • Constant Value: 29006 (0x0000714e)

    public static final int WebEventArgumentFontColor

    Identifier for the argument that indicates the font color to apply to the target object. Usage:
    The font color specified here will be used as part of the CSS definition of the final style to apply to the target object.

    Constant Value: 29010 (0x00007152)

    public static final int WebEventArgumentFontItalic

    Identifier for the argument that indicates if font style italic is to be applied to the target object. Usage:
    The possible values of this argument include:

  • GridFormatGenericValuesUseYes - indicates italic will be part of the style to use.
  • GridFormatGenericValuesUseNo - indicates italic will not be applied to the target object.
  • GridFormatGenericValuesDefault - indicates no change will be done to the value currently defined for the property of the target object.

  • Constant Value: 29007 (0x0000714f)

    public static final int WebEventArgumentFontName

    Identifier for the argument that indicates the font name to apply to the target object. Usage:
    The font name specified here will be used as part of the CSS definition of the final style to apply to the target object.

    Constant Value: 29004 (0x0000714c)

    public static final int WebEventArgumentFontSize

    Identifier for the argument that indicates the font size to apply to the target object. Usage:
    The font size specified here will be used as part of the CSS definition of the final style to apply to the target object.

    Constant Value: 29005 (0x0000714d)

    public static final int WebEventArgumentFontUnderline

    Identifier for the argument that indicates the font underline style to apply to the target object. Usage: The possible values of this argument include:

  • GridFormatGenericValuesUseYes - indicates underline will be part of the style to use.
  • GridFormatGenericValuesUseNo - indicates underline will not be applied to the target object.
  • GridFormatGenericValuesDefault - indicates no change will be done to the value currently defined for the property of the target object.

  • Constant Value: 29009 (0x00007151)

    public static final int WebEventArgumentLevel

    Identifier of the argument that indicates at which level the target object will be modified. Usage:
    Possible values for this argument include those defined on the EnumWebFormatType enumeration, such as WebFormatTypeHeader, WebFormatTypeGrid, etc.
    WebFormatTypeSubtotalGrid and WebFormatTypeSubtotalHeader do not apply when modifying metrics.

    Constant Value: 29003 (0x0000714b)

    public static final int WebEventArgumentNumberCurrencySymbol

    Identifier for the argument that specifies the symbol to be used for currency on the target object.

    Constant Value: 29035 (0x0000716b)

    public static final int WebEventArgumentOldStyle

    Identifier for the argument that includes the name of the Old Style formatting used on the report. Usage:
    This argument is required if the report that is being formatted belongs to an older version. It is needed because otherwise the original formatting used for viewing the grid will be lost when a new format is applied to the report.

    Constant Value: 29043 (0x00007173)

    public static final int WebEventArgumentThousandSeparator

    Identifier for the argument that specifies if Thousand Separator will be used on the target object. Usage:
    Possible values for this argument include 1 for indicating the thousand separator will be applied.

    Constant Value: 29038 (0x0000716e)

    public static final int WebEventArgumentUnit

    Identifier for the argument that indicates the type of unit selected as target object. Usage:
    Possible values for this argument include those defined on the EnumGridFormatUnit enumeration, such as GridFormatColumns, GridFormatAllMetrics, etc.

    Constant Value: 29031 (0x00007167)