Package com.microstrategy.web.app.beans

Interface EnumReportFrameEvents

  • All Superinterfaces:
    EnumPageEvents, EnumServletEvents
    public interface EnumReportFrameEvents
extends EnumPageEvents
    All event definitions used in report frame bean (including its children components)
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • ITEM_SEPARATOR

        static final java.lang.String ITEM_SEPARATOR
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventChangeDesignMode

        static final int WebEventChangeDesignMode
        Event for switching report mode between design mode and execute mode.
        See Also:
        Constant Field Values

      • WebEventChangeOptimizedMode

        static final int WebEventChangeOptimizedMode
        See Also:
        Constant Field Values

      • WebEventFilterEditorAddElement

        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.
        See Also:
        Constant Field Values

      • WebEventReportPageBy

        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.
        See Also:
        Constant Field Values

      • WebEventShowAdvancedDrillEditor

        static final int WebEventShowAdvancedDrillEditor
        event for showing the advanced drill editor within the simple drill editor.
        See Also:
        Constant Field Values

      • WebEventDesignModeTemplateEditor

        static final int WebEventDesignModeTemplateEditor
        event for the template editor area in design mode.
        This event handles pivoting and removing actions in the design mode.
        See Also:
        Constant Field Values

      • WebEventDesignModePageBy

        static final int WebEventDesignModePageBy
        event for the pageby area in design mode.
        This event handles pivoting and removing actions in the design mode.
        See Also:
        Constant Field Values

      • WebEventDragAndDrop

        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.
        See Also:
        Constant Field Values

      • WebEventDesignModeProcess

        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.
        See Also:
        Constant Field Values

      • WebEventOpenReportFrameElement

        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.
        See Also:
        Constant Field Values

      • WebEventCloseReportFrameElement

        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.
        See Also:
        Constant Field Values

      • WebEventPivotToPageAxis

        @Deprecated
static final int WebEventPivotToPageAxis
        Deprecated.
        This event has been deprecated and is no longer in use. Instead we can directly use the pivot event on the view bean EnumViewBeanEvents.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.
        See Also:
        Constant Field Values

      • WebEventOpenFormularEditor

        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.
        See Also:
        Constant Field Values

      • WebEventAddViewFilterCondition

        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.
        See Also:
        Constant Field Values

      • WebEventMergeColumnHeaders

        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.
        See Also:
        Constant Field Values

      • WebEventShowAttributeForms

        static final int WebEventShowAttributeForms
        Event for the preference to show the attribute forms on the grid.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventAttributeFormsEditor

        static final int WebEventAttributeFormsEditor
        Event for opening the Attribute Forms Editor
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventAddWebElementsToFilter

        static final int WebEventAddWebElementsToFilter
        Event to add element qualification to the filter.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventOpenDerivedElementsEditor

        static final int WebEventOpenDerivedElementsEditor
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventToggleReportBar

        static final int WebEventToggleReportBar
        Event for toggle the report bar a.k.a. report toolbar
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentObjectInfo

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentPageByForm

        static final int WebEventArgumentPageByForm
        event argument: the HTML form name for the pageby section.
        It is used for both execute mode and design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentPageByDropdown

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentPageByApply

        static final int WebEventArgumentPageByApply
        event argument: apply button/img name for the pageby section.
        It's only used in HTML mode, not DHTML mode.
        See Also:
        Constant Field Values

      • WebEventArgumentAdvancedDrillEditor

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentDrillEditorTitleAxis

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentDrillEditorTitlePosition

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentTemplateEditorForm

        static final int WebEventArgumentTemplateEditorForm
        event argument: the HTML form name for template editor.
        It's used in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentTemplateEditorPivotPrefix

        static final int WebEventArgumentTemplateEditorPivotPrefix
        event argument: the prefix name for pivot images in template editor.
        It's used in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentTemplateEditorRemovePrefix

        static final int WebEventArgumentTemplateEditorRemovePrefix
        event argument: the prefix name for removing images in template editor.
        It's used in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentTemplateEditorMoveMetricPrefix

        static final int WebEventArgumentTemplateEditorMoveMetricPrefix
        event argument: the prefix name for moving metrics in template editor.
        It's used in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentTemplateEditorRemoveMetricPrefix

        static final int WebEventArgumentTemplateEditorRemoveMetricPrefix
        event argument: the prefix name for removing metrics in template editor.
        It's used in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentDesignModeExecute

        static final int WebEventArgumentDesignModeExecute
        event argument: HTML name for execute button in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentDesignModeSave

        static final int WebEventArgumentDesignModeSave
        event argument: HTML name for saveas button in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentDesignModeCancel

        static final int WebEventArgumentDesignModeCancel
        event argument: HTML name for cancel button in design mode.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropForm

        static final int WebEventArgumentDragAndDropForm
        event argument: HTML name for drag and drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropFromAxis

        static final int WebEventArgumentDragAndDropFromAxis
        event argument: HTML name the original axis item in the drag-and-drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropFromPos

        static final int WebEventArgumentDragAndDropFromPos
        event argument: HTML name the original position item in the drag-and-drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropFromType

        static final int WebEventArgumentDragAndDropFromType
        event argument: HTML name the original object type item in the drag-and-drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropToAxis

        static final int WebEventArgumentDragAndDropToAxis
        event argument: HTML name the target axis item in the drag-and-drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropToPos

        static final int WebEventArgumentDragAndDropToPos
        event argument: HTML name the target position axis item in the drag-and-drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropToType

        static final int WebEventArgumentDragAndDropToType
        event argument: HTML name the target object type axis item in the drag-and-drop form.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropObjectID

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropObjectType

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropObjectAlias

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropFirstMetric

        static final int WebEventArgumentDragAndDropFirstMetric
        event argument: Indicate whether it's the first metric that is dragged on to grid.
        See Also:
        Constant Field Values

      • WebEventArgumentAdvancedDrillEditorName

        static final int WebEventArgumentAdvancedDrillEditorName
        event argument: the name of the drill editor to display.
        See Also:
        Constant Field Values

      • WebEventArgumentDesignModeForm

        static final int WebEventArgumentDesignModeForm
        event argument: HTML form name for design mode "command" area.
        See Also:
        Constant Field Values

      • WebEventArgumentDesignModeChangeStage

        static final int WebEventArgumentDesignModeChangeStage
        event argument: the HTML name for the button toggling between template editor and report filter editor.
        See Also:
        Constant Field Values

      • WebEventArgumentReportFrameElementName

        static final int WebEventArgumentReportFrameElementName
        event argument: the report frame element name to open or close.
        See Also:
        Constant Field Values

      • WebEventArgumentFormularEditorActiveElement

        static final int WebEventArgumentFormularEditorActiveElement
        event argument: the active element index to preselect when the formula editor is opened.
        See Also:
        Constant Field Values

      • WebEventArgumentFormularEditorAbsoluteIndex

        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.
        See Also:
        Constant Field Values

      • WebEventArgumentMergeColumnHeaders

        static final int WebEventArgumentMergeColumnHeaders
        event argument: whether to merge or repeat column headers.
        "true" means merge, "false" means repeat.
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropAttFormID

        static final int WebEventArgumentDragAndDropAttFormID
        event argument: HTML name the dragged attribute form id item in the drag-and-drop form.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentDragAndDropAttFormPosition

        static final int WebEventArgumentDragAndDropAttFormPosition
        event argument: HTML name the target form position within the attribute item in the drag-and-drop form.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentShowAttributeForms

        static final int WebEventArgumentShowAttributeForms
        event argument: whether to show the attribute forms on the grid.
        "1" means true, "0" means false.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentAttributeId

        static final int WebEventArgumentAttributeId
        event argument: to set the attribute id on attribute form editor.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentDefaultAttrQualMode

        static final int WebEventArgumentDefaultAttrQualMode
        event argument: for add to filter event, the default attr qualification mode.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentShowAttributeList

        static final int WebEventArgumentShowAttributeList
        event argument: whether to show the attribute list on the attribute forms editor
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentWebElements

        static final int WebEventArgumentWebElements
        event argument: list of elements to be added to filter. The element list should be seperated by ITEM_SEPARATOR
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentXdaDimensionId

        static final int WebEventArgumentXdaDimensionId
        event argument: indicate the identifier of the xda dimension
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • WebEventArgumentXdaHierarchyId

        static final int WebEventArgumentXdaHierarchyId
        event argument: indicate the identifier of the xda hierarchy
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • WebEventArgumentForCustomSort

        static final int WebEventArgumentForCustomSort
        event argument: indicates that the derived element editor needs to be open for custom sort.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentShowReportBar

        static final int WebEventArgumentShowReportBar
        event argument: indicates we need to display the report toolbar
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values