public class

PromptsCreateReportTransform

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

Class Overview

The PromptsCreateReportTransform customizes the PromptsClassicTransform to use it within the Create Report/Document page.

The changes mainly consist on controlling if the warning message with the:
Before you can edit or save this report, you must answer the following prompt(s).
message is displayed. It also changes the default message used for the execute button to Edit in Design Mode.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.PromptsClassicTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter showSaveReportButton Indicates whether or not to display 'Save' button.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.PromptsClassicTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PromptsCreateReportTransform()
Default no-args constructor.
Public Methods
String getExecuteButtonLabel()
Changes the default label to be used by the 'Execute' button to Execute in View mode if isViewMode returns true, or Edit in Design Mode otherwise.
void renderWarningHeaderMessage(MarkupOutput out)
Renders any mesage before rendering prompts forms and prompt index.
Protected Methods
boolean canSavePrompt()
Indicates whether or not end-user is enabled to save given Prompted Report.
boolean checkLevel(int iLevelConst)
Customized checkLevel function that overrides parent's behavior when formal parameter checkLevelustom is active.
boolean isViewMode()
Determines whether PromptBean container has View mode active.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.PromptsClassicTransform
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

Fields

public FormalParameter showSaveReportButton

Indicates whether or not to display 'Save' button.

Public Constructors

public PromptsCreateReportTransform ()

Default no-args constructor. Invoke parent's class constructor to initialize all corresponding properties

Public Methods

public String getExecuteButtonLabel ()

Changes the default label to be used by the 'Execute' button to Execute in View mode if isViewMode returns true, or Edit in Design Mode otherwise.

However if the formal parameter executeButtonLabel is specified, it will use its value as the ID for a message in the Resource Bundle.

Returns
  • String localized message.

public void renderWarningHeaderMessage (MarkupOutput out)

Renders any mesage before rendering prompts forms and prompt index.

Parameters
out MarkupOutput where to write the output of the method.

Protected Methods

protected boolean canSavePrompt ()

Indicates whether or not end-user is enabled to save given Prompted Report.
Useful to determine whether or not to displaye 'Save' button in Prompt page.

Returns
  • true if user has proper permissions.

protected boolean checkLevel (int iLevelConst)

Customized checkLevel function that overrides parent's behavior when formal parameter checkLevelustom is active.
When requested, this function will change behavior and will return true if 'Warning header message' flag is on and ReportBean mode is set to View mode only. If checkLevelCustom isn't active, then normal checkLevel behavior will take place.

Parameters
iLevelConst level flag
Returns
  • true means the level flag is included in the level parameter value

protected boolean isViewMode ()

Determines whether PromptBean container has View mode active.
This function assumes that container bean is ReportFrameBean. If that's the case, it checks its design mode property.

Returns
  • boolean true is view mode is active.