public interface

RWFrameBean

implements FrameBean
com.microstrategy.web.app.beans.RWFrameBean

Class Overview

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.

See Also

Summary

Constants
String COMPONENT_CURRENT_EDITOR
String COMPONENT_DATA
String COMPONENT_EDITOR_MESSAGE
String COMPONENT_ERROR
String COMPONENT_FILTER
String COMPONENT_GRAPH_TOOLBAR
String COMPONENT_GROUP_BY
String COMPONENT_LAST_UPDATE
String COMPONENT_MACROS_BROWSER
String COMPONENT_MENUS
String COMPONENT_OBJECT_BROWSER
int EDITABLE_VIEW_MODE_DEFAULT Constat that represents the default view mode
int EDITABLE_VIEW_MODE_NO Constat that represents that the RWD is in NON EDITABLE view mode
int EDITABLE_VIEW_MODE_YES Constat that represents that the RWD is in EDITABLE view mode
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract void convertIVEToDocument()
Converts an IVE document to a Report Services Document
abstract int getAvailableViewMedia()
abstract int getAvailableViewModes()
This method is deprecated. please use getAvailableViewMedia
abstract int getCurrentViewMedia()
abstract int getCurrentViewMode()
This method is deprecated. please use getCurrentViewMedia
abstract int getDesignMode()
Returns the view mode of the RW frame bean (a value from EnumReportViewModes)
abstract int getEditableViewMode()
This method is deprecated. Use getCurrentViewMedia instead.
abstract boolean getIsDatasetAdded()
Returns whether a dataset hs been added to the RW frame bean
abstract boolean getIsDesignMode()
Returns whether the view mode of the RW frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign
abstract PromptsContainerBean getPromptsContainerBean()
Get the Prompts Container Bean.
abstract RWBean getRWBean()
Returns the RW bean associated with this RW frame bean.
abstract RWWorkingSetBrowserTabBean getRWObjectBrowserBean()
Returns the ObjectBrowser bean associated with this RW frame bean.
abstract String getSelections()
Returns the comma seperated list of client side selections
abstract String getViewerScroll()
Returns the scroll top and left for the viewer.
abstract boolean isAlignmentGridOn()
abstract boolean isRulersOn()
abstract boolean isSectionDividersOn()
abstract void setCurrentViewMedia(int viewMedia)
abstract void setCurrentViewMode(int viewMode)
This method is deprecated. please use setCurrentViewMedia
abstract void setDesignMode(int designMode)
Sets the view mode of the RW frame bean (a value from EnumReportViewModes)
abstract void setEditableViewMode(int value)
This method is deprecated. Use setCurrentViewMedia instead.
abstract void setIsAlignmentGridOn(boolean value)
Sets whether the alignment grid for the document should be on.
abstract void setIsDatasetAdded(boolean isDatasetAdded)
Sets the the value of isDatasetAdded
abstract void setIsRulersOn(boolean value)
Sets whether the rulers for the document should be on.
abstract void setIsSectionDividersOn(boolean value)
Sets whether the section divider for the document should be on.
abstract void setSelections(String selections)
Sets the the comma seperated list of client side selections
abstract void setViewerScroll(String scrollPosition)
Set the scroll top and left for the viewer.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final String COMPONENT_CURRENT_EDITOR

Constant Value: "rw_current_editor"

public static final String COMPONENT_DATA

Constant Value: "rw_data"

public static final String COMPONENT_EDITOR_MESSAGE

Constant Value: "rw_editor_message"

public static final String COMPONENT_ERROR

Constant Value: "rw_error"

public static final String COMPONENT_FILTER

Constant Value: "rw_filter"

public static final String COMPONENT_GRAPH_TOOLBAR

Constant Value: "rw_toolbar_graph"

public static final String COMPONENT_GROUP_BY

Constant Value: "rw_group_by"

public static final String COMPONENT_LAST_UPDATE

Constant Value: "rw_last_update"

public static final String COMPONENT_MACROS_BROWSER

Constant Value: "rw_macros_browser"

public static final String COMPONENT_MENUS

Constant Value: "rw_menus"

public static final String COMPONENT_OBJECT_BROWSER

Constant Value: "rw_object_browser"

public static final int EDITABLE_VIEW_MODE_DEFAULT

Constat that represents the default view mode

Constant Value: 0 (0x00000000)

public static final int EDITABLE_VIEW_MODE_NO

Constat that represents that the RWD is in NON EDITABLE view mode

Constant Value: 2 (0x00000002)

public static final int EDITABLE_VIEW_MODE_YES

Constat that represents that the RWD is in EDITABLE view mode

Constant Value: 1 (0x00000001)

Public Methods

public abstract void convertIVEToDocument ()

Converts an IVE document to a Report Services Document

public abstract int getAvailableViewMedia ()

public abstract int getAvailableViewModes ()

This method is deprecated.
please use getAvailableViewMedia

Return the current available view modes.

Returns
  • Integer

public abstract int getCurrentViewMedia ()

public abstract int getCurrentViewMode ()

This method is deprecated.
please use getCurrentViewMedia

Return the current view mode.

Returns
  • Integer

public abstract int getDesignMode ()

Returns the view mode of the RW frame bean (a value from EnumReportViewModes)

Returns
  • the view mode of the RW frame bean (a value from EnumReportViewModes)

public abstract int getEditableViewMode ()

This method is deprecated.
Use getCurrentViewMedia instead.

Returns current view mode of the RWD with respect to editable or non editable

Returns
  • current view mode of the RWD with respect to editable or non editable

public abstract boolean getIsDatasetAdded ()

Returns whether a dataset hs been added to the RW frame bean

Returns
  • a boolean indicating if a dataset has been added to the frame bean

public abstract boolean getIsDesignMode ()

Returns whether the view mode of the RW frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign

Returns
  • boolean true if the the RW frame bean is in design mode

public abstract PromptsContainerBean getPromptsContainerBean ()

Get the Prompts Container Bean.

Returns
  • the prompts container bean associated with the frame

public abstract RWBean getRWBean ()

Returns the RW bean associated with this RW frame bean.

Returns
  • the RW bean associated with this RW frame bean

public abstract RWWorkingSetBrowserTabBean getRWObjectBrowserBean ()

Returns the ObjectBrowser bean associated with this RW frame bean.

Returns
  • the ObjectBrowser bean associated with this RW frame bean

public abstract String getSelections ()

Returns the comma seperated list of client side selections

Returns
  • the comma seperated list of client side selections

public abstract String getViewerScroll ()

Returns the scroll top and left for the viewer. It is stored in a comma seperated format with the scroll top followed by the scroll left.

Returns
  • The comma seperated value of the viewer top scroll and viewer left scroll

public abstract boolean isAlignmentGridOn ()

Returns
  • boolean true if the alignment grid for the document should be on

public abstract boolean isRulersOn ()

Returns
  • boolean true if the rulers for the document should be on

public abstract boolean isSectionDividersOn ()

Returns
  • boolean true if the section's dividers for the document should be on

public abstract void setCurrentViewMedia (int viewMedia)

public abstract void setCurrentViewMode (int viewMode)

This method is deprecated.
please use setCurrentViewMedia

Set the current view mode.

public abstract void setDesignMode (int designMode)

Sets the view mode of the RW frame bean (a value from EnumReportViewModes)

Parameters
designMode the view mode of the RW frame bean (a value from EnumReportViewModes)

public abstract void setEditableViewMode (int value)

This method is deprecated.
Use setCurrentViewMedia instead.

Sets the current view mode of the RWD with respect to editable or non editable

Parameters
value The current view mode of the RWD with respect to editable or non editable

public abstract void setIsAlignmentGridOn (boolean value)

Sets whether the alignment grid for the document should be on.

Parameters
value true if on.

public abstract void setIsDatasetAdded (boolean isDatasetAdded)

Sets the the value of isDatasetAdded

Parameters
isDatasetAdded The boolean value indicating whether a dataset object has been added to the frame bean

public abstract void setIsRulersOn (boolean value)

Sets whether the rulers for the document should be on.

Parameters
value true if on.

public abstract void setIsSectionDividersOn (boolean value)

Sets whether the section divider for the document should be on.

Parameters
value true if on.

public abstract void setSelections (String selections)

Sets the the comma seperated list of client side selections

Parameters
selections The comma seperated list of client side selections

public abstract void setViewerScroll (String scrollPosition)

Set the scroll top and left for the viewer. It is stored in a comma seperated format with the scroll top followed by the scroll left.

Parameters
scrollPosition The comma seperated value of the viewer top scroll and viewer left scroll