public class

PromptExpressionNonCartTransform

extends AbstractPromptExpressionTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
         ↳ com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
           ↳ com.microstrategy.web.app.transforms.PromptExpressionNonCartTransform
Known Direct Subclasses

Class Overview

Renders each available expression item with a radio button, when one item is selected previous is deselected. The current selection becomes the answer. This transforms makes use of Tag instances to render HTML output. See reference to TagsFactory.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.beans.EnumPromptsBeanEvents
Fields
protected String _availableArgument Available list argument for select tag.
protected String _availableLabel Label used for rendering available list
protected String _inputLabel Input label for input textfield.
protected String _inputValue Value of current prompt answer.
protected int _operator Current operator or function ID
protected String _operatorArg Indicates operator argument name.
protected String _operatorDimensionality Determines answer dimensionality
protected String _operatorLabel Operator label for operator pull-down menu.
protected int _operatorType Current operator or function type
public FormalParameter inputSize Specifies the size of the input textfield.
public FormalParameter selectSize The number of elements that the Selected list box displays.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
From class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
Public Constructors
PromptExpressionNonCartTransform()
Default no-args constructor, initialize all the formal parameters.
Public Methods
boolean canTransform(Transformable data)
Extends canTransform() by returning true only if the prompt is of type EnumWebPromptType.WebPromptTypeExpression
String getDescription()
This transforms description
void initializeCss()
Initializes CSS information to be used by this transform.
void initializeFormalParameters()
Initializes formal parameters.
void initializePromptContent()
Initializes prompt content.
boolean isAnswerComplex()
Determines if current answer is complex or not.
void renderAvailable(MarkupOutput out)
Renders Available list in HTML list component.
void renderAvailableLabel(MarkupOutput out)
Renders an HTML label associated to Available section.
void renderEditContentBelowInput(MarkupOutput out)
Renders the text and button that opens the output level editor.
void renderInput(MarkupOutput out)
Renders qualification value textbox.
void renderInputLabel(MarkupOutput out)
Renders an HTML label associated to value input section.
void renderOperatorLabel(MarkupOutput out)
Renders an HTML label associated to Operators section.
void renderOperators(MarkupOutput out)
Renders operators pull-down.
void renderPromptContent(MarkupOutput out)
Renders the prompt content.
Protected Methods
void displayOption(MarkupOutput out, String argument, String displayName, String value, boolean isSelected, String dataType)
Renders HTML option tag.
void displayOption(MarkupOutput out, String argument, String displayName, String value, boolean isSelected)
Renders HTML option tag.
WebExpression getAnswer()
function that retrieves answer from given Web prompt object.
String getDefaultShortcutId()
Parses current prompt answer in order to obtain shortcut Id.
String getObjectIDfromAnswer()
Function that obtains from current answer first DisplayUnit Id
boolean isNodeComplex(WebNode node)
This method is deprecated. This method has been deprecated since this is specific to expression prompts.
Use the method on AbstractPromptExpressionTransform.
void processIncrementalFetch()
Initializes incremental fetching settings.
void processSelectedItems()
Initializes selected items list.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
From class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected String _availableArgument

Available list argument for select tag.

protected String _availableLabel

Label used for rendering available list

protected String _inputLabel

Input label for input textfield.

protected String _inputValue

Value of current prompt answer.

protected int _operator

Current operator or function ID

protected String _operatorArg

Indicates operator argument name.

protected String _operatorDimensionality

Determines answer dimensionality

protected String _operatorLabel

Operator label for operator pull-down menu.

protected int _operatorType

Current operator or function type

public FormalParameter inputSize

Specifies the size of the input textfield. This flag is used as an int value.

public FormalParameter selectSize

The number of elements that the Selected list box displays. This flag is used as an int value.

Public Constructors

public PromptExpressionNonCartTransform ()

Default no-args constructor, initialize all the formal parameters.

Public Methods

public boolean canTransform (Transformable data)

Extends canTransform() by returning true only if the prompt is of type EnumWebPromptType.WebPromptTypeExpression

Parameters
data object (PromptObject) to transform
Returns
  • true if the data is a PromptObject of a Expression WebPrompt.

public String getDescription ()

This transforms description

Returns
  • the description of a radio button answer.

public void initializeCss ()

Initializes CSS information to be used by this transform.

public void initializeFormalParameters ()

Initializes formal parameters.

public void initializePromptContent ()

Initializes prompt content.
Extends initializePromptContent() by calling processIncrementalFetch and processSelectedItems. It also initialize the Cart object associated.

Throws
WebObjectsException

public boolean isAnswerComplex ()

Determines if current answer is complex or not.

Returns
  • true if answer is complex

public void renderAvailable (MarkupOutput out)

Renders Available list in HTML list component.

Parameters
out MarkupOutput the transform output

public void renderAvailableLabel (MarkupOutput out)

Renders an HTML label associated to Available section.

Parameters
out where to write HTML label.

public void renderEditContentBelowInput (MarkupOutput out)

Renders the text and button that opens the output level editor.

Parameters
out where to write the output of the method.

public void renderInput (MarkupOutput out)

Renders qualification value textbox.

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

public void renderInputLabel (MarkupOutput out)

Renders an HTML label associated to value input section.

Parameters
out where to write HTML label.

public void renderOperatorLabel (MarkupOutput out)

Renders an HTML label associated to Operators section.

Parameters
out where to write HTML label.

public void renderOperators (MarkupOutput out)

Renders operators pull-down.

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

public void renderPromptContent (MarkupOutput out)

Renders the prompt content.

Parameters
out MarkupOutput the transform output

Protected Methods

protected void displayOption (MarkupOutput out, String argument, String displayName, String value, boolean isSelected, String dataType)

Renders HTML option tag.
Used for creating list of options.

Parameters
out the transform output
argument argument name for the option tag
displayName display value
value what's submitted as value
isSelected indicates whether this option is selected
dataType indicates data type for Tag property.

protected void displayOption (MarkupOutput out, String argument, String displayName, String value, boolean isSelected)

Renders HTML option tag.
Used for creating list of options.

Parameters
out the transform output
argument argument name for the option tag
displayName display value
value what's submitted as value
isSelected indicates whether this option is selected

protected WebExpression getAnswer ()

function that retrieves answer from given Web prompt object.

Returns
  • WebExpression instance that represents prompt current answer.

protected String getDefaultShortcutId ()

Parses current prompt answer in order to obtain shortcut Id.

Returns
  • String ID of shortcut node.

protected String getObjectIDfromAnswer ()

Function that obtains from current answer first DisplayUnit Id

Returns
  • text Id of given displayUnit in answer.

protected boolean isNodeComplex (WebNode node)

This method is deprecated.
This method has been deprecated since this is specific to expression prompts.
Use the method on AbstractPromptExpressionTransform.

This method checks if a single subexpression is Complex. An expression is complex if it cannot be created using the Web interface.
This is used by ExpressionPrompts transforms to determine if the Answer is Complex.

Parameters
node the root node of the subexpression to check
Returns
  • True if the Node is complex, that is, it cannot be created using Web.

protected void processIncrementalFetch ()

Initializes incremental fetching settings.

Throws
WebObjectsException

protected void processSelectedItems ()

Initializes selected items list.
This cart only supports Element and Objects prompts lists.

Throws
WebObjectsException when parsing each item in Selected list.