public class

PromptsSummaryTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.PromptsSummaryTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public final String FP_SHOW_ALL_PROMPTS Constant representing the name of the showAllPrompts formal parameter
public final String FP_SHOW_REQUIRED_FIRST Constant representing the name of the showRequiredFirst formal parameter
public final String FP_SHOW_YOUR_SELECTION_TEXT Constant representing the name of the showYourSelectionText formal parameter
public final String FP_USE_BREAK_SEPARATOR Constant representing the name of the useHTMLBreakSeparator formal parameter
protected String _cssPromtAnswer
protected String _cssPromtNotAnswered
protected String _cssPromtNumber
protected String _cssPromtRequired
protected String _cssPromtSelection
protected String _cssPromtTitle
protected String _cssSummaryTable CSS valriables
protected FormalParameter showAllPrompts Specifies whether to show all prompts in report page.
protected FormalParameter showRequiredFirst Specifies whether prompts defined as required will be rendered first or not.
protected FormalParameter showYourSelectionText Specifies whether or not to display "Your selection:" area.
protected FormalParameter useBackendDetails Whether to use backend's filter details when possible
protected FormalParameter useBreakSeparator Specifies whether to use an HTML break or not between prompt answers.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PromptsSummaryTransform()
Default no-args constructor.
Public Methods
boolean canTransform(Transformable data)
Checks that the transform supports specified data object and that object is in the state supported by this transform.
String getDescription()
Indicates description for this Transform.
ArrayList getPromptsList()
Returns current prompt list.
Class getSupportedBeanType()
Returns Bean type of prompt object being used by the transform.
void initializeCss()
Initializes the css classes to be used by this transform.
void initializeTransform(Transformable data)
Initializes the objects the transform will use to render its content.
void renderPrompt(MarkupOutput out, PromptObject prompt)
Renders the prompt content.
void renderPrompt(PromptObject prompt, MarkupOutput out)
This method is deprecated. use renderPrompt(MarkupOutput out, PromptObject prompt) instead.
void renderPromptDetails(MarkupOutput out)
void renderPromptNotAnsweredText(MarkupOutput out)
Renders localized message "Prompt not answered".
void renderPromptNumber(MarkupOutput out, PromptObject prompt)
Renders prompt number.
void renderPromptObjects(MarkupOutput out, PromptObject prompt)
Render Prompt objects.
void renderPromptTitle(MarkupOutput out, PromptObject prompt)
Renders Prompt's title.
void renderPromptsContent(MarkupOutput out)
Renders output for all prompts.
void renderRequiredPrompt(MarkupOutput out, PromptObject prompt)
Renders required prompt text message.
void renderYourSelectionText(MarkupOutput out)
Renders localized message "Your selection:".
void transformForRequestSuccessful(MarkupOutput out)
Renders prompt when component status is marked as "Successful".
boolean useBackendDetails()
Protected Methods
PromptsBean getPromptsBean()
Returns active PromptBean instance used by this transform.
[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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

public final String FP_SHOW_ALL_PROMPTS

Constant representing the name of the showAllPrompts formal parameter

Constant Value: "showAllPrompts"

public final String FP_SHOW_REQUIRED_FIRST

Constant representing the name of the showRequiredFirst formal parameter

Constant Value: "showRequiredFirst"

public final String FP_SHOW_YOUR_SELECTION_TEXT

Constant representing the name of the showYourSelectionText formal parameter

Constant Value: "showYourSelectionText"

public final String FP_USE_BREAK_SEPARATOR

Constant representing the name of the useHTMLBreakSeparator formal parameter

Constant Value: "useBreakSeparator"

protected String _cssPromtAnswer

protected String _cssPromtNotAnswered

protected String _cssPromtNumber

protected String _cssPromtRequired

protected String _cssPromtSelection

protected String _cssPromtTitle

protected String _cssSummaryTable

CSS valriables

protected FormalParameter showAllPrompts

Specifies whether to show all prompts in report page.
If set to false we will render only the open prompts. This flag is used as boolean value.

protected FormalParameter showRequiredFirst

Specifies whether prompts defined as required will be rendered first or not.
Applies only when prompts are displayed in one page. Prompts can be sorted by priority.
This flag is used as boolean value.

protected FormalParameter showYourSelectionText

Specifies whether or not to display "Your selection:" area.
This flag is used as boolean value.

protected FormalParameter useBackendDetails

Whether to use backend's filter details when possible

protected FormalParameter useBreakSeparator

Specifies whether to use an HTML break or not between prompt answers. Indicates if the different prompt answers selected to be displayed should be separated from each other using HTML break <BR> or no line break at all.
This flag is used as boolean value.

Public Constructors

public PromptsSummaryTransform ()

Default no-args constructor.
Initialize all Formal Parameters.

Public Methods

public boolean canTransform (Transformable data)

Checks that the transform supports specified data object and that object is in the state supported by this transform.

Returns
  • true if the transform supports specified data object and the object is in the state supported by this transform.

public String getDescription ()

Indicates description for this Transform.

Returns
  • String "This is the Transform that renders the summary of all prompts."

public ArrayList getPromptsList ()

Returns current prompt list.
List is consisted of all prompts defined in current Report.

Returns
  • ArrayList collection of available prompts.

public Class getSupportedBeanType ()

Returns Bean type of prompt object being used by the transform.

Returns
  • Class object, reference to PromptObject instance.

public void initializeCss ()

Initializes the css classes to be used by this transform.

public void initializeTransform (Transformable data)

Initializes the objects the transform will use to render its content.

Parameters
data the prompt bean to transform

public void renderPrompt (MarkupOutput out, PromptObject prompt)

Renders the prompt content.

Parameters
out MarkupOutput where to write the output of the method.
prompt PromptObject the prompt to display

public void renderPrompt (PromptObject prompt, MarkupOutput out)

This method is deprecated.
use renderPrompt(MarkupOutput out, PromptObject prompt) instead.

Renders prompt content.

Parameters
prompt PromptObject current active instance.
out MarkupOutput where to write prompt content.

public void renderPromptDetails (MarkupOutput out)

public void renderPromptNotAnsweredText (MarkupOutput out)

Renders localized message "Prompt not answered".

Parameters
out where to write the output of the method.

public void renderPromptNumber (MarkupOutput out, PromptObject prompt)

Renders prompt number.

Parameters
out MarkupOutput where to render prompt.
prompt PromptObject being parsed

public void renderPromptObjects (MarkupOutput out, PromptObject prompt)

Render Prompt objects.

Parameters
out MarkupOutput where to render prompt.
prompt PromptObject being parsed

public void renderPromptTitle (MarkupOutput out, PromptObject prompt)

Renders Prompt's title.

Parameters
out MarkupOutput where to render prompt.
prompt PromptObject being parsed

public void renderPromptsContent (MarkupOutput out)

Renders output for all prompts.

Parameters
out MarkupOutput the content output.

public void renderRequiredPrompt (MarkupOutput out, PromptObject prompt)

Renders required prompt text message.

Parameters
out MarkupOutput where to render prompts
prompt PromptObject current prompt being rendered.

public void renderYourSelectionText (MarkupOutput out)

Renders localized message "Your selection:".

Parameters
out where to write the output of the method.

public void transformForRequestSuccessful (MarkupOutput out)

Renders prompt when component status is marked as "Successful".
Method renderPromptsContent() is invoked in this function.

Parameters
out where to write the output of the method.

public boolean useBackendDetails ()

Protected Methods

protected PromptsBean getPromptsBean ()

Returns active PromptBean instance used by this transform.

Returns
  • PromptsBean instance.