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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

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(PromptObject prompt, MarkupOutput out) This method is deprecated. use `renderPrompt(MarkupOutput out, PromptObject prompt)` instead.
void	renderPrompt(MarkupOutput out, PromptObject prompt) Renders the prompt content.
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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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 (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 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 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.

Interfaces

Classes

PromptsSummaryTransform

Summary

Fields

public final String FP_SHOW_ALL_PROMPTS

public final String FP_SHOW_REQUIRED_FIRST

public final String FP_SHOW_YOUR_SELECTION_TEXT

public final String FP_USE_BREAK_SEPARATOR

protected String _cssPromtAnswer

protected String _cssPromtNotAnswered

protected String _cssPromtNumber

protected String _cssPromtRequired

protected String _cssPromtSelection

protected String _cssPromtTitle

protected String _cssSummaryTable

protected FormalParameter showAllPrompts

protected FormalParameter showRequiredFirst

protected FormalParameter showYourSelectionText

protected FormalParameter useBackendDetails

protected FormalParameter useBreakSeparator

Public Constructors

public PromptsSummaryTransform ()

Public Methods

public boolean canTransform (Transformable data)

Returns

public String getDescription ()

Returns

public ArrayList getPromptsList ()

Returns

public Class getSupportedBeanType ()

Returns

public void initializeCss ()

public void initializeTransform (Transformable data)

Parameters

public void renderPrompt (PromptObject prompt, MarkupOutput out)

Parameters

public void renderPrompt (MarkupOutput out, PromptObject prompt)

Parameters

public void renderPromptDetails (MarkupOutput out)

public void renderPromptNotAnsweredText (MarkupOutput out)

Parameters

public void renderPromptNumber (MarkupOutput out, PromptObject prompt)

Parameters

public void renderPromptObjects (MarkupOutput out, PromptObject prompt)

Parameters

public void renderPromptTitle (MarkupOutput out, PromptObject prompt)

Parameters

public void renderPromptsContent (MarkupOutput out)

Parameters

public void renderRequiredPrompt (MarkupOutput out, PromptObject prompt)

Parameters

public void renderYourSelectionText (MarkupOutput out)

Parameters

public void transformForRequestSuccessful (MarkupOutput out)

Parameters

public boolean useBackendDetails ()

Protected Methods

protected PromptsBean getPromptsBean ()

Returns