public abstract class

AbstractFrameEditorBean

extends AbstractPersistableFrameElement
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
               ↳ com.microstrategy.web.app.beans.AbstractFrameEditorBean
Known Direct Subclasses

Class Overview

Represents the abstract class of a ReportEditor. All new ReportEditors should extend this class and override the initEditor and getEditorContent methods.
They should also implement the isEnabled() method.

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
AbstractFrameEditorBean()
Public Methods
MarkupOutput generateOutput()
Overrides generateOutput by generating the editor HTML
abstract String getTitle()
Abstract method that gets the title of this editor
boolean isEditor()
Overrides isEditor by returning always true.
abstract void renderEditorContent(MarkupOutput contents)
Abstract method that renders the content of an editor.
Protected Methods
void initEditor(Editor editor)
Initialize the editor with the global settings.
void renderFormEnd(MarkupOutput out)
Render the end of a Form HTML tag
void renderFormStart(MarkupOutput out)
Render the start of a Form HTML tag
void setHelpEventInformation(Editor editor)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
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 AbstractFrameEditorBean ()

Public Methods

public MarkupOutput generateOutput ()

Overrides generateOutput by generating the editor HTML

Returns
  • a MarkupOutput object with the content of the editor.

public abstract String getTitle ()

Abstract method that gets the title of this editor

Returns
  • the title of the editor

public boolean isEditor ()

Overrides isEditor by returning always true. By definition all classes extending this objects are editors.

Returns
  • true

public abstract void renderEditorContent (MarkupOutput contents)

Abstract method that renders the content of an editor.

Parameters
contents MarkupOutput instance where to save the editor contents to render to the user

Protected Methods

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

Parameters
editor Editor instance to initialize

protected void renderFormEnd (MarkupOutput out)

Render the end of a Form HTML tag

Parameters
out MarkupOutput instance where to save the HTML to render to the user

protected void renderFormStart (MarkupOutput out)

Render the start of a Form HTML tag

Parameters
out MarkupOutput instance where to save the HTML to render to the user

protected void setHelpEventInformation (Editor editor)