public interface

FrameBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.FrameBean
Known Indirect Subclasses

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
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

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.