Supported Bean: RWFrameBean

The RWFrameBean is an application-level bean in charge of displaying and coordinate the elements on the ReportWriter page. It's the counterpart of the ReportFrameBean in the Report page, or the DocumentFrameBean in the Document page.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanRWFrame (55)

Application bean type for the RWFrame bean

Events

browseParentFolder, changeDesignMode, closeElement, displayDividers, displayGrid, displayRulers, openElement, save, setCurrentViewMode, setDefaultDeleteMode, setDefaultInsertMode, setVisualizationMode, toggleEditableViewMode

browseParentFolder
Event to browse the content of parent folder.

41003

EnumFrameEvents.WebEventBrowseParentFolder
changeDesignMode
Event to change the design mode of the RWFrame. It uses the EnumServletEvents.WebEventArgumentReportDesignMode as argument.

55001

EnumRWFrameEvents.WebEventChangeDesignMode

*rwDesignMode

Argument to specify report's execution mode.
This parameter is a String representation for an int value. It's used to determine how the report will be executed. Report has different behavior depending upon what execution mode is set, hence, permissions and functionality differs among these modes. Argument is used in following event:
  • EnumServletEvents.WebEventEditReport
    The available int values for this parameter are specified in EnumReportViewModes

    • 3017

    EnumServletEvents.WebEventArgumentReportDesignMode
    closeElement
    Event to close an element of the document frame.

    41002

    EnumFrameEvents.WebEventCloseFrameElement

    *name

    		Argument to specify the naame of the element to open or close in the document frame.

    41001

    EnumDocumentFrameEvents.WebEventArgumentDocumentFrameElementName
    displayDividers
    Event to turn on/off the section dividers of the document It uses the EnumRWFrameEvents.WebEventArgumentDisplayElement to indicate whether they should on/off.

    55004

    EnumRWFrameEvents.WebEventDisplaySectionDividers

    shouldDisplay

    		Event Argument indicating whether the element should be displayed or not. Used in the EnumRWFrameEvents.WebEventDisplayRulers , EnumRWFrameEvents.WebEventDisplayAlignmentGrid, EnumRWFrameEvents.WebEventDisplaySectionDividers events.

    55002

    EnumRWFrameEvents.WebEventArgumentDisplayElement
    displayGrid
    Event to turn on/off the alignment grid of the document. It uses the EnumRWFrameEvents.WebEventArgumentDisplayElement to indicate whether they should on/off.

    55003

    EnumRWFrameEvents.WebEventDisplayAlignmentGrid

    shouldDisplay

    		Event Argument indicating whether the element should be displayed or not. Used in the EnumRWFrameEvents.WebEventDisplayRulers , EnumRWFrameEvents.WebEventDisplayAlignmentGrid, EnumRWFrameEvents.WebEventDisplaySectionDividers events.

    55002

    EnumRWFrameEvents.WebEventArgumentDisplayElement
    displayRulers
    Event to turn on/off the rulers of the document It uses the EnumRWFrameEvents.WebEventArgumentDisplayElement to indicate whether they should on/off.

    55002

    EnumRWFrameEvents.WebEventDisplayRulers

    shouldDisplay

    		Event Argument indicating whether the element should be displayed or not. Used in the EnumRWFrameEvents.WebEventDisplayRulers , EnumRWFrameEvents.WebEventDisplayAlignmentGrid, EnumRWFrameEvents.WebEventDisplaySectionDividers events.

    55002

    EnumRWFrameEvents.WebEventArgumentDisplayElement
    openElement
    Event to open an element of the document frame.

    41001

    EnumFrameEvents.WebEventOpenFrameElement

    *name

    		Argument to specify the naame of the element to open or close in the document frame.

    41001

    EnumDocumentFrameEvents.WebEventArgumentDocumentFrameElementName
    save

    89002

    EnumEditableObjectAppBeanEvents.WebEventEditableObjectSave

    shouldReturn

    89001

    EnumEditableObjectAppBeanEvents.WebEventArgumentShouldReturn
    setCurrentViewMode

    55006

    EnumRWFrameEvents.WebEventSetCurrentViewMode

    currentViewMode

    		Event argument indicating the view mode to be used for rendering the frame contents

    55004

    EnumRWFrameEvents.WebEventArgumentCurrentViewMode
    setDefaultDeleteMode

    55008

    EnumRWFrameEvents.WebEventSetDefaultDeleteMode

    *deleteMode

    55006

    EnumRWFrameEvents.WebEventArgumentDefaultDeleteMode
    setDefaultInsertMode

    55007

    EnumRWFrameEvents.WebEventSetDefaultInsertMode

    *insertMode

    55005

    EnumRWFrameEvents.WebEventArgumentDefaultInsertMode
    setVisualizationMode
    Event that sets visualization mode

    2048065

    EnumRWBeanEvents.REPORT_WRITER_EVENT_SET_VISUALIZATION_MODE

    layoutId

    2048190

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_IS_ASCENDING

    visualizationMode

    		Visualization mode.

    2048109

    EnumRWBeanEvents.REPORT_WRITER_EVENT_ARGUMENT_VISUALIZATION_MODE
    toggleEditableViewMode
    Event to toggle the RWD between editable view mode and non editable view mode It uses the EnumServletEvents.WebEventArgumentReportDesignMode as argument.

    55005

    EnumRWFrameEvents.WebEventToggleEditableViewMode

    editableViewMode

    		Event Argument indicating the state of the RWD w.r.t editable/non editable view mode. Used in the event EnumRWFrameEvents.WebEventToggleEditableViewMode ,

    55003

    EnumRWFrameEvents.WebEventArgumentEditableViewMode

    Notes

    * denotes required field.