Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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.

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.FrameBean

abstract void	closeElement(FrameElement element) Mark as closed the corresponding FrameElement
abstract FrameElement	getCurrentEditor() It returns which is the current editor to be displayied.
abstract String	getDynamicMenuName() Name of the Shortcut object to use as Dynamic Menu
abstract String	getEditorMessage() This method is used to set a message related with an Editor action.
abstract Object	getIFrameComponent(String name) Returns the associated object associated with the iFrame component.
abstract Menu	getMenus() Returns the menus for this FrameBean based on the dynamicMenuName property.
abstract String	getMessageBeforeData() This method is deprecated. use `getEditorMessage()`
abstract String	getPromptStyle() Indicates actual prompt style used.
abstract WebComponent	getTargetBean() Returns the target bean associated with this FrameBean.
abstract boolean	getUseIFrame() Returns if the ReportFrame uses IFrames
abstract boolean	isOpen(FrameElement element) Checks if the given FrameElement is open
abstract void	openElement(FrameElement element) Mark as opened the corresponding FrameElement
abstract void	setDynamicMenuName(String dynamicMenuName) Name of the Shortcut object to use as DynamicMenu
abstract void	setEditorMessage(String message) This method is used to set a message related with an Editor action.
abstract void	setMessageBeforeData(String message) This method is deprecated. use `setEditorMessage(String)`
abstract void	setPromptStyle(String style) Specifies which style to use for prompt transforms.
abstract void	setUseIFrame(boolean value) Defines if the ReportFrame should use IFrame
abstract boolean	shouldDisplayContent(String name) Returns false if an iFrame component needs not to be rendered in an iFrame request.

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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

Interfaces

Classes

Exceptions

RWFrameBean

Class Overview

See Also

Summary

Constants

public static final String COMPONENT_CURRENT_EDITOR

public static final String COMPONENT_DATA

public static final String COMPONENT_EDITOR_MESSAGE

public static final String COMPONENT_ERROR

public static final String COMPONENT_FILTER

public static final String COMPONENT_GRAPH_TOOLBAR

public static final String COMPONENT_GROUP_BY

public static final String COMPONENT_LAST_UPDATE

public static final String COMPONENT_MACROS_BROWSER

public static final String COMPONENT_MENUS

public static final String COMPONENT_OBJECT_BROWSER

public static final int EDITABLE_VIEW_MODE_DEFAULT

public static final int EDITABLE_VIEW_MODE_NO

public static final int EDITABLE_VIEW_MODE_YES

Public Methods

public abstract void convertIVEToDocument ()

public abstract int getAvailableViewMedia ()

public abstract int getAvailableViewModes ()

Returns

public abstract int getCurrentViewMedia ()

public abstract int getCurrentViewMode ()

Returns

public abstract int getDesignMode ()

Returns

public abstract int getEditableViewMode ()

Returns

public abstract boolean getIsDatasetAdded ()

Returns

public abstract boolean getIsDesignMode ()

Returns

public abstract PromptsContainerBean getPromptsContainerBean ()

Returns

public abstract RWBean getRWBean ()

Returns

public abstract RWWorkingSetBrowserTabBean getRWObjectBrowserBean ()

Returns

public abstract String getSelections ()

Returns

public abstract String getViewerScroll ()

Returns

public abstract boolean isAlignmentGridOn ()

Returns

public abstract boolean isRulersOn ()

Returns

public abstract boolean isSectionDividersOn ()

Returns

public abstract void setCurrentViewMedia (int viewMedia)

public abstract void setCurrentViewMode (int viewMode)

public abstract void setDesignMode (int designMode)

Parameters

public abstract void setEditableViewMode (int value)

Parameters

public abstract void setIsAlignmentGridOn (boolean value)

Parameters

public abstract void setIsDatasetAdded (boolean isDatasetAdded)

Parameters

public abstract void setIsRulersOn (boolean value)

Parameters

public abstract void setIsSectionDividersOn (boolean value)

Parameters

public abstract void setSelections (String selections)

Parameters

public abstract void setViewerScroll (String scrollPosition)

Parameters