public interface

EnumReportFrameEvents

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

Class Overview

All event definitions used in report frame bean (including its children components)

Summary

Constants
String ITEM_SEPARATOR
int WebEventAddViewFilterCondition Event to fire when "Add View filter condition" is clicked.
int WebEventAddWebElementsToFilter Event to add element qualification to the filter.
int WebEventArgumentAdvancedDrillEditor event argument: argument to show advanced drill editor in the simple drill editor.
int WebEventArgumentAdvancedDrillEditorName event argument: the name of the drill editor to display.
int WebEventArgumentAttributeId event argument: to set the attribute id on attribute form editor.
int WebEventArgumentDefaultAttrQualMode event argument: for add to filter event, the default attr qualification mode.
int WebEventArgumentDesignModeCancel event argument: HTML name for cancel button in design mode.
int WebEventArgumentDesignModeChangeStage event argument: the HTML name for the button toggling between template editor and report filter editor.
int WebEventArgumentDesignModeExecute event argument: HTML name for execute button in design mode.
int WebEventArgumentDesignModeForm event argument: HTML form name for design mode "command" area.
int WebEventArgumentDesignModeSave event argument: HTML name for saveas button in design mode.
int WebEventArgumentDragAndDropAttFormID event argument: HTML name the dragged attribute form id item in the drag-and-drop form.
int WebEventArgumentDragAndDropAttFormPosition event argument: HTML name the target form position within the attribute item in the drag-and-drop form.
int WebEventArgumentDragAndDropFirstMetric event argument: Indicate whether it's the first metric that is dragged on to grid.
int WebEventArgumentDragAndDropForm event argument: HTML name for drag and drop form.
int WebEventArgumentDragAndDropFromAxis event argument: HTML name the original axis item in the drag-and-drop form.
int WebEventArgumentDragAndDropFromPos event argument: HTML name the original position item in the drag-and-drop form.
int WebEventArgumentDragAndDropFromType event argument: HTML name the original object type item in the drag-and-drop form.
int WebEventArgumentDragAndDropObjectAlias event argument: HTML name the dragged object alias item in the drag-and-drop form.
int WebEventArgumentDragAndDropObjectID event argument: HTML name the dragged object id item in the drag-and-drop form.
int WebEventArgumentDragAndDropObjectType event argument: HTML name the dragged object type item in the drag-and-drop form.
int WebEventArgumentDragAndDropToAxis event argument: HTML name the target axis item in the drag-and-drop form.
int WebEventArgumentDragAndDropToPos event argument: HTML name the target position axis item in the drag-and-drop form.
int WebEventArgumentDragAndDropToType event argument: HTML name the target object type axis item in the drag-and-drop form.
int WebEventArgumentDrillEditorTitleAxis Argument to specify the axis of the WebTitle for which we want to show all the drill paths in the advanced drill editor.
int WebEventArgumentDrillEditorTitlePosition Argument to specify the position of the WebTitle within the specified axis for which we want to show all the drill paths in the advanced drill editor.
int WebEventArgumentForCustomSort event argument: indicates that the derived element editor needs to be open for custom sort.
int WebEventArgumentFormularEditorAbsoluteIndex event argument: whether the active element index for formula editor is absolute or not.
int WebEventArgumentFormularEditorActiveElement event argument: the active element index to preselect when the formula editor is opened.
int WebEventArgumentMergeColumnHeaders event argument: whether to merge or repeat column headers.
int WebEventArgumentObjectInfo event argument: element info with ID|Type|Name format.
int WebEventArgumentPageByApply event argument: apply button/img name for the pageby section.
int WebEventArgumentPageByDropdown event argument: the HTML dropdown box name for pageby section.
int WebEventArgumentPageByForm event argument: the HTML form name for the pageby section.
int WebEventArgumentReportFrameElementName event argument: the report frame element name to open or close.
int WebEventArgumentShowAttributeForms event argument: whether to show the attribute forms on the grid.
int WebEventArgumentShowAttributeList event argument: whether to show the attribute list on the attribute forms editor
int WebEventArgumentShowReportBar event argument: indicates we need to display the report toolbar
int WebEventArgumentTemplateEditorForm event argument: the HTML form name for template editor.
int WebEventArgumentTemplateEditorMoveMetricPrefix event argument: the prefix name for moving metrics in template editor.
int WebEventArgumentTemplateEditorPivotPrefix event argument: the prefix name for pivot images in template editor.
int WebEventArgumentTemplateEditorRemoveMetricPrefix event argument: the prefix name for removing metrics in template editor.
int WebEventArgumentTemplateEditorRemovePrefix event argument: the prefix name for removing images in template editor.
int WebEventArgumentWebElements event argument: list of elements to be added to filter.
int WebEventArgumentXdaDimensionId event argument: indicate the identifier of the xda dimension
int WebEventArgumentXdaHierarchyId event argument: indicate the identifier of the xda hierarchy
int WebEventAttributeFormsEditor Event for opening the Attribute Forms Editor
int WebEventChangeDesignMode Event for switching report mode between design mode and execute mode.
int WebEventChangeOptimizedMode
int WebEventCloseReportFrameElement Event for closing an element of the report frame.
int WebEventDesignModePageBy event for the pageby area in design mode.
int WebEventDesignModeProcess event for the "command" area in design mode page.
int WebEventDesignModeTemplateEditor event for the template editor area in design mode.
int WebEventDragAndDrop Generic event for drag and drop action in the application.
int WebEventFilterEditorAddElement event for adding a new element to the filter editor.
int WebEventMergeColumnHeaders Event for merge/repeat column header.
int WebEventOpenDerivedElementsEditor
int WebEventOpenFormularEditor Event for opening formular editor.
int WebEventOpenReportFrameElement Event for opening an element of the report frame.
int WebEventPivotToPageAxis This constant is deprecated. This event has been deprecated and is no longer in use. Instead we can directly use the pivot event on the view bean VIEW_EVENT_PIVOT.
int WebEventReportPageBy event for page by.
int WebEventShowAdvancedDrillEditor event for showing the advanced drill editor within the simple drill editor.
int WebEventShowAttributeForms Event for the preference to show the attribute forms on the grid.
int WebEventToggleReportBar Event for toggle the report bar a.k.a.
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final String ITEM_SEPARATOR

Constant Value: "__"

public static final int WebEventAddViewFilterCondition

Event to fire when "Add View filter condition" is clicked.
It will open the view filter editor, and display add expression wizard.

Constant Value: 6015 (0x0000177f)

public static final int WebEventAddWebElementsToFilter

Event to add element qualification to the filter.

Constant Value: 6020 (0x00001784)

public static final int WebEventArgumentAdvancedDrillEditor

event argument: argument to show advanced drill editor in the simple drill editor.
If it's set to "1", the advanced drill editor will be displayed;
If it's set to "0", the advanced drill editor will not be displayed - back to simple drill editor.

Constant Value: 6010 (0x0000177a)

public static final int WebEventArgumentAdvancedDrillEditorName

event argument: the name of the drill editor to display.

Constant Value: 6031 (0x0000178f)

public static final int WebEventArgumentAttributeId

event argument: to set the attribute id on attribute form editor.

Constant Value: 6042 (0x0000179a)

public static final int WebEventArgumentDefaultAttrQualMode

event argument: for add to filter event, the default attr qualification mode.

Constant Value: 6043 (0x0000179b)

public static final int WebEventArgumentDesignModeCancel

event argument: HTML name for cancel button in design mode.

Constant Value: 6019 (0x00001783)

public static final int WebEventArgumentDesignModeChangeStage

event argument: the HTML name for the button toggling between template editor and report filter editor.

Constant Value: 6033 (0x00001791)

public static final int WebEventArgumentDesignModeExecute

event argument: HTML name for execute button in design mode.

Constant Value: 6017 (0x00001781)

public static final int WebEventArgumentDesignModeForm

event argument: HTML form name for design mode "command" area.

Constant Value: 6032 (0x00001790)

public static final int WebEventArgumentDesignModeSave

event argument: HTML name for saveas button in design mode.

Constant Value: 6018 (0x00001782)

public static final int WebEventArgumentDragAndDropAttFormID

event argument: HTML name the dragged attribute form id item in the drag-and-drop form.

Constant Value: 6039 (0x00001797)

public static final int WebEventArgumentDragAndDropAttFormPosition

event argument: HTML name the target form position within the attribute item in the drag-and-drop form.

Constant Value: 6040 (0x00001798)

public static final int WebEventArgumentDragAndDropFirstMetric

event argument: Indicate whether it's the first metric that is dragged on to grid.

Constant Value: 6035 (0x00001793)

public static final int WebEventArgumentDragAndDropForm

event argument: HTML name for drag and drop form.

Constant Value: 6020 (0x00001784)

public static final int WebEventArgumentDragAndDropFromAxis

event argument: HTML name the original axis item in the drag-and-drop form.

Constant Value: 6021 (0x00001785)

public static final int WebEventArgumentDragAndDropFromPos

event argument: HTML name the original position item in the drag-and-drop form.

Constant Value: 6022 (0x00001786)

public static final int WebEventArgumentDragAndDropFromType

event argument: HTML name the original object type item in the drag-and-drop form.

Constant Value: 6023 (0x00001787)

public static final int WebEventArgumentDragAndDropObjectAlias

event argument: HTML name the dragged object alias item in the drag-and-drop form.
It's used to identify the object being dragged.

Constant Value: 6029 (0x0000178d)

public static final int WebEventArgumentDragAndDropObjectID

event argument: HTML name the dragged object id item in the drag-and-drop form.
It's used to identify the object being dragged.

Constant Value: 6027 (0x0000178b)

public static final int WebEventArgumentDragAndDropObjectType

event argument: HTML name the dragged object type item in the drag-and-drop form.
It's used to identify the object being dragged.

Constant Value: 6028 (0x0000178c)

public static final int WebEventArgumentDragAndDropToAxis

event argument: HTML name the target axis item in the drag-and-drop form.

Constant Value: 6024 (0x00001788)

public static final int WebEventArgumentDragAndDropToPos

event argument: HTML name the target position axis item in the drag-and-drop form.

Constant Value: 6025 (0x00001789)

public static final int WebEventArgumentDragAndDropToType

event argument: HTML name the target object type axis item in the drag-and-drop form.

Constant Value: 6026 (0x0000178a)

public static final int WebEventArgumentDrillEditorTitleAxis

Argument to specify the axis of the WebTitle for which we want to show all the drill paths in the advanced drill editor.
Allowed values are specified in EnumDSSXMLAxisName.
Position - The second argument is the position of the template unit within the axis. This value is 1-based.

Constant Value: 6011 (0x0000177b)

public static final int WebEventArgumentDrillEditorTitlePosition

Argument to specify the position of the WebTitle within the specified axis for which we want to show all the drill paths in the advanced drill editor.
This value is 1-based.

Constant Value: 6012 (0x0000177c)

public static final int WebEventArgumentForCustomSort

event argument: indicates that the derived element editor needs to be open for custom sort.

Constant Value: 6048 (0x000017a0)

public static final int WebEventArgumentFormularEditorAbsoluteIndex

event argument: whether the active element index for formula editor is absolute or not.
Absolute="1" means we preselect this item no matter the current user's previlege;
Absolute="0" means we consider whether user has InsertDerivedMetric previlege, if not, decrease the index number by 1.

Constant Value: 6037 (0x00001795)

public static final int WebEventArgumentFormularEditorActiveElement

event argument: the active element index to preselect when the formula editor is opened.

Constant Value: 6036 (0x00001794)

public static final int WebEventArgumentMergeColumnHeaders

event argument: whether to merge or repeat column headers.
"true" means merge, "false" means repeat.

Constant Value: 6038 (0x00001796)

public static final int WebEventArgumentObjectInfo

event argument: element info with ID|Type|Name format.
It's used to identify the object user dragged from object browser to filter editor section.

Constant Value: 6006 (0x00001776)

public static final int WebEventArgumentPageByApply

event argument: apply button/img name for the pageby section.
It's only used in HTML mode, not DHTML mode.

Constant Value: 6009 (0x00001779)

public static final int WebEventArgumentPageByDropdown

event argument: the HTML dropdown box name for pageby section.
If there are multiple pageby attributes, the dropdown boxes will be numbered.

Constant Value: 6008 (0x00001778)

public static final int WebEventArgumentPageByForm

event argument: the HTML form name for the pageby section.
It is used for both execute mode and design mode.

Constant Value: 6007 (0x00001777)

public static final int WebEventArgumentReportFrameElementName

event argument: the report frame element name to open or close.

Constant Value: 6034 (0x00001792)

public static final int WebEventArgumentShowAttributeForms

event argument: whether to show the attribute forms on the grid.
"1" means true, "0" means false.

Constant Value: 6041 (0x00001799)

public static final int WebEventArgumentShowAttributeList

event argument: whether to show the attribute list on the attribute forms editor

Constant Value: 6044 (0x0000179c)

public static final int WebEventArgumentShowReportBar

event argument: indicates we need to display the report toolbar

Constant Value: 6050 (0x000017a2)

public static final int WebEventArgumentTemplateEditorForm

event argument: the HTML form name for template editor.
It's used in design mode.

Constant Value: 6013 (0x0000177d)

public static final int WebEventArgumentTemplateEditorMoveMetricPrefix

event argument: the prefix name for moving metrics in template editor.
It's used in design mode.

Constant Value: 6016 (0x00001780)

public static final int WebEventArgumentTemplateEditorPivotPrefix

event argument: the prefix name for pivot images in template editor.
It's used in design mode.

Constant Value: 6014 (0x0000177e)

public static final int WebEventArgumentTemplateEditorRemoveMetricPrefix

event argument: the prefix name for removing metrics in template editor.
It's used in design mode.

Constant Value: 6030 (0x0000178e)

public static final int WebEventArgumentTemplateEditorRemovePrefix

event argument: the prefix name for removing images in template editor.
It's used in design mode.

Constant Value: 6015 (0x0000177f)

public static final int WebEventArgumentWebElements

event argument: list of elements to be added to filter. The element list should be seperated by ITEM_SEPARATOR

Constant Value: 6045 (0x0000179d)

public static final int WebEventArgumentXdaDimensionId

event argument: indicate the identifier of the xda dimension

Constant Value: 6046 (0x0000179e)

public static final int WebEventArgumentXdaHierarchyId

event argument: indicate the identifier of the xda hierarchy

Constant Value: 6047 (0x0000179f)

public static final int WebEventAttributeFormsEditor

Event for opening the Attribute Forms Editor

Constant Value: 6018 (0x00001782)

public static final int WebEventChangeDesignMode

Event for switching report mode between design mode and execute mode.

Constant Value: 6001 (0x00001771)

public static final int WebEventChangeOptimizedMode

Constant Value: 40011 (0x00009c4b)

public static final int WebEventCloseReportFrameElement

Event for closing an element of the report frame.
Report frame element is any gui section implementing ReportFrameElement interface.
For example, editors like filter editor, sort editor, drill editor, resize editor, formatting editors.

Constant Value: 6012 (0x0000177c)

public static final int WebEventDesignModePageBy

event for the pageby area in design mode.
This event handles pivoting and removing actions in the design mode.

Constant Value: 6008 (0x00001778)

public static final int WebEventDesignModeProcess

event for the "command" area in design mode page.
It includes "execute report", "save report", "cancel" buttons and toggling between template editor and filter editor.

Constant Value: 6010 (0x0000177a)

public static final int WebEventDesignModeTemplateEditor

event for the template editor area in design mode.
This event handles pivoting and removing actions in the design mode.

Constant Value: 6007 (0x00001777)

public static final int WebEventDragAndDrop

Generic event for drag and drop action in the application.
It covers a lot cases, such as pivot, remove, page by, drag from object browser to filter editor, etc.
It's only supported in DHTML mode, in which we submit the event throught javascript code.

Constant Value: 6009 (0x00001779)

public static final int WebEventFilterEditorAddElement

event for adding a new element to the filter editor.
For example, in object browser, we can click or drag-and-drop an attribute or metric
to create a qualification expression for it.

Constant Value: 6004 (0x00001774)

public static final int WebEventMergeColumnHeaders

Event for merge/repeat column header.
if user has "Read from report" choice on the grid preference page, we will toggle the report property;
if user has "Merge" or "Repeat" choice on the grid preference page, we will toggle the browser setting, which applies to all reports.

Constant Value: 6016 (0x00001780)

public static final int WebEventOpenDerivedElementsEditor

Constant Value: 6021 (0x00001785)

public static final int WebEventOpenFormularEditor

Event for opening formular editor.
It is a special case of WebEventOpenReportFrameElement, in that it has its own arguments to set the preselected item's index in the formular dropdown box.

Constant Value: 6014 (0x0000177e)

public static final int WebEventOpenReportFrameElement

Event for opening an element of the report frame.
Report frame element is any gui section implementing ReportFrameElement interface.
For example, editors like filter editor, sort editor, drill editor, resize editor, formatting editors.

Constant Value: 6011 (0x0000177b)

public static final int WebEventPivotToPageAxis

This constant is deprecated.
This event has been deprecated and is no longer in use. Instead we can directly use the pivot event on the view bean VIEW_EVENT_PIVOT.

A special pivot event for pivoting to pageby axis. We have some extra logic to handle before ReportBean handles the real pivoting functionality.

Constant Value: 6013 (0x0000177d)

public static final int WebEventReportPageBy

event for page by.
This is different from the pageby event on the report bean level, in that it includes the HTML form information in the application.

Constant Value: 6005 (0x00001775)

public static final int WebEventShowAdvancedDrillEditor

event for showing the advanced drill editor within the simple drill editor.

Constant Value: 6006 (0x00001776)

public static final int WebEventShowAttributeForms

Event for the preference to show the attribute forms on the grid.

Constant Value: 6017 (0x00001781)

public static final int WebEventToggleReportBar

Event for toggle the report bar a.k.a. report toolbar

Constant Value: 6022 (0x00001786)