public class

ReportFrameBeanImpl

extends AbstractPersistableAppComponent
implements FrameBean ReportFrameBean

java.lang.Object
↳	com.microstrategy.utils.serialization.AbstractPersistable
	↳	com.microstrategy.web.beans.AbstractTransformable
		↳	com.microstrategy.web.beans.AbstractWebComponent
			↳	com.microstrategy.web.app.beans.AbstractAppComponent
				↳	com.microstrategy.web.app.beans.AbstractPersistableAppComponent
					↳	com.microstrategy.web.app.beans.ReportFrameBeanImpl

Class Overview

The ReportFrameBeanImpl is a container for the ReportBean and all the beans associated with it, such as editors, formula bar, etc.

Summary

Constants
String	REPORT_FILTER_NAME
String	REPORT_LIMIT_NAME
String	VIEW_FILTER_NAME
String	VIEW_LIMIT_NAME

[Expand]

Inherited Constants

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

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

Fields
protected String	_editor	Local property which value reflects the current editor
protected String	_promptStyle	Local property which stores the actual prompt style used.

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

Public Methods
void	addChild(String key, WebComponent child) Adds a child component to the current `WebComponent`.
void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
void	closeElement(FrameElement element) Mark as closed the corresponding ReportFrameElement
void	collectData() We need to over-ride the collectdata on the ReportFrame so that we can clear the promptStyle property when the report bean is successful or ends in error
void	doCollectData() For performance, this method overrides the default collectData() by checking if the ReportBean will be displayed, and if not it will not trigger it's collectData().
MarkupOutput	generateOutput() This method creates a `ReportFrameClassicTransform` and returns the result of transforming it.
AttributeFormsEditorBean	getAttributeFormsEditorBean() Returns the attribute forms editor bean within this report frame bean.
WebComponent	getChild(String key) Get the child instance based on the key passed as argument
FrameElement	getCurrentEditor() It returns which is the current editor to be displayied.
int	getDefaultStateLevel() Returns the default state level.
DerivedElementsEditorBean	getDerivedElementsEditor()
int	getDesignMode() Returns the view mode of the report frame bean (a value from EnumReportViewModes)
int	getDesignModeStage() Check the preferences for the name of the editor that will be displayed with this request.
DocumentBean	getDocumentBean() Returns the report bean associated with this report frame bean.
DrillEditorBean	getDrillEditorBean() Returns the drill editor bean within this report frame bean.
DrillFilterEditorBean	getDrillFilterEditorBean() Returns the drill filter editor bean within this report frame bean.
String	getDynamicMenuName() Name of the Shortcut object to use as Dynamic Menu
String	getEditorMessage() This method is used to set a message related with an Editor action.
int	getExecutionMode() Returns the view mode of the report frame bean (a value from EnumReportViewModes)
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
FilterElementBean	getFilterElement(int type)
FormulaBarBean	getFormulaBarBean() Returns the formular bar bean within this report frame bean.
GraphFormatEditorBean	getGraphFormatEditorBean() Returns the graph format editor bean within this report frame bean.
GraphFormatToolbarBean	getGraphFormatToolbarBean() Returns the graph format toolbar bean within this report frame bean.
GridFormatEditorBean	getGridFormatEditorBean() Returns the grid format editor bean within this report frame bean.
GridFormatToolbarBean	getGridFormatToolbarBean() Returns the grid format toolbar bean within this report frame bean.
Object	getIFrameComponent(String name) Returns the associated object associated with the iFrame component.
boolean	getIsDesignMode() Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to `ReportViewModeDesign`
Menu	getMenus() Returns the menus for this FrameBean based on the dynamicMenuName property.
String	getMessageBeforeData() This method is deprecated. use `getEditorMessage()`
ObjectBrowserBean	getObjectBrowserBean() This method is deprecated. This method should no longer be used. Use `getObjectBrowserTabMgrBean` instead.
ObjectBrowserManagerBean	getObjectBrowserTabMgrBean() Returns the ObjectBrowser bean associated with this report frame bean.
PageByBean	getPageByBean()
PromptDetailsBean	getPromptDetailsBean() Returns a `PromptDetailsBean` object corresponding to the prompt details.
String	getPromptStyle() Indicates actual prompt style used.
PromptsContainerBean	getPromptsContainerBean() Returns a `PromptsContainerBean` object corresponding to the prompts container.
RWBean	getRWBean() Returns the rw bean associated with this report frame bean.
boolean	getRefreshGrid() Retrieves the flag indicating whether to refresh the grid or not.
ReportBean	getReportBean() Returns the report bean associated with this report frame bean.
ReportDetailsBean	getReportDetailsBean() Returns a `ReportDetailsBean` object corresponding to the report details.
String	getReportEditorName() Retrieves the name of the current open report editor
FilterEditorBean	getReportFilterEditor() Returns the report filter editor bean within this report frame bean.
FilterElementBean	getReportFilterElement() Returns a `FilterElementBean` object corresponding to the report filter.
FilterElementBean	getReportLimitElement()
String	getReportStyleLocalizedName()
ResizeEditorBean	getResizeEditorBean() Returns the resize editor bean within this report frame bean.
SubscriptionEditorBean	getSchedulesEditorBean() Returns the Subscription editor bean to use with web Subscriptions.
SubscriptionEditorBean	getSendNowEditorBean() Returns the Subscription editor bean to use with Send Now feature.
SortEditorBean	getSortEditorBean() Returns the sort editor bean within this report frame bean.
SubscriptionEditorBean	getSubscriptionsEditorBean() Returns the Subscription editor bean to use with Narrowcast Subscriptions.
WebComponent	getTargetBean() Returns the target bean associated with this FrameBean.
boolean	getUseIFrame() Returns if the ReportFrame uses IFrames
FilterEditorBean	getViewFilterEditor() Returns the view filter editor bean within this report frame bean.
FilterElementBean	getViewFilterElement() Returns a `FilterElementBean` object corresponding to the view filter.
FilterElementBean	getViewLimitElement()
VisualizationPropertiesEditorBean	getVisualizationPropertiesEditorBean()
int	getXMLStatus() Returns the EnumRequestStatus status of the bean.
boolean	hasChanged() Verifies the state of the component has changed
boolean	isEventNeedsToCollectData()
boolean	isIframeEnabled() Determines if the instance is enabled to work on IFrame environments
boolean	isNoActionFlagRemoved()
boolean	isOpen(FrameElement element) Identifies if the given ReportFrameElement is open.
boolean	isReportToolbarEnabled() Returns true if the report toolbar should be enabled
void	openElement(FrameElement element) Mark as opened the corresponding ReportFrameElement
void	setDesignMode(int designMode) Sets the view mode of the report frame bean (a value from EnumReportViewModes)
void	setDesignModeStage(int designModeStage) Sets the design mode stage of the report frame bean
void	setDynamicMenuName(String dynamicMenuName) Set the name of the dynamic menu to be associated with this instance
void	setEditorMessage(String message) This method is used to set a message related with an Editor action.
void	setEventNeedsToCollectData(boolean needsToCollectData)
void	setExecutionMode(int executeMode) Sets the view mode of the report frame bean (a value from EnumReportViewModes)
void	setMessageBeforeData(String message) This method is deprecated. use `setEditorMessage(String)`
void	setNoActionFlagRemoved(boolean noActionFlagRemoved) Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode
void	setPromptStyle(String style) Specifies which style to use for prompt transforms.
void	setRefreshGrid(boolean value) Sets a flag indicating whether to refresh the grid or not.
void	setReportEditorName(String value) Sets the name of the report editor to be open
void	setUseIFrame(boolean value) Defines if the ReportFrame should use IFrame
void	setXMLStatus(int value) Sets the EnumRequestStatus status of the bean.
boolean	shouldDisplayContent(String name) Returns false if an iFrame component needs not to be rendered in an iFrame request.

Protected Methods
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Proceses the save/restore state opperation of the AppComponent
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isObjectBrowserOpen() Checks if the given ObjectBrowserManagerBean is open
WebEventHandler	newDefaultEventHandler()
WebComponent	searchChildByClass(Class beanClass)
void	setCookie(String key, String value) Set a cookie value as specified

[Expand]

Inherited Methods

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From class com.microstrategy.web.app.beans.AbstractAppComponent

void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	compareChildsTargetWithCurrent() The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
TransformInstance	createTransformInstance(Transform transform)
void	doCollectData() Call the required methods so the data is collected for this instance
void	doCollectMinimalData() By default this method simply invokes `doCollectData()`, i.e.
MarkupOutput	generateOutput() Generates the output of a bean.
AppContext	getAppContext() This method returns the application context object associated with this component.
String	getContactInfo() This method is deprecated. Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.
ContainerServices	getContainerServices() Convenience method to retrieve the connected Container Services object.
String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
String	getDescriptor(String key) Retrieve the descriptor when the key is a string
EventManager	getEventManager() This method returns the application EventManager used to generates events.
String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
WebObjectSource	getObjectSource()
int	getResultFilterMode()
WebIServerSession	getSession()
WebComponent	getTargetBean() Get the target bean associated with this instance
int	getTop() Get the top position where the bean should be displayed by the transform if applicable
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
static WebObjectsFactory	getWebObjectsFactory(WebBean wb) Utility method for obtaining a `WebObjectsFactory` instance
WebObjectsFactory	getWebObjectsFactory()
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	hasChanged() Verifies the state of the component has changed
boolean	hasTargetBeanChanged() When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.
boolean	haveChildrenChanged()
WebComponent	initComponent(WebComponent bean, String suffix) Initialize a WebComponent as child of this FrameBean.
void	internalCollectData() This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.
boolean	isDialog() Returns true if this bean should be treated as a dialog
boolean	isForcedChildrenStateSaving() Return wheter the bean's children will be save their states or not despite it's open or closed state.
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isModal() The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.
boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
BeanContext	newDefaultBeanContext() This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
ParameterBuilder	newHiddenInputBuilder() Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.
NamespaceEncoder	newNamespaceEncoder() Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.
StyleRequestContext	newStyleRequestContext()
ParameterBuilder	newURIBuilder() Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
void	setForcedChildrenStateSaving(boolean value) Forces the bean to propagate its children to save state despite it's open or closed state.
void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
void	setIsDialog(boolean value) Set method for defining if the instance is to be defined as a Dialog or not.
void	setIsModal(boolean value) Set method for defining if the instance is to be defined as a Modal interface or not.
void	setIsOpen(boolean value) Set the current instance as opened.
void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` for the current WebComponent.
void	setTop(int y) Set the top osition where the bean should be displayed by the transform if applicable.

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

From class java.lang.Object

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.app.beans.ReportFrameBean

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

protected static final String REPORT_FILTER_NAME

Constant Value: "rfe"

protected static final String REPORT_LIMIT_NAME

Constant Value: "rLe"

protected static final String VIEW_FILTER_NAME

Constant Value: "vfe"

protected static final String VIEW_LIMIT_NAME

Constant Value: "vle"

Fields

protected String _editor

Local property which value reflects the current editor

protected String _promptStyle

Local property which stores the actual prompt style used.

Public Methods

public void addChild (String key, WebComponent child)

Adds a child component to the current WebComponent. This call invalidates the cached states.

Parameters

key	the key mapped to the child component.
child	the child component to add.

public void addChildStateInfo (ParameterBuilder paramBldr)

Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized. Each WebComponent the hierarchy serializes its state according to its own getDefaultStateLevel().

Parameters

paramBldr	The `ParameterBuilder` instance which has child state information added to it.

public void addChildStateInfo (ParameterBuilder paramBldr, int howMuchState)

Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized. Overrides addChildStateInfo() for the smartCollectData case: When doing smartCollectData we change some settings in the Result flags or the WindowSettings of the report data to bring less information. We don't want these changes to be saved in the state of the report bean, so its state is saved before this changes and this method appends that state, instead of the current one.

Parameters

paramBldr	The `ParameterBuilder` instance which has child state information added to it.
howMuchState	How much persistable state of `EnumWebPersistableState` to return from its children.

public void closeElement (FrameElement element)

Mark as closed the corresponding ReportFrameElement

Parameters

element	the element to open

public void collectData ()

We need to over-ride the collectdata on the ReportFrame so that we can clear the promptStyle property when the report bean is successful or ends in error

Throws

WebBeanException

public void doCollectData ()

For performance, this method overrides the default collectData() by checking if the ReportBean will be displayed, and if not it will not trigger it's collectData().

public MarkupOutput generateOutput ()

This method creates a ReportFrameClassicTransform and returns the result of transforming it.

Returns

the MarkupOutput generated by the ReportFrameClassicTransform.

public AttributeFormsEditorBean getAttributeFormsEditorBean ()

Returns the attribute forms editor bean within this report frame bean.

Returns

AttributeFormsEditorBean instance associated with this bean

public WebComponent getChild (String key)

Get the child instance based on the key passed as argument

Parameters

key	String value with the name to look for

Returns

WebComponent instance corresponding to the key

public FrameElement getCurrentEditor ()

It returns which is the current editor to be displayied. Formatting editors (Grid or Graph), if current, are not considered.

Returns

the current editor,

public int getDefaultStateLevel ()

Returns the default state level. If not set, the default state level is EnumWebPersistableState.MINIMAL_STATE_INFO.

Returns

the defautl state level.

public DerivedElementsEditorBean getDerivedElementsEditor ()

public int getDesignMode ()

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

Returns

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

public int getDesignModeStage ()

Check the preferences for the name of the editor that will be displayed with this request.

Returns

the name of the editor to be displayed for this frame

public DocumentBean getDocumentBean ()

Returns the report bean associated with this report frame bean.

Returns

the report bean associated with this report frame bean

public DrillEditorBean getDrillEditorBean ()

Returns the drill editor bean within this report frame bean.

Returns

the drill editor bean within this report frame bean.

public DrillFilterEditorBean getDrillFilterEditorBean ()

Returns the drill filter editor bean within this report frame bean.

Returns

DrillFilterEditorBean instance associated with this bean

public String getDynamicMenuName ()

Name of the Shortcut object to use as Dynamic Menu

Returns

the name of the dynamic menu associated with this instance

public String getEditorMessage ()

This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.

Returns

the message to be shown.

public int getExecutionMode ()

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

Returns

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

public WebFeatures getFeaturesManager ()

Return the WebFeatures implementation associated with this WebComponent

Returns

a WebFeatures instance

public FilterElementBean getFilterElement (int type)

public FormulaBarBean getFormulaBarBean ()

Returns the formular bar bean within this report frame bean.

Returns

the formular bar bean within this report frame bean.

public GraphFormatEditorBean getGraphFormatEditorBean ()

Returns the graph format editor bean within this report frame bean.

Returns

the graph format editor within this report frame bean.

public GraphFormatToolbarBean getGraphFormatToolbarBean ()

Returns the graph format toolbar bean within this report frame bean.

Returns

the graph format toolbar within this report frame bean

public GridFormatEditorBean getGridFormatEditorBean ()

Returns the grid format editor bean within this report frame bean.

Returns

the grid format editor within this report frame bean.

public GridFormatToolbarBean getGridFormatToolbarBean ()

Returns the grid format toolbar bean within this report frame bean.

Returns

the grid format toolbar within this report frame bean.

public Object getIFrameComponent (String name)

Returns the associated object associated with the iFrame component. An iFrame component is any part of the interface that can be refreshed independently when using iFrames, for example a Bean, the current editor, the menus or the editor's message.

Parameters

name	String with the name of the iframe component to look for

Returns

the corresponding iFrame component for the given name

public boolean getIsDesignMode ()

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

Returns

boolean true if the the report frame bean is in design mode TQMS 249689, add this method to interface ReportFrameBean

public Menu getMenus ()

Returns the menus for this FrameBean based on the dynamicMenuName property.

Returns

Menu instance associated with this bean

public String getMessageBeforeData ()

This method is deprecated.
use getEditorMessage()

Returns

editor message

public ObjectBrowserBean getObjectBrowserBean ()

This method is deprecated.
This method should no longer be used. Use getObjectBrowserTabMgrBean instead.

Returns the ObjectBrowser bean associated with this report frame bean.

Returns

the DynamicMenu bean associated with this report frame bean

public ObjectBrowserManagerBean getObjectBrowserTabMgrBean ()

Returns the ObjectBrowser bean associated with this report frame bean. The Object Browser is now a TabManager bean.

Returns

TabManagerBean

public PageByBean getPageByBean ()

Returns

PageByBean instance associated with this bean

public PromptDetailsBean getPromptDetailsBean ()

Returns a PromptDetailsBean object corresponding to the prompt details.

Returns

A PromptDetailsBean corresponding to the prompt details.

public String getPromptStyle ()

Indicates actual prompt style used.

Returns

String name of prompt style.

public PromptsContainerBean getPromptsContainerBean ()

Returns a PromptsContainerBean object corresponding to the prompts container.

Returns

A PromptsContainerBean corresponding to the prompts Container.

public RWBean getRWBean ()

Returns the rw bean associated with this report frame bean.

Returns

the rw bean associated with this report frame bean

public boolean getRefreshGrid ()

Retrieves the flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.

public ReportBean getReportBean ()

Returns the report bean associated with this report frame bean.

Returns

the report bean associated with this report frame bean

public ReportDetailsBean getReportDetailsBean ()

Returns a ReportDetailsBean object corresponding to the report details.

Returns

A ReportDetailsBean corresponding to the report details.

public String getReportEditorName ()

Retrieves the name of the current open report editor

Returns

The name of the current open report editor

public FilterEditorBean getReportFilterEditor ()

Returns the report filter editor bean within this report frame bean.

Returns

the report filter editor bean within this report frame bean.

public FilterElementBean getReportFilterElement ()

Returns a FilterElementBean object corresponding to the report filter.

Returns

A FilterElementBean corresponding to the report filter.

public FilterElementBean getReportLimitElement ()

public String getReportStyleLocalizedName ()

Returns

the report bean's localized style name. It's used for old-formatting reports to apply style first before other formattig manipulation. For new-formatting reports, it returns "".

public ResizeEditorBean getResizeEditorBean ()

Returns the resize editor bean within this report frame bean.

Returns

ResizeEditorBean instance associated with this bean

public SubscriptionEditorBean getSchedulesEditorBean ()

Returns the Subscription editor bean to use with web Subscriptions.

Returns

SubscriptionEditorBean instance associated with this bean

public SubscriptionEditorBean getSendNowEditorBean ()

Returns the Subscription editor bean to use with Send Now feature.

Returns

SubscriptionEditorBean instance associated with this bean

public SortEditorBean getSortEditorBean ()

Returns the sort editor bean within this report frame bean.

Returns

SortEditorBean instance associated with this bean

public SubscriptionEditorBean getSubscriptionsEditorBean ()

Returns the Subscription editor bean to use with Narrowcast Subscriptions.

Returns

SubscriptionEditorBean instance associated with this bean

public WebComponent getTargetBean ()

Returns the target bean associated with this FrameBean. The target bean is the one with the main data.

Returns

the target bean for this Frame.

public boolean getUseIFrame ()

Returns if the ReportFrame uses IFrames

Returns

true if frames are used.

public FilterEditorBean getViewFilterEditor ()

Returns the view filter editor bean within this report frame bean.

Returns

the view filter editor bean within this report frame bean.

public FilterElementBean getViewFilterElement ()

Returns a FilterElementBean object corresponding to the view filter.

Returns

A FilterElementBean corresponding to the view filter.

public FilterElementBean getViewLimitElement ()

public VisualizationPropertiesEditorBean getVisualizationPropertiesEditorBean ()

public int getXMLStatus ()

Returns the EnumRequestStatus status of the bean. By default the status of this bean is EnumRequestStatus.WebBeanRequestSuccessful.

Returns

the EnumRequestStatus of the component.

public boolean hasChanged ()

Verifies the state of the component has changed

Returns

boolean value indicating if the current instance has changed.

public boolean isEventNeedsToCollectData ()

Returns

Returns the _eventNeedsToCollectData.

public boolean isIframeEnabled ()

Determines if the instance is enabled to work on IFrame environments

Returns

boolean value indicating whether IFrame is enabled for this component

public boolean isNoActionFlagRemoved ()

public boolean isOpen (FrameElement element)

Identifies if the given ReportFrameElement is open. To identify whether a FrameElement is open, The ReportFrameBean checks the following:

In design mode:
1. the object-browser and page-by section are always opened.
2. the view and report filters are opened only when editing the filter.
3. all other elements are closed.
In View mode:
1. The object browser depends on the WebBrowserSettingObjBrowserView browser setting
2. The page-by depends on the WebBrowserSettingPageBySection browser setting
3. The grid and graph toolbar depends on a browser setting whose name is this ReportFrameBean name + "_" + WebBrowserSettingFormatToolbar i.e.:
  key = getName() + "_" + element.getName();
4. Other elements depends on a browser setting whose is this ReportFrameBean name + "_" + the element's name, i.e.:
  key = getName() + "_" + element.getName();

Parameters

element	`FrameElement` instance to check if it's opened or not

Returns

true if the element is open.

public boolean isReportToolbarEnabled ()

Returns true if the report toolbar should be enabled

Returns

isReportToolbarEnabled

public void openElement (FrameElement element)

Mark as opened the corresponding ReportFrameElement

Parameters

element	the element to open

public void setDesignMode (int designMode)

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

Parameters

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

public void setDesignModeStage (int designModeStage)

Sets the design mode stage of the report frame bean

Parameters

designModeStage	the design mode stage of the report frame bean (a value from EnumReportDesignMode)

public void setDynamicMenuName (String dynamicMenuName)

Set the name of the dynamic menu to be associated with this instance

Parameters

dynamicMenuName	`String` with the name of the dynamic menu to be associated with this bean

public void setEditorMessage (String message)

This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.

Parameters

message	the message to be shown.

public void setEventNeedsToCollectData (boolean needsToCollectData)

Parameters

needsToCollectData	The _eventNeedsToCollectData to set.

public void setExecutionMode (int executeMode)

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

Parameters

executeMode	the view mode of the report frame bean (a value from EnumReportViewModes)

public void setMessageBeforeData (String message)

This method is deprecated.
use setEditorMessage(String)

Parameters

message	String

public void setNoActionFlagRemoved (boolean noActionFlagRemoved)

Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode

Parameters

noActionFlagRemoved	boolean true indicates we just remove the noAction flag from the executionFlags when switch a report from design mode to view mode

public void setPromptStyle (String style)

Specifies which style to use for prompt transforms.
This property indicates what prompt style to use when transforming a prompted Bean.

Parameters

style	String

public void setRefreshGrid (boolean value)

Sets a flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.

public void setReportEditorName (String value)

Sets the name of the report editor to be open

Parameters

value	The name of the report editor to be open

public void setUseIFrame (boolean value)

Defines if the ReportFrame should use IFrame

Parameters

value	if true, the ReportFrame will use IFrames

public void setXMLStatus (int value)

Sets the EnumRequestStatus status of the bean.

Parameters

value	The XML status value ofor this bean.

public boolean shouldDisplayContent (String name)

Returns false if an iFrame component needs not to be rendered in an iFrame request.

Parameters

name	the component to render

Returns

false if the component should not be rendered, true otherwise.

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters

serializer	an instance of the `FlatStateSerializer` object to use
howMuchState	defines how much information needs to be saved
tokenizer	an instance of the `FlatStateTokenizer` object to use

protected boolean isIFrameRequest ()

Utility method that determines if it's an IFrame type of request.

Returns

boolean value indicating if the request is of type IFrame or not. By default it is based only on information available on the RequestKeys associated with this instance.

protected boolean isObjectBrowserOpen ()

Checks if the given ObjectBrowserManagerBean is open

Returns

true if the element is open.

protected WebEventHandler newDefaultEventHandler ()

protected WebComponent searchChildByClass (Class beanClass)

protected void setCookie (String key, String value)

Set a cookie value as specified

Parameters

key	name of the cookie to modify
value	`String` with the value to assign to the specified cookie key

Interfaces

Classes

Exceptions

ReportFrameBeanImpl

Class Overview

Summary

Constants

protected static final String REPORT_FILTER_NAME

protected static final String REPORT_LIMIT_NAME

protected static final String VIEW_FILTER_NAME

protected static final String VIEW_LIMIT_NAME

Fields

protected String _editor

protected String _promptStyle

Public Methods

public void addChild (String key, WebComponent child)

Parameters

public void addChildStateInfo (ParameterBuilder paramBldr)

Parameters

public void addChildStateInfo (ParameterBuilder paramBldr, int howMuchState)

Parameters

public void closeElement (FrameElement element)

Parameters

See Also

public void collectData ()

Throws

public void doCollectData ()

public MarkupOutput generateOutput ()

Returns

public AttributeFormsEditorBean getAttributeFormsEditorBean ()

Returns

public WebComponent getChild (String key)

Parameters

Returns

public FrameElement getCurrentEditor ()

Returns

public int getDefaultStateLevel ()

Returns

public DerivedElementsEditorBean getDerivedElementsEditor ()

public int getDesignMode ()

Returns

public int getDesignModeStage ()

Returns

public DocumentBean getDocumentBean ()

Returns

public DrillEditorBean getDrillEditorBean ()

Returns

public DrillFilterEditorBean getDrillFilterEditorBean ()

Returns

public String getDynamicMenuName ()

Returns

public String getEditorMessage ()

Returns

public int getExecutionMode ()

Returns

public WebFeatures getFeaturesManager ()

Returns

public FilterElementBean getFilterElement (int type)

public FormulaBarBean getFormulaBarBean ()

Returns

public GraphFormatEditorBean getGraphFormatEditorBean ()

Returns

public GraphFormatToolbarBean getGraphFormatToolbarBean ()

Returns

public GridFormatEditorBean getGridFormatEditorBean ()

Returns

public GridFormatToolbarBean getGridFormatToolbarBean ()

Returns

public Object getIFrameComponent (String name)

Parameters

Returns

public boolean getIsDesignMode ()

Returns

public Menu getMenus ()

Returns

public String getMessageBeforeData ()

Returns

public ObjectBrowserBean getObjectBrowserBean ()

Returns

public ObjectBrowserManagerBean getObjectBrowserTabMgrBean ()