All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameBean, Persistable, RequestPersistable, Transformable, WebComponent
```
public interface RWFrameBean
extends FrameBean
```
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.

Since:

MicroStrategy Web 8.0.0

See Also:

FrameBean

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`COMPONENT_CURRENT_EDITOR`
`static java.lang.String`	`COMPONENT_DATA`
`static java.lang.String`	`COMPONENT_EDITOR_MESSAGE`
`static java.lang.String`	`COMPONENT_ERROR`
`static java.lang.String`	`COMPONENT_FILTER`
`static java.lang.String`	`COMPONENT_GRAPH_TOOLBAR`
`static java.lang.String`	`COMPONENT_GROUP_BY`
`static java.lang.String`	`COMPONENT_LAST_UPDATE`
`static java.lang.String`	`COMPONENT_MACROS_BROWSER`
`static java.lang.String`	`COMPONENT_MENUS`
`static java.lang.String`	`COMPONENT_OBJECT_BROWSER`
`static int`	`EDITABLE_VIEW_MODE_DEFAULT`	Constat that represents the default view mode
`static int`	`EDITABLE_VIEW_MODE_NO`	Constat that represents that the RWD is in NON EDITABLE view mode
`static int`	`EDITABLE_VIEW_MODE_YES`	Constat that represents that the RWD is in EDITABLE view mode

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`convertIVEToDocument()`	Converts an IVE document to a Report Services Document
`int`	`getAvailableViewMedia()`
`int`	`getAvailableViewModes()`	Deprecated. please use getAvailableViewMedia
`int`	`getCurrentViewMedia()`
`int`	`getCurrentViewMode()`	Deprecated. please use getCurrentViewMedia
`int`	`getDesignMode()`	Returns the view mode of the RW frame bean (a value from EnumReportViewModes)
`int`	`getEditableViewMode()`	Deprecated. Use getCurrentViewMedia instead.
`boolean`	`getIsDatasetAdded()`	Returns whether a dataset hs been added to the RW frame bean
`boolean`	`getIsDesignMode()`	Returns whether the view mode of the RW frame bean (a value from EnumReportViewModes) is equal to `EnumReportViewModes.ReportViewModeDesign`
`PromptsContainerBean`	`getPromptsContainerBean()`	Get the Prompts Container Bean.
`RWBean`	`getRWBean()`	Returns the RW bean associated with this RW frame bean.
`RWWorkingSetBrowserTabBean`	`getRWObjectBrowserBean()`	Returns the ObjectBrowser bean associated with this RW frame bean.
`java.lang.String`	`getSelections()`	Returns the comma seperated list of client side selections
`java.lang.String`	`getViewerScroll()`	Returns the scroll top and left for the viewer.
`boolean`	`isAlignmentGridOn()`
`boolean`	`isRulersOn()`
`boolean`	`isSectionDividersOn()`
`void`	`setCurrentViewMedia(int viewMedia)`
`void`	`setCurrentViewMode(int viewMode)`	Deprecated. please use setCurrentViewMedia
`void`	`setDesignMode(int designMode)`	Sets the view mode of the RW frame bean (a value from EnumReportViewModes)
`void`	`setEditableViewMode(int value)`	Deprecated. Use setCurrentViewMedia instead.
`void`	`setIsAlignmentGridOn(boolean value)`	Sets whether the alignment grid for the document should be on.
`void`	`setIsDatasetAdded(boolean isDatasetAdded)`	Sets the the value of isDatasetAdded
`void`	`setIsRulersOn(boolean value)`	Sets whether the rulers for the document should be on.
`void`	`setIsSectionDividersOn(boolean value)`	Sets whether the section divider for the document should be on.
`void`	`setSelections(java.lang.String selections)`	Sets the the comma seperated list of client side selections
`void`	`setViewerScroll(java.lang.String scrollPosition)`	Set the scroll top and left for the viewer.

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.FrameBean
closeElement, getCurrentEditor, getDynamicMenuName, getEditorMessage, getIFrameComponent, getMenus, getMessageBeforeData, getPromptStyle, getTargetBean, getUseIFrame, isOpen, openElement, setDynamicMenuName, setEditorMessage, setMessageBeforeData, setPromptStyle, setUseIFrame, shouldDisplayContent

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Field Detail
  - COMPONENT_MENUS
```
static final java.lang.String COMPONENT_MENUS
```
    See Also:
    
    Constant Field Values
  - COMPONENT_DATA
```
static final java.lang.String COMPONENT_DATA
```
    See Also:
    
    Constant Field Values
  - COMPONENT_OBJECT_BROWSER
```
static final java.lang.String COMPONENT_OBJECT_BROWSER
```
    See Also:
    
    Constant Field Values
  - COMPONENT_MACROS_BROWSER
```
static final java.lang.String COMPONENT_MACROS_BROWSER
```
    See Also:
    
    Constant Field Values
  - COMPONENT_GROUP_BY
```
static final java.lang.String COMPONENT_GROUP_BY
```
    See Also:
    
    Constant Field Values
  - COMPONENT_GRAPH_TOOLBAR
```
static final java.lang.String COMPONENT_GRAPH_TOOLBAR
```
    See Also:
    
    Constant Field Values
  - COMPONENT_ERROR
```
static final java.lang.String COMPONENT_ERROR
```
    See Also:
    
    Constant Field Values
  - COMPONENT_FILTER
```
static final java.lang.String COMPONENT_FILTER
```
    See Also:
    
    Constant Field Values
  - COMPONENT_CURRENT_EDITOR
```
static final java.lang.String COMPONENT_CURRENT_EDITOR
```
    See Also:
    
    Constant Field Values
  - COMPONENT_LAST_UPDATE
```
static final java.lang.String COMPONENT_LAST_UPDATE
```
    See Also:
    
    Constant Field Values
  - COMPONENT_EDITOR_MESSAGE
```
static final java.lang.String COMPONENT_EDITOR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - EDITABLE_VIEW_MODE_DEFAULT
```
static final int EDITABLE_VIEW_MODE_DEFAULT
```
    Constat that represents the default view mode
    
    See Also:
    
    Constant Field Values
  - EDITABLE_VIEW_MODE_YES
```
static final int EDITABLE_VIEW_MODE_YES
```
    Constat that represents that the RWD is in EDITABLE view mode
    
    See Also:
    
    Constant Field Values
  - EDITABLE_VIEW_MODE_NO
```
static final int EDITABLE_VIEW_MODE_NO
```
    Constat that represents that the RWD is in NON EDITABLE view mode
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getRWBean
```
RWBean getRWBean()
```
    Returns the RW bean associated with this RW frame bean.
    
    Returns:
    
    the RW bean associated with this RW frame bean
  - getRWObjectBrowserBean
```
RWWorkingSetBrowserTabBean getRWObjectBrowserBean()
```
    Returns the ObjectBrowser bean associated with this RW frame bean.
    
    Returns:
    
    the ObjectBrowser bean associated with this RW frame bean
  - getDesignMode
```
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)
  - getIsDesignMode
```
boolean getIsDesignMode()
```
    Returns whether the view mode of the RW frame bean (a value from EnumReportViewModes) is equal to EnumReportViewModes.ReportViewModeDesign
    
    Returns:
    
    boolean true if the the RW frame bean is in design mode
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getIsDatasetAdded
```
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
    
    Since:
    
    MicroStrategy Web 8.0.1
  - setDesignMode
```
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)
  - setIsDatasetAdded
```
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
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getSelections
```
java.lang.String getSelections()
```
    Returns the comma seperated list of client side selections
    
    Returns:
    
    the comma seperated list of client side selections
  - setSelections
```
void setSelections(java.lang.String selections)
```
    Sets the the comma seperated list of client side selections
    
    Parameters:
    
    selections - The comma seperated list of client side selections
  - getViewerScroll
```
java.lang.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
    
    Since:
    
    MicroStrategy Web 8.0.2
  - setViewerScroll
```
void setViewerScroll(java.lang.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
    
    Since:
    
    MicroStrategy Web 8.0.2
  - isRulersOn
```
boolean isRulersOn()
```
    Returns:
    
    boolean true if the rulers for the document should be on
  - setIsRulersOn
```
void setIsRulersOn(boolean value)
```
    Sets whether the rulers for the document should be on.
    
    Parameters:
    
    value - true if on.
  - isAlignmentGridOn
```
boolean isAlignmentGridOn()
```
    Returns:
    
    boolean true if the alignment grid for the document should be on
  - setIsAlignmentGridOn
```
void setIsAlignmentGridOn(boolean value)
```
    Sets whether the alignment grid for the document should be on.
    
    Parameters:
    
    value - true if on.
  - isSectionDividersOn
```
boolean isSectionDividersOn()
```
    Returns:
    
    boolean true if the section's dividers for the document should be on
  - setIsSectionDividersOn
```
void setIsSectionDividersOn(boolean value)
```
    Sets whether the section divider for the document should be on.
    
    Parameters:
    
    value - true if on.
  - getEditableViewMode
```
@Deprecated
int getEditableViewMode()
```
    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
  - setEditableViewMode
```
@Deprecated
void setEditableViewMode(int value)
```
    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
  - getPromptsContainerBean
```
PromptsContainerBean getPromptsContainerBean()
```
    Get the Prompts Container Bean.
    
    Returns:
    
    the prompts container bean associated with the frame
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getCurrentViewMode
```
@Deprecated
int getCurrentViewMode()
```
    Deprecated.
    please use getCurrentViewMedia
    
    Return the current view mode.
    
    Returns:
    
    Integer
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getCurrentViewMedia
```
int getCurrentViewMedia()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getAvailableViewModes
```
@Deprecated
int getAvailableViewModes()
```
    Deprecated.
    please use getAvailableViewMedia
    
    Return the current available view modes.
    
    Returns:
    
    Integer
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getAvailableViewMedia
```
int getAvailableViewMedia()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - setCurrentViewMode
```
@Deprecated
void setCurrentViewMode(int viewMode)
```
    Deprecated.
    please use setCurrentViewMedia
    
    Set the current view mode.
    
    Parameters:
    
    viewMode -
    
    Since:
    
    MicroStrategy Web 8.1.0
  - setCurrentViewMedia
```
void setCurrentViewMedia(int viewMedia)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - convertIVEToDocument
```
void convertIVEToDocument()
```
    Converts an IVE document to a Report Services Document
    
    Since:
    
    MicroStrategy Web 9.2.1

Interface RWFrameBean

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

Method Summary

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

Methods inherited from interface com.microstrategy.web.app.beans.FrameBean

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

Methods inherited from interface com.microstrategy.web.beans.Transformable

Methods inherited from interface com.microstrategy.web.beans.WebComponent

Field Detail

COMPONENT_MENUS

COMPONENT_DATA

COMPONENT_OBJECT_BROWSER

COMPONENT_MACROS_BROWSER

COMPONENT_GROUP_BY

COMPONENT_GRAPH_TOOLBAR

COMPONENT_ERROR

COMPONENT_FILTER

COMPONENT_CURRENT_EDITOR

COMPONENT_LAST_UPDATE

COMPONENT_EDITOR_MESSAGE

EDITABLE_VIEW_MODE_DEFAULT

EDITABLE_VIEW_MODE_YES

EDITABLE_VIEW_MODE_NO

Method Detail

getRWBean

getRWObjectBrowserBean

getDesignMode

getIsDesignMode

getIsDatasetAdded

setDesignMode

setIsDatasetAdded

getSelections

setSelections

getViewerScroll

setViewerScroll

isRulersOn

setIsRulersOn

isAlignmentGridOn

setIsAlignmentGridOn

isSectionDividersOn

setIsSectionDividersOn

getEditableViewMode

setEditableViewMode

getPromptsContainerBean

getCurrentViewMode

getCurrentViewMedia

getAvailableViewModes

getAvailableViewMedia

setCurrentViewMode

setCurrentViewMedia

convertIVEToDocument