public abstract class

AbstractPersistableFrameElement

extends AbstractPersistableAppComponent
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.AbstractPersistableFrameElement
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class is the abstract realization of the FrameElement. Implements most of the methods except the isEnabled(), which needs to be implemented by every concrete class.
Notice that in general the FrameElement doesn't implement Persistable, although this class does since most of the FrameElements requires it. Also notice that this class DOES NOT implement the FrameElement interface. This is on purpose. The reason being this class is extended by concrete classes that doesn't necessary extend the FrameElement (in particular, this class is extended by the AbstractEditorBean). The FrameElement will be deprecated in favor of the EditorBean interface. In this scenario all classes will inherit the methods (even if they don't use it), true, but if their interface doesn't extend the FrameElement, the methods will not be publicly available so no harm is done.

Summary

[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
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
AbstractPersistableFrameElement()
Public Methods
void doCollectData()
Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.
DocumentFrameBean getDocumentFrameBean()
Returns the DocumentFrameBean associated with this report frame element.
WebFeatures getFeaturesManager()
Overrides getFeaturesManager by providing a new Features implementation for FrameElements.
FrameBean getFrameBean()
Utility method for returning the FrameBean associated with this instance
RWFrameBean getRWFrameBean()
Returns the RWFrameBean associated with this report frame element.
ReportFrameBean getReportFrameBean()
Returns the ReportFrameBean associated with this report frame element.
boolean getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its output
boolean isEditor()
Indicates whether a ReportFrameElement most be considered editor.
boolean isGridDataNecessary()
This method indicates the report frame that the element requires the grid for information.
boolean isIFrameEnabled()
boolean isOpen()
Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status.
void setIsOpen(boolean value)
Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status.
void setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
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 Constructors

public AbstractPersistableFrameElement ()

Public Methods

public void doCollectData ()

Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.

public DocumentFrameBean getDocumentFrameBean ()

Returns the DocumentFrameBean associated with this report frame element.

Returns
  • the document frame bean associated with this report frame element.

public WebFeatures getFeaturesManager ()

Overrides getFeaturesManager by providing a new Features implementation for FrameElements.

Returns
  • a FrameElementsFeatures if the concrete bean implements FrameElement, otherwise the default FeaturesManager.

public FrameBean getFrameBean ()

Utility method for returning the FrameBean associated with this instance

Returns

public RWFrameBean getRWFrameBean ()

Returns the RWFrameBean associated with this report frame element.

Returns
  • the RW Frame bean associated with this report frame element.

public ReportFrameBean getReportFrameBean ()

Returns the ReportFrameBean associated with this report frame element.

Returns
  • the report frame bean associated with this report frame element.

public boolean getUseIFrame ()

Indicates whether a ReportFrameElement uses IFrames in its output

Returns
  • true if it uses IFrames

public 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
  • false, editors needs to override this method.

public boolean isGridDataNecessary ()

This method indicates the report frame that the element requires the grid for information. Editors that requires to grid data for their input should override this method, since by default it returns false. This method is implemented for the ReportFrameElement interface.

Returns
  • false.

public boolean isIFrameEnabled ()

Returns
  • True if IFrame is enabled for this instance.

public boolean isOpen ()

Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status. If the bean is a FrameElement and has a FrameBean as a parent, then it will ask the FrameBean if it's open, otherwise it would use the default isOpen implementation.

Returns
  • boolean true if open

public void setIsOpen (boolean value)

Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status. If the bean is a FrameElement and has a FrameBean as a parent, then it will ask the FrameBean to open or close it accordingly, otherwise it would use the default setIsOpen implementation.

Parameters
value boolean value indicating if the instance should be defined as opened (True) or closed (False).

public void setUseIFrame (boolean value)

Sets whether a ReportFrameElement should use IFrames in its output

Parameters
value true if IFrrames are enabled