public class

ReportFrameGenericTransform

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

Class Overview

This transforms renders a ReportFrameBean using a LayoutBuilder. It's iFrame aware, so it provides methods to render elements as iFrame components.

Summary

Constants
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".
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FrameGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
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.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FrameGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportFrameGenericTransform()
Default constructor.
Public Methods
final static String[] getFeaturesList()
String getID()
Returns the unique name of the component to be used as the ID for its shell.
Map getReportDataCellAttributes()
Generate the extra attributes the cell holding the report data requires.
Map getReportFormAttributes()
Generate the extra attributes the main report form requires for its proper definition.
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)

This method extends the parent method by initializing additional private and protected fields of the transform, such as filter editor details.

boolean isDesignFilterDisplayed()
boolean isDesignTemplateDisplayed()
void renderBean(MarkupOutput out, String name, String style, boolean setChanged)
Renders any bean within the hierarchy using the specified style
void renderDesignModeButtonBar(MarkupOutput out)
Generate the HTML corresponding to the button bar that can be rendered on top of the filter and template information while in design mode.
void renderEditorMessage(MarkupOutput out, String name)
Generate the HTML corresponding to the editor message, as available via the getEditorMessage property of the FrameBean.
void renderEmptyIFrameComponent(MarkupOutput out, String name)
Generates the HTML corresponding to a component that should not render any contents at the time.
void renderIFrameComponent(MarkupOutput out, String name)
Generates the HTML for the corresponding frame child component
void renderReportFormHiddenInputs(MarkupOutput out)
Generate the hidden inputs that should be appended to the form definition while handling report data.
void renderVisualization(MarkupOutput out, String name, boolean setChanged)
This method verifies the visualization settings of the bean and renders it according to the style specified there
void transformForRequestSuccessful(MarkupOutput out)
Method that generates the output when the bean is Successful.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Method that generates the output when the bean is WaitingForUserInput.
Protected Methods
WebEvent getDesignModeEvent()
void renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FrameGenericTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

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"

Fields

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.

Public Constructors

public ReportFrameGenericTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public static final String[] getFeaturesList ()

Returns
  • a copy of the features String array that is sent to the report frame

public String getID ()

Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).

Returns
  • the component's unique id

public Map getReportDataCellAttributes ()

Generate the extra attributes the cell holding the report data requires.

Returns
  • Map instance initialized with the extra attributes to include into the cell's defintion

public Map getReportFormAttributes ()

Generate the extra attributes the main report form requires for its proper definition. Such attributes include the form name, action, method and any extra information required for it to work properly on iframe environments if needed.

Returns
  • Map instance initialized with the extra attributes to include into the form's defintion

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • Class instance corresponding to the ReportFrameBean which is the one supported by this transform

public void initializeTransform (Transformable data)

This method extends the parent method by initializing additional private and protected fields of the transform, such as filter editor details.

Parameters
data the bean to transform.

public boolean isDesignFilterDisplayed ()

Returns
  • boolean value indicating if the design mode is (or should be) rendering the filter information

public boolean isDesignTemplateDisplayed ()

Returns
  • boolean value indicating if the design mode is (or should be) rendering the template information

public void renderBean (MarkupOutput out, String name, String style, boolean setChanged)

Renders any bean within the hierarchy using the specified style

Parameters
out MarkupOutput instance
name the name of the bean to render
style the name of the style to user to render the bean
setChanged forces the bean to be marked as changed, in order to have it rendered. If argument is false, property will not be updated.

public void renderDesignModeButtonBar (MarkupOutput out)

Generate the HTML corresponding to the button bar that can be rendered on top of the filter and template information while in design mode. This button bar allows users to perform actions such as Cancel design mode, Run the resulting report or Save the changes.

Parameters
out MarkupOutput instance where the HTML output will be saved

public void renderEditorMessage (MarkupOutput out, String name)

Generate the HTML corresponding to the editor message, as available via the getEditorMessage property of the FrameBean. Internally calls the displayComponent(MarkupOutput, String, String) method for the final HTML generation.

Parameters
out MarkupOutput instance where the HTML output will be saved
name String value with the name to be used for the component wrapping the HTML content to generate

public void renderEmptyIFrameComponent (MarkupOutput out, String name)

Generates the HTML corresponding to a component that should not render any contents at the time. It creates the component placeholder for future rendering, when handling iframe manipulations.

Parameters
out MarkupOutput instance where the HTML output will be saved
name String value with the name to be used for the component wrapping the HTML content to generate

public void renderIFrameComponent (MarkupOutput out, String name)

Generates the HTML for the corresponding frame child component

Parameters
out MarkupOutput instance where the HTML output will be saved
name String value with the name to be used for the component wrapping the HTML content to generate, as well as indicating which component will be rendered by this method.

public void renderReportFormHiddenInputs (MarkupOutput out)

Generate the hidden inputs that should be appended to the form definition while handling report data.

Parameters
out MarkupOutput instance where the HTML output will be saved

public void renderVisualization (MarkupOutput out, String name, boolean setChanged)

This method verifies the visualization settings of the bean and renders it according to the style specified there

Parameters
out MarkupOutput instance where the output will be stored
name String indicating the name of the bean to be rendered
setChanged boolean indicating if the bean has changed since the last time it was rendered

public void transformForRequestSuccessful (MarkupOutput out)

Method that generates the output when the bean is Successful.

Parameters
out where to write the output of the method.

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 WebEvent getDesignModeEvent ()

Returns
  • WebEvent corresponding to the design mode event supported by this transform

protected void renderRegisterBone (MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Parameters
out MarkupOutput whether the output should be rendered.

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.