public interface

EnumPageByBeanEvents

implements EnumPageEvents
com.microstrategy.web.app.beans.EnumPageByBeanEvents

Class Overview

Defines the events and arguments available for the PageByBean.

Summary

Constants
int ACTION_ADD
int ACTION_DELETE
String ACTION_DELIMITER
int ACTION_NONE
int ACTION_PIVOT
int ACTION_REMOVE
int ACTION_SELECT
int ACTION_SORT
int DISPLAY_TYPE_CUSTOM
int DISPLAY_TYPE_DEFAULT
String METRICS_UNIT_ID
String PIVOT_LEFT
String PIVOT_RIGHT
String PIVOT_TO_COLUMNS
String PIVOT_TO_ROWS
int SORT_ORDER_ASCENDING
int SORT_ORDER_DEFAULT
int SORT_ORDER_DESCENDING
int WebEventArgumentPageByAction Argument that specifies an action to apply in the Generic Event.
int WebEventArgumentPageByApply Argument that specifies the name of the apply button.
int WebEventArgumentPageByAutosubmit Argument that specifies the that the selection was done using auto-submit.
int WebEventArgumentPageByDatasetID Argument that specifies the datasetID of the dataset from which the page by element is being added from.
int WebEventArgumentPageByDisplayAttrForms Argument that specifies the Disyplay attribute forms of the groupBy unit.
int WebEventArgumentPageByDisplayType Argument that specifies the DisyplayType of the groupBy unit.
int WebEventArgumentPageByObjectID Argument that specifies the ID of an object to add as a page-by unit.
int WebEventArgumentPageByObjectSubtype Argument that specifies the DSSSubType of an object to add as a page-by unit.
int WebEventArgumentPageByObjectType Argument that specifies the DSSType of an object to add as a page-by unit.
int WebEventArgumentPageByPivotAction Argument that specifies what the pivot action should be.
int WebEventArgumentPageBySelectedElement Argument that specifies the current page-by selection.
int WebEventArgumentPageBySortOrder Argument that specifies an action to apply in the Generic Event.
int WebEventArgumentPageByUnitDestinationAxis Argument that specifies the destination's axis:
  • WebEventPageByPivot
  • int WebEventArgumentPageByUnitDestinationKey Argument that specifies the destination's unit key:
  • WebEventPageByPivot
  • int WebEventArgumentPageByUnitKey Argument that specifies the current unit key:
  • WebEventPageByPivot
  • WebEventPageBySort
  • int WebEventPageByAdd Event to add an element into the PageBy.
    int WebEventPageByDelete Event to delete a PageBy unit from the report definition.
    int WebEventPageByDisplayAttrForms Event to select attribute forms to display in a GroupBy Unit.
    int WebEventPageByDisplayType Event to select display type in a GroupBy Unit.
    int WebEventPageByGeneric Generic Event for Page-by.
    int WebEventPageByPivot Event to pivot a PageBy Unit.
    int WebEventPageByRemove Event to remove an element from the PageBy section.
    int WebEventPageBySelectElement Event to select an element in a PageBy Unit.
    int WebEventPageBySort Event that toggles the sort a PageBy Unit.
    [Expand]
    Inherited Constants
    From interface com.microstrategy.web.app.beans.EnumPageEvents
    From interface com.microstrategy.web.app.beans.EnumServletEvents

    Constants

    public static final int ACTION_ADD

    Constant Value: 4 (0x00000004)

    public static final int ACTION_DELETE

    Constant Value: 5 (0x00000005)

    public static final String ACTION_DELIMITER

    Constant Value: "~"

    public static final int ACTION_NONE

    Constant Value: -1 (0xffffffff)

    public static final int ACTION_PIVOT

    Constant Value: 0 (0x00000000)

    public static final int ACTION_REMOVE

    Constant Value: 3 (0x00000003)

    public static final int ACTION_SELECT

    Constant Value: 2 (0x00000002)

    public static final int ACTION_SORT

    Constant Value: 1 (0x00000001)

    public static final int DISPLAY_TYPE_CUSTOM

    Constant Value: 4 (0x00000004)

    public static final int DISPLAY_TYPE_DEFAULT

    Constant Value: 1 (0x00000001)

    public static final String METRICS_UNIT_ID

    Constant Value: "METRICS"

    public static final String PIVOT_LEFT

    Constant Value: "l"

    public static final String PIVOT_RIGHT

    Constant Value: "r"

    public static final String PIVOT_TO_COLUMNS

    Constant Value: "tc"

    public static final String PIVOT_TO_ROWS

    Constant Value: "tr"

    public static final int SORT_ORDER_ASCENDING

    Constant Value: 1 (0x00000001)

    public static final int SORT_ORDER_DEFAULT

    Constant Value: -1 (0xffffffff)

    public static final int SORT_ORDER_DESCENDING

    Constant Value: 0 (0x00000000)

    public static final int WebEventArgumentPageByAction

    Argument that specifies an action to apply in the Generic Event.

  • WebEventPageByGeneric

  • Constant Value: 20010 (0x00004e2a)

    public static final int WebEventArgumentPageByApply

    Argument that specifies the name of the apply button.

  • WebEventPageBySelectElement

  • Constant Value: 20009 (0x00004e29)

    public static final int WebEventArgumentPageByAutosubmit

    Argument that specifies the that the selection was done using auto-submit. It will be true if the value is "1". False otherwise.

  • WebEventPageBySelectElement

  • Constant Value: 20006 (0x00004e26)

    public static final int WebEventArgumentPageByDatasetID

    Argument that specifies the datasetID of the dataset from which the page by element is being added from.

  • WebEventPageByAdd

  • Constant Value: 20013 (0x00004e2d)

    public static final int WebEventArgumentPageByDisplayAttrForms

    Argument that specifies the Disyplay attribute forms of the groupBy unit.

  • WebEventPageByDisplayType

  • Constant Value: 20015 (0x00004e2f)

    public static final int WebEventArgumentPageByDisplayType

    Argument that specifies the DisyplayType of the groupBy unit.

  • WebEventPageByDisplayType

  • Constant Value: 20014 (0x00004e2e)

    public static final int WebEventArgumentPageByObjectID

    Argument that specifies the ID of an object to add as a page-by unit.

  • WebEventPageByAdd

  • Constant Value: 20007 (0x00004e27)

    public static final int WebEventArgumentPageByObjectSubtype

    Argument that specifies the DSSSubType of an object to add as a page-by unit.

  • WebEventPageByAdd

  • Constant Value: 20012 (0x00004e2c)

    public static final int WebEventArgumentPageByObjectType

    Argument that specifies the DSSType of an object to add as a page-by unit.

  • WebEventPageByAdd

  • Constant Value: 20008 (0x00004e28)

    public static final int WebEventArgumentPageByPivotAction

    Argument that specifies what the pivot action should be. This can be used to specify whether to move a unit left/right/to rows/to columns instead of specifying the targeted position/axis.

  • WebEventPageByPivot

  • Constant Value: 20004 (0x00004e24)

    public static final int WebEventArgumentPageBySelectedElement

    Argument that specifies the current page-by selection. The format of the value is a list of one or more position + elementID pairs. unitKeyPAGE_BY_KEY_SEPARATORelementID

  • WebEventPageBySelectElement

  • Constant Value: 20005 (0x00004e25)

    public static final int WebEventArgumentPageBySortOrder

    Argument that specifies an action to apply in the Generic Event.

  • WebEventPageByGeneric

  • Constant Value: 20011 (0x00004e2b)

    public static final int WebEventArgumentPageByUnitDestinationAxis

    Argument that specifies the destination's axis:

  • WebEventPageByPivot

  • Constant Value: 20003 (0x00004e23)

    public static final int WebEventArgumentPageByUnitDestinationKey

    Argument that specifies the destination's unit key:

  • WebEventPageByPivot

  • Constant Value: 20002 (0x00004e22)

    public static final int WebEventArgumentPageByUnitKey

    Argument that specifies the current unit key:

  • WebEventPageByPivot
  • WebEventPageBySort

  • Constant Value: 20001 (0x00004e21)

    public static final int WebEventPageByAdd

    Event to add an element into the PageBy.

    Constant Value: 20005 (0x00004e25)

    public static final int WebEventPageByDelete

    Event to delete a PageBy unit from the report definition.

    Constant Value: 20007 (0x00004e27)

    public static final int WebEventPageByDisplayAttrForms

    Event to select attribute forms to display in a GroupBy Unit.

    Constant Value: 20009 (0x00004e29)

    public static final int WebEventPageByDisplayType

    Event to select display type in a GroupBy Unit.

    Constant Value: 20008 (0x00004e28)

    public static final int WebEventPageByGeneric

    Generic Event for Page-by. This event is designed to support all the page-by actions. The action to perform is sent as an argument. More over, if the name of the argument ends with ".x" it assumes the value is coming from an IMG INPUT and reads the values directly from the argument name; all of this is intended to support HTML mode and its usage is not recommended.

    Constant Value: 20006 (0x00004e26)

    public static final int WebEventPageByPivot

    Event to pivot a PageBy Unit.

    Constant Value: 20001 (0x00004e21)

    public static final int WebEventPageByRemove

    Event to remove an element from the PageBy section.

    Constant Value: 20004 (0x00004e24)

    public static final int WebEventPageBySelectElement

    Event to select an element in a PageBy Unit.

    Constant Value: 20003 (0x00004e23)

    public static final int WebEventPageBySort

    Event that toggles the sort a PageBy Unit.

    Constant Value: 20002 (0x00004e22)