public class

ReportFrameClassicTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ReportFrameClassicTransform

This class is deprecated.
Please use ReportFrameGenericTransform instead

Class Overview

The ReportFrameClassicTransform renders the output of a ReportFrameBean.

The ReportFrameBean is used in the report page as a container of the different elements that constitute this page. It manages the interaction between the beans and controls who is open or not. The ReportFrameClassicTransform controls the layout of these beans within the page.

Through the style catalog users may control which sections can be displayed. This is accomplished using the levelFlag formal parameter. This takes a bitwise value combining constants such as:

Users can then hide a section by turning off the corresponding bit of this flagged value.

The ReportFrameClassicTransform delegates to its children their own HTML generation. The style to use for a child is selected in two ways:

  1. If this Transform provides a specific Formal Parameter for it, it will simply use that value.
  2. Otherwise, it uses the default bean's style, this usually defined as the first style assigned to the bean in the pageConfig.xml.
For example, this Transform defines several formal parameters for the ReportBean:
  1. reportGridStyle
  2. reportDesignModeStyle
  3. etc..
depending on the situation, it will use the corresponding style.

For the PageByBean, however, this Transform defines no Formal Parameter, therefore it uses its default style. Suppose the bean is defined in the pageConfig.xml as follows:

 <web-bean name="pbb" persist-mode="2" sys-bean="PageByBean">
   <styles>
     <style name="PageByStyle"/>
     <style name="GroupByStyle"/>
   </styles>
 </web-bean>
 
Then, it's default style is "PageByStyle"

Summary

Constants
String FP_GRAPH_DESIGN_MODE_STYLE name for the formal parameter "graphDesignModeStyle".
String FP_LEVEL_FLAG Constant specifying the name of the formal parameter for defining the level flag.
String FP_MDX_FILTER_STYLE
String FP_PROMPTS_CREATE_STYLE name for the formal parameter "promptsCreateStyle".
String FP_PROMPTS_EDIT_STYLE name for the formal parameter "promptsEditStyle".
String FP_PROMPTS_EXECUTE_STYLE name for the formal parameter "promptsExecuteStyle".
String FP_PROMPTS_SAVING_STYLE name for the formal parameter "promptsSavingStyle".
String FP_REPORT_DESIGN_MODE_STYLE name for the formal parameter "reportDesignModeStyle".
String FP_REPORT_FILTER_STYLE name for the formal parameter "reportFilterStyle".
String FP_REPORT_GRAPH_STYLE name for the formal parameter "reportGraphStyle".
String FP_REPORT_GRID_GRAPH_STYLE name for the formal parameter "reportGridGraphStyle".
String FP_REPORT_GRID_STYLE name for the formal parameter "reportGridStyle".
String FP_REPORT_OUTLINE_MODE_STYLE name for the formal parameter "reportOutlineModeStyle".
String FP_REPORT_PAGE_BY_STYLE name for the formal parameter "reportPageByStyle".
String FP_REPORT_TOOLBAR_STYLE name for the formal parameter "reportToolbarStyle".
String FP_VIEW_FILTER_STYLE name for the formal parameter "viewFilterStyle".
String FP_VIEW_LIMIT_STYLE name for the formal parameter "viewLimitStyle".
int LEVEL_ALL Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_DATA Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_DESIGN_MODE_BUTTONS Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_EDITOR_MESSAGE Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_FORMAT_EDITOR Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_GRAPH_TOOLBAR Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_GRID_EDITOR Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_GRID_TOOLBAR Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_MENUS Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_OBJECT_BROWSER Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_PAGE_BY Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_PROMPT_DETAILS Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_REPORT_ERROR Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_REPORT_FILTER Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_REPORT_LAST_UPDATE Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_REPORT_TOOLBAR Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_VIEW_FILTER Allowed value for the levelFlag formal parameter.
int LEVEL_DISPLAY_VIEW_LIMIT Allowed value for the levelFlag formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter graphDesignModeStyle This is the name of the style to use when rendering the graph in design mode.
public FormalParameter levelFlag Indicates the level of information to use when displaying sections of the ReportFrame.
protected FormalParameter mdxFilterStyle
protected FormalParameter promptsCreateStyle This is the name of the style to use to transform a prompted grid when creating new reports.
protected FormalParameter promptsEditStyle This is the name of the style to use to transform a prompted grid when editing reports.
protected FormalParameter promptsExecuteStyle This is the name of the style to use to transform a prompted grid when normal report execution.
protected FormalParameter promptsSavingStyle This is the name of the style to use to transform a prompted grid when trying to save edited or created report which have prompts to be resolved before saving.
protected FormalParameter reportDesignModeStyle This is the name of the style to use when rendering the report in design mode.
protected FormalParameter reportFilterStyle This is the name of the style to use to transform the report filter for normal report execution.
protected FormalParameter reportGraphStyle This is the name of the style to use when rendering the report in graph mode.
protected FormalParameter reportGridGraphStyle This is the name of the style to use when rendering the report in grid/graph mode.
protected FormalParameter reportGridStyle This is the name of the style to use when rendering the report in grid mode.
protected FormalParameter reportOutlineModeStyle This is the name of the style to use when rendering the report in outline grid mode.
protected FormalParameter reportPageByStyle This field is deprecated. This formal parameter is not referenced anywhere in the code
protected FormalParameter reportToolbarStyle This is the name of the style to use when rendering the Report toolbar component.
protected FormalParameter viewFilterStyle This is the name of the style to use to transform the view filter for normal report execution.
protected FormalParameter viewLimitStyle This is the name of the style to use to transform the view limit on normal report execution.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportFrameClassicTransform()
default no-args constructor.
Public Methods
void generateDesignMode(MarkupOutput out)
Function that generate output for Design mode.
void generateExecuteMode(MarkupOutput out)
Function that generate output for execute mode.
void generateSimpleMode(MarkupOutput out)
Function that generate output for simple mode - report in error or cancelled status.
String getDescription()
The description of this transform.
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isInVisualizationMode()
boolean isUrlVisualization()
void renderCurrentEditor(MarkupOutput out)
render the current editor for the report.
void renderDNDScripts(MarkupOutput out)
This method is deprecated. No replacement.
void renderDesignModeProcessForm(MarkupOutput out)
Render the process form in design mode.
void renderFormatEditors(MarkupOutput out)
Renders the Report Formatting Editors.
void renderMenus(MarkupOutput out)
render the menus on the top of report frame.
void renderReportArea(MarkupOutput out)
render report area in execute mode.
void renderReportData(MarkupOutput out)
render the report data area.
void renderReportElements(MarkupOutput out)
render the report frame elements in execute mode.
void renderReportFormEnd(MarkupOutput out)
render the FORM close tag for report area.
void renderReportFormStart(MarkupOutput out)
render the FORM start tag for report area.
void renderReportToolbar(MarkupOutput out)
render the report toolbar.
void renderTemplateEditor(MarkupOutput out)
render the template editor in design mode.
void transformForRequestCanceled(MarkupOutput out)
Transform when the status is Canceled.
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
void transformForRequestNotInited(MarkupOutput out)
Transform when the status is Not initialized.
void transformForRequestProcessing(MarkupOutput out)
Transform when the status is Processing.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is Successful.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Method that generates the output when the bean is WaitingForUserInput.
Protected Methods
void displayComponent(MarkupOutput out, String name, WebComponent bean)
Renders a FrameElement as an iFrame component.
void displayComponent(MarkupOutput out, String name, String value, boolean copyContents)
Display a string as an iFrame component.
void displayComponent(MarkupOutput out, String name, GuiElement component)
Renders a GUI element.
void displayComponent(MarkupOutput out, String name, MarkupOutput value)
Display a string as an iFrame component.
void displayComponent(MarkupOutput out, String name, MarkupOutput value, boolean copyContents)
Display a string as an iFrame component.
void displayComponent(MarkupOutput out, String name, String value)
Display a string as an iFrame component.
void displayComponent(MarkupOutput out, String name, WebComponent bean, String styleName)
Renders a WebComponent with the corresponding style as an iFrame component.
void displayComponent(MarkupOutput out, String name, FrameElement bean)
Renders a FrameElement as an iFrame component.
void displayFrameComponent(MarkupOutput out, String name, FrameElement bean, String styleName)
WebEvent getDesignModeEvent()
Returns the event used in the ReportFrame's design mode.
TransformInstance getPromptsTransform(ReportBean rb)
String getReportStyleName()
This method returns the name of a style from the style-catalog used to render the ReportBean.
boolean isEditingFilter(int filterType)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_GRAPH_DESIGN_MODE_STYLE

name for the formal parameter "graphDesignModeStyle".

Constant Value: "graphDesignModeStyle"

public static final String FP_LEVEL_FLAG

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant Value: "levelFlag"

public static final String FP_MDX_FILTER_STYLE

Constant Value: "mdxFilterStyle"

public static final String FP_PROMPTS_CREATE_STYLE

name for the formal parameter "promptsCreateStyle".

Constant Value: "promptsCreateStyle"

public static final String FP_PROMPTS_EDIT_STYLE

name for the formal parameter "promptsEditStyle".

Constant Value: "promptsEditStyle"

public static final String FP_PROMPTS_EXECUTE_STYLE

name for the formal parameter "promptsExecuteStyle".

Constant Value: "promptsExecuteStyle"

public static final String FP_PROMPTS_SAVING_STYLE

name for the formal parameter "promptsSavingStyle".

Constant Value: "promptsSavingStyle"

public static final String FP_REPORT_DESIGN_MODE_STYLE

name for the formal parameter "reportDesignModeStyle".

Constant Value: "reportDesignModeStyle"

public static final String FP_REPORT_FILTER_STYLE

name for the formal parameter "reportFilterStyle".

Constant Value: "reportFilterStyle"

public static final String FP_REPORT_GRAPH_STYLE

name for the formal parameter "reportGraphStyle".

Constant Value: "reportGraphStyle"

public static final String FP_REPORT_GRID_GRAPH_STYLE

name for the formal parameter "reportGridGraphStyle".

Constant Value: "reportGridGraphStyle"

public static final String FP_REPORT_GRID_STYLE

name for the formal parameter "reportGridStyle".

Constant Value: "reportGridStyle"

public static final String FP_REPORT_OUTLINE_MODE_STYLE

name for the formal parameter "reportOutlineModeStyle".

Constant Value: "reportOutlineModeStyle"

public static final String FP_REPORT_PAGE_BY_STYLE

name for the formal parameter "reportPageByStyle".

Constant Value: "reportPageByStyle"

public static final String FP_REPORT_TOOLBAR_STYLE

name for the formal parameter "reportToolbarStyle".

Constant Value: "reportToolbarStyle"

public static final String FP_VIEW_FILTER_STYLE

name for the formal parameter "viewFilterStyle".

Constant Value: "viewFilterStyle"

public static final String FP_VIEW_LIMIT_STYLE

name for the formal parameter "viewLimitStyle".

Constant Value: "viewLimitStyle"

public static final int LEVEL_ALL

Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.
Value = 16777215

Constant Value: -1 (0xffffffff)

public static final int LEVEL_DISPLAY_DATA

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report data. Value = 2

Constant Value: 2 (0x00000002)

public static final int LEVEL_DISPLAY_DESIGN_MODE_BUTTONS

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the execution bar in design mode.. Value = 8192

Constant Value: 8192 (0x00002000)

public static final int LEVEL_DISPLAY_EDITOR_MESSAGE

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the message associated with an editor before the report's data. Value = 16384

Constant Value: 16384 (0x00004000)

public static final int LEVEL_DISPLAY_FORMAT_EDITOR

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report's formatting editor (depending on the view mode). Value = 2048

Constant Value: 2048 (0x00000800)

public static final int LEVEL_DISPLAY_GRAPH_TOOLBAR

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the graph's formatting toolbar. Value = 256

Constant Value: 256 (0x00000100)

public static final int LEVEL_DISPLAY_GRID_EDITOR

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the current grid's editor (i.e. sorts, drilling, scheduling, etc). Value = 4096

Constant Value: 4096 (0x00001000)

public static final int LEVEL_DISPLAY_GRID_TOOLBAR

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the grid's formatting toolbar. Value = 128

Constant Value: 128 (0x00000080)

public static final int LEVEL_DISPLAY_MENUS

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the menus content. If the frame has no associated menus, then this flag has no effect on the final result. Value = 1

Constant Value: 1 (0x00000001)

public static final int LEVEL_DISPLAY_OBJECT_BROWSER

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report's object browser. Value = 1024

Constant Value: 1024 (0x00000400)

public static final int LEVEL_DISPLAY_PAGE_BY

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report's page-by section on top of the report's data. Value = 512

Constant Value: 512 (0x00000200)

public static final int LEVEL_DISPLAY_PROMPT_DETAILS

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the message associated with an editor before the report's data. Value = 32768

Constant Value: 32768 (0x00008000)

public static final int LEVEL_DISPLAY_REPORT_ERROR

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the section including the report's error message. If the frame has no error, then this flag has no effect on the final result. Value = 16

Constant Value: 16 (0x00000010)

public static final int LEVEL_DISPLAY_REPORT_FILTER

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report's filter. Value = 32

Constant Value: 32 (0x00000020)

public static final int LEVEL_DISPLAY_REPORT_LAST_UPDATE

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report's last update section besides the menus. Value = 4

Constant Value: 4 (0x00000004)

public static final int LEVEL_DISPLAY_REPORT_TOOLBAR

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the report's toolbar (it includes the list of autostyles). Value = 8

Constant Value: 8 (0x00000008)

public static final int LEVEL_DISPLAY_VIEW_FILTER

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the view's filter. Value = 64

Constant Value: 64 (0x00000040)

public static final int LEVEL_DISPLAY_VIEW_LIMIT

Allowed value for the levelFlag formal parameter. Specifies that the report frame transform will display the view limit. Value = 65536

Constant Value: 65536 (0x00010000)

Fields

protected FormalParameter graphDesignModeStyle

This is the name of the style to use when rendering the graph in design mode.
Allowed Values: any report style name from StyelCatalog.xml file.

public FormalParameter levelFlag

Indicates the level of information to use when displaying sections of the ReportFrame.
The sections include menus, toolbars, editors and data. Multiple sections might be rendered at the same time. For indicating which sections to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_DISPLAY_MENUS, LEVEL_DISPLAY_DATA, LEVEL_DISPLAY_OBJECT_BROWSER.
Notice that even if the Flag is ON for a particular section, that doesn't guarantees that section is rendered. It just indicates that when necessary it must be included. Logic inside the ReportFrame might prevent a section to be rendered. For example, if the LEVEL_DISPLAY_GRID_EDITOR is ON, but the ReportFrame has no editor currently selected, nothing will be rendered. Similarly if the LEVEL_DISPLAY_GRID_TOOLBAR but the current data view is Graph, or the Toolbar has been turned off through menus, the Toolbar will not be rendered.
On the other side, if the Flag is set to off, that sections will not be included regardles of other factors. Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is LEVEL_ALL

protected FormalParameter mdxFilterStyle

protected FormalParameter promptsCreateStyle

This is the name of the style to use to transform a prompted grid when creating new reports.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter promptsEditStyle

This is the name of the style to use to transform a prompted grid when editing reports.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter promptsExecuteStyle

This is the name of the style to use to transform a prompted grid when normal report execution.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter promptsSavingStyle

This is the name of the style to use to transform a prompted grid when trying to save edited or created report which have prompts to be resolved before saving.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportDesignModeStyle

This is the name of the style to use when rendering the report in design mode.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportFilterStyle

This is the name of the style to use to transform the report filter for normal report execution.
Allowed Values: any filter style name from StyleCatalog.xml file.

protected FormalParameter reportGraphStyle

This is the name of the style to use when rendering the report in graph mode.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportGridGraphStyle

This is the name of the style to use when rendering the report in grid/graph mode.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportGridStyle

This is the name of the style to use when rendering the report in grid mode.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportOutlineModeStyle

This is the name of the style to use when rendering the report in outline grid mode.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportPageByStyle

This field is deprecated.
This formal parameter is not referenced anywhere in the code

This is the name of the style to use when rendering the PageBy component.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter reportToolbarStyle

This is the name of the style to use when rendering the Report toolbar component.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter viewFilterStyle

This is the name of the style to use to transform the view filter for normal report execution.
Allowed Values: any view filter style name from StyleCatalog.xml file.

protected FormalParameter viewLimitStyle

This is the name of the style to use to transform the view limit on normal report execution.
Allowed Values: any FilterElementBean style name from StyleCatalog.xml file.

Public Constructors

public ReportFrameClassicTransform ()

default no-args constructor.

Public Methods

public void generateDesignMode (MarkupOutput out)

Function that generate output for Design mode.

Parameters
out where to write the output of the method.

public void generateExecuteMode (MarkupOutput out)

Function that generate output for execute mode.

Parameters
out where to write the output of the method.

public void generateSimpleMode (MarkupOutput out)

Function that generate output for simple mode - report in error or cancelled status.

Parameters
out where to write the output of the method.

public String getDescription ()

The description of this transform.

Returns
  • This renders the ouput of a ReportFrameBean as used by MicroStrategy Web Universal.

public Class getSupportedBeanType ()

Returns the supported bean type.
This abstract Transform supports all WebComponents.

Returns
  • WebComponent.class

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.
In particular it holds a reference to the bean being transformed.

Parameters
data The bean transforming.

public boolean isInVisualizationMode ()

Returns
  • whether the report is in visualization mode

public boolean isUrlVisualization ()

Returns

public void renderCurrentEditor (MarkupOutput out)

render the current editor for the report.
Out of box, there is only one editor open at one time.

Parameters
out output by the transform

public void renderDNDScripts (MarkupOutput out)

This method is deprecated.
No replacement.

render the supporting JavaScript and HTML code for Drag and drop functionality.

Parameters
out output by the transform

public void renderDesignModeProcessForm (MarkupOutput out)

Render the process form in design mode.
Out of box, it renders the "execute report", "save report", "cancel" and "edit report filter"/"edit grid" buttons.

Parameters
out output by the transform

public void renderFormatEditors (MarkupOutput out)

Renders the Report Formatting Editors.

Parameters
out output by the transform

public void renderMenus (MarkupOutput out)

render the menus on the top of report frame.
Out of box, it renders drop down menus and last updated time.

Parameters
out output by the transform

public void renderReportArea (MarkupOutput out)

render report area in execute mode.
Out of box, it includes object browser, format editors, current editor and report data.

Parameters
out the MarkupOutput object

public void renderReportData (MarkupOutput out)

render the report data area.
Out of box, it renders the message before the data and the report data - grid, graph or grid&graph.

Parameters
out output by the transform

public void renderReportElements (MarkupOutput out)

render the report frame elements in execute mode.
Out of box, it includes error section, report filter, view filter, toolbar, and pageby sections.

Parameters
out output by the transform

public void renderReportFormEnd (MarkupOutput out)

render the FORM close tag for report area.

Parameters
out output by the transform

public void renderReportFormStart (MarkupOutput out)

render the FORM start tag for report area.

Parameters
out output by the transform

public void renderReportToolbar (MarkupOutput out)

render the report toolbar.

Parameters
out output by the transform

public void renderTemplateEditor (MarkupOutput out)

render the template editor in design mode.
Out of box, it displays object browser on left side;
on right side, either pageby and template sections or report filter and view filter sections.

Parameters
out output by the transform

public void transformForRequestCanceled (MarkupOutput out)

Transform when the status is Canceled.

Parameters
out output by this transform

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error.

Parameters
out output by this transform

public void transformForRequestNotInited (MarkupOutput out)

Transform when the status is Not initialized.

Parameters
out output by this transform

public void transformForRequestProcessing (MarkupOutput out)

Transform when the status is Processing.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is Successful.

Parameters
out output by this transform

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Method that generates the output when the bean is WaitingForUserInput.
It checks if the child bean in this state is the report bean, and if so transforms it using the correct prompt style. However, if ReportFrameBean promptStyle property is available then prompt styles will be ignored and property value will indicate which prompt style to use.
If not, it just invokes the generateSimpleMode(MarkupOutput) method.

Parameters
out where to write the output of the method.

Protected Methods

protected void displayComponent (MarkupOutput out, String name, WebComponent bean)

Renders a FrameElement as an iFrame component.
In this case, it checks if the element is open before render it.

Parameters
out output by this transform
name the name of the component
bean the FrameElement

protected void displayComponent (MarkupOutput out, String name, String value, boolean copyContents)

Display a string as an iFrame component.

Parameters
out The HTML output
name the Component name
value the String to render.
copyContents if true contents will be copied from the ifram to the main window

protected void displayComponent (MarkupOutput out, String name, GuiElement component)

Renders a GUI element.

Parameters
out output by this transform
name the name of the component
component the GUI element object

protected void displayComponent (MarkupOutput out, String name, MarkupOutput value)

Display a string as an iFrame component.

Parameters
out The HTML output
name the Component name
value the MarkupOutput to render.

protected void displayComponent (MarkupOutput out, String name, MarkupOutput value, boolean copyContents)

Display a string as an iFrame component.

Parameters
out The HTML output
name the Component name
value the MarkupOutput to render.
copyContents if true contents will be copied from the ifram to the main window

protected void displayComponent (MarkupOutput out, String name, String value)

Display a string as an iFrame component.

Parameters
out The HTML output
name the Component name
value the String to render.

protected void displayComponent (MarkupOutput out, String name, WebComponent bean, String styleName)

Renders a WebComponent with the corresponding style as an iFrame component.

Parameters
out output by this transform
name the name of the component
bean the WebComponent to transform
styleName the transform style name as define on the style catalog

protected void displayComponent (MarkupOutput out, String name, FrameElement bean)

Renders a FrameElement as an iFrame component.
In this case, it checks if the element is open before render it.

Parameters
out output by this transform
name the name of the component
bean the FrameElement

protected void displayFrameComponent (MarkupOutput out, String name, FrameElement bean, String styleName)

protected WebEvent getDesignModeEvent ()

Returns the event used in the ReportFrame's design mode.
This event handles most of the actions of the design mode, such as Save, Execute, Cancel, Change mode, etc.

Returns
  • by default returns the WebEventDesignModeProcess event.

protected TransformInstance getPromptsTransform (ReportBean rb)

protected String getReportStyleName ()

This method returns the name of a style from the style-catalog used to render the ReportBean. The name is calculated based on the view mode, visualization settings and formal parameters. To programatically calculate a different style you may override this method.

protected boolean isEditingFilter (int filterType)