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

public interface

FrameBean

implements AppComponent RequestPersistable

com.microstrategy.web.app.beans.FrameBean

Known Indirect Subclasses

DocumentFrameBean, FilterFrameBean, RWFrameBean, ReportFrameBean, ReportFrameBeanImpl

Class Overview

The interface FrameBean is representing the frame web component, that might contain any data bean and its editors, such as a Report or a Document bean.
A frame usually consists of a Menu, the data and an editor, the FrameBean provides methods to access these elements.
A FrameBean is generally used within a page that supports iFrame updates. In this case when the page needs to be refreshed, only the components that changed are sent to the iFrame which then updates the main page, this improves both performance and usability. The FrameBean provides methods for this functionality.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

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

Public Methods
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.

[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.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.

Public Methods

public abstract void closeElement (FrameElement element)

Mark as closed the corresponding FrameElement

Parameters

element	the element to close

public abstract 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 abstract String getDynamicMenuName ()

Name of the Shortcut object to use as Dynamic Menu

Returns

the DynamicMenu name

public abstract 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 abstract 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	the component's unique key

Returns

the object associated with the key. Null if no component is defined for that key.

public abstract Menu getMenus ()

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

Returns

a Menu object for this FrameBean.

public abstract String getMessageBeforeData ()

This method is deprecated.
use getEditorMessage()

public abstract String getPromptStyle ()

Indicates actual prompt style used.

Returns

String name of prompt style.

public abstract 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 abstract boolean getUseIFrame ()

Returns if the ReportFrame uses IFrames

Returns

true if frames are used.

public abstract boolean isOpen (FrameElement element)

Checks if the given FrameElement is open

Parameters

element	Element to check

Returns

true if the element is open.

public abstract void openElement (FrameElement element)

Mark as opened the corresponding FrameElement

Parameters

element	the element to open

public abstract void setDynamicMenuName (String dynamicMenuName)

Name of the Shortcut object to use as DynamicMenu

Parameters

dynamicMenuName	the name ot use

public abstract 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 abstract void setMessageBeforeData (String message)

This method is deprecated.
use setEditorMessage(String)

public abstract 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 abstract void setUseIFrame (boolean value)

Defines if the ReportFrame should use IFrame

Parameters

value	if true, the ReportFrame will use IFrames

public abstract 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.

Interfaces

Classes

Exceptions

FrameBean

Class Overview

Summary

Public Methods

public abstract void closeElement (FrameElement element)

Parameters

public abstract FrameElement getCurrentEditor ()

Returns

public abstract String getDynamicMenuName ()

Returns

public abstract String getEditorMessage ()

Returns

public abstract Object getIFrameComponent (String name)

Parameters

Returns

public abstract Menu getMenus ()

Returns

public abstract String getMessageBeforeData ()

public abstract String getPromptStyle ()

Returns

public abstract WebComponent getTargetBean ()

Returns

public abstract boolean getUseIFrame ()

Returns

public abstract boolean isOpen (FrameElement element)

Parameters

Returns

public abstract void openElement (FrameElement element)

Parameters

public abstract void setDynamicMenuName (String dynamicMenuName)

Parameters

public abstract void setEditorMessage (String message)

Parameters

public abstract void setMessageBeforeData (String message)

public abstract void setPromptStyle (String style)

Parameters

public abstract void setUseIFrame (boolean value)

Parameters

public abstract boolean shouldDisplayContent (String name)

Parameters

Returns