public interface

FrameElement

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

Class Overview

The interface FrameElement is representing the subcomponents inside a FrameBean.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract FrameBean getFrameBean()
Returns the frame bean that is containing this FrameElement.
abstract WebComponent getTargetBean()
Get the target bean associated with this instance
abstract String getTargetBeanPath()
abstract boolean getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean isEditor()
Indicates whether a ReportFrameElement most be considered editor.
abstract boolean isEnabled()
Indicates whether a ReportFrameElement is Enabled.
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 setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output
[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 FrameBean getFrameBean ()

Returns the frame bean that is containing this FrameElement.

Returns
  • the frame bean that is containing this FrameElement.

public abstract WebComponent getTargetBean ()

Get the target bean associated with this instance

Returns

public abstract String getTargetBeanPath ()

public abstract boolean getUseIFrame ()

Indicates whether a ReportFrameElement uses IFrames in its output

Returns
  • true if it uses IFrames

public abstract boolean isEditor ()

Indicates whether a ReportFrameElement most be considered editor. Editors are treated specially by the ReportFrame: only one editor can be shown at any time.

Returns
  • true if the bean is an editor

public abstract boolean isEnabled ()

Indicates whether a ReportFrameElement is Enabled. Each bean checks its own features and other settings to determine whether it is enabled or not.

Returns
  • true if the bean is enabled and ready to be rendered.

public abstract void setTargetBean (WebComponent bean)

Set the target bean that will be associated with this instance.

Parameters
bean WebComponent instance to be associated with this bean.

public abstract void setTargetBeanPath (String beanName)

Define the base bean for this instance.

Parameters
beanName String with the name of the bean (with path information if necessary) to be set as the base bean for this instance.

public abstract void setUseIFrame (boolean value)

Sets whether a ReportFrameElement should use IFrames in its output

Parameters
value true if IFrrames are enabled