Package com.microstrategy.web.app.transforms

Class PromptRadioTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractPromptObjectTransform

com.microstrategy.web.app.transforms.PromptRadioTransform

All Implemented Interfaces:

EnumPromptsBeanEvents, LayoutTransform, Transform

public class PromptRadioTransform
extends AbstractPromptObjectTransform
implements LayoutTransform

Renders each available item with a radio button, when one item is selected previous is deselected. The current selection becomes the answer.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
FormalParameter	showNoneOption	Specifies whether or not to radio option for 'none' for all non-required answer prompts.

Fields inherited from class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform

_blockCount, _calendar, _cssPrefix, _dataTypeForCalendar, _globalCss, _imagesFolder, cssPrefix, imgBackToTop, imgCalendar, imgError, isDhtmlMode, levelFlag, showRequired

Fields inherited from interface com.microstrategy.web.beans.EnumPromptsBeanEvents

ANSWER_SEPARATOR, EXPRESSION_SEPARATOR, ITEM_SEPARATOR, ITEM_SPECIAL_SEPARATOR, PROMPTS_EVENT_ADD_UNITS, PROMPTS_EVENT_ANSWER_ALL_PROMPTS, PROMPTS_EVENT_ANSWER_ANY_PROMPTS, PROMPTS_EVENT_ANSWER_CONSTANT_PROMPT, PROMPTS_EVENT_ANSWER_DIMTY_PROMPT, PROMPTS_EVENT_ANSWER_ELEMENTS_PROMPT, PROMPTS_EVENT_ANSWER_EXPRESSION_PROMPT, PROMPTS_EVENT_ANSWER_OBJECTS_PROMPT, PROMPTS_EVENT_ANSWER_PROMPTS_IN_ADVANCE, PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS, PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT, PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER, PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT, PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER, PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT, PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS, PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY, PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION, PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE, PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH, PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS, PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME, PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY, PROMPTS_EVENT_ARGUMENT_ANSWER, PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT, PROMPTS_EVENT_ARGUMENT_ANSWER_MODE_OPTION, PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS, PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID, PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID, PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN, PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT, PROMPTS_EVENT_ARGUMENT_BROWSE_PATH, PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON, PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID, PROMPTS_EVENT_ARGUMENT_DIMENSION_ID, PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT, PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID, PROMPTS_EVENT_ARGUMENT_EXEC_FLAGS, PROMPTS_EVENT_ARGUMENT_FILTER_STRING, PROMPTS_EVENT_ARGUMENT_FUNCTION, PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID, PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID, PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE, PROMPTS_EVENT_ARGUMENT_LINK_ANSWERS, PROMPTS_EVENT_ARGUMENT_MATCH_CASE, PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS, PROMPTS_EVENT_ARGUMENT_METRIC_ID, PROMPTS_EVENT_ARGUMENT_NAVIGATION, PROMPTS_EVENT_ARGUMENT_OBJECT_TYPE, PROMPTS_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID, PROMPTS_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML, PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID, PROMPTS_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER, PROMPTS_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER, PROMPTS_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER, PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION, PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT, PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE, PROMPTS_EVENT_ARGUMENT_SEARCH_NAME, PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT, PROMPTS_EVENT_ARGUMENT_SRC_ANSWERS, PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR, PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER, PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD, PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE, PROMPTS_EVENT_ARGUMENT_USE_SET_ANSWERS, PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR, PROMPTS_EVENT_BROWSE_DIMENSION_ATTRIBUTE_ELEMENTS, PROMPTS_EVENT_BROWSE_ELEMENTS, PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER, PROMPTS_EVENT_BROWSE_HIERARCHICAL_PARENT_FOLDER, PROMPTS_EVENT_CANCEL_ALL_PROMPTS, PROMPTS_EVENT_CANCEL_ANY_PROMPTS, PROMPTS_EVENT_CLEAR_EXISTING_AND_ADD_UNITS, PROMPTS_EVENT_CLEAR_HIERARCHICAL_SEARCH_EXPRESSION, PROMPTS_EVENT_DRILL_WITHIN_HIERARCHY, PROMPTS_EVENT_HIGHLIGHT_DIMENSION, PROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE, PROMPTS_EVENT_INCREMENTAL_FETCH, PROMPTS_EVENT_NAVIGATE_PROMPTS_BEAN, PROMPTS_EVENT_PROCESS_ALL_PROMPTS, PROMPTS_EVENT_PROCESS_ANY_PROMPTS, PROMPTS_EVENT_REMOVE_UNITS, PROMPTS_EVENT_SEARCH_BY_NAME, PROMPTS_EVENT_SHOW_ALL_PROMPTS_SUMMARY, PROMPTS_EVENT_SHOW_ANY_PROMPTS_SUMMARY, SIMPLE_SEPARATOR_CARET, SIMPLE_SEPARATOR_COMMA, SIMPLE_SEPARATOR_SEMICOLON, UNIT_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
PromptRadioTransform()	Default no-args constructor, initialize all the formal parameters.

Method Summary

Modifier and Type	Method	Description
boolean	canTransform(Transformable data)	Extends canTransform() by returning true only if the prompt is of type EnumWebPromptType.WebPromptTypeObjects or EnumWebPromptType.WebPromptTypeElements
java.lang.String	getDescription()	This transforms description
void	initializeCss()	Initialize the css information to be used by this transform.
boolean	isAnswerComplex()	Checks whether a prompt has a default answer, and if it has, if the default answer is complex.
void	renderAvailable(MarkupOutput out)	Renders the available answers for this prompt.
void	renderNoneRadioOption(MarkupOutput out)	Renders HTML radio option for 'None' option.
void	renderNoneRadioOption(MarkupOutput out, java.lang.String argument, boolean isSelected)	Renders HTML radio option for 'None' option.
void	renderPromptContent(MarkupOutput out)	Renders the prompt content.
void	renderRadioOption(MarkupOutput out, WebDisplayUnit item)	Renders HTML radio option populated with information stored in WebDisplayUnit.
void	renderRadioOption(MarkupOutput out, WebDisplayUnit item, java.lang.String argument, boolean isAnswerComplex)	Renders HTML radio option populated with information stored in WebDisplayUnit.
protected void	setExtraArguments()	Sets extra arguments for this prompt.
protected boolean	shouldRenderNoneOption()	Indicates whether or not 'None' option should be displayed.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform

addFormalParameter, arePromptsLoadedFirstTime, areThereAvailableSelections, checkLevel, getAnswerEvent, getArgumentName, getAttrElemBlockCount, getAvailableDisplayUnits, getCalendar, getContainerServices, getDescriptor, getDescriptor, getDescriptor, getDimensionAttribute, getDisplayHelper, getErrorMessage, getIntValue, getLocale, getMatchCaseSensitivity, getMultipleEvent, getMultipleEventArgumentString, getObjectsBlockCount, getPrompt, getPromptsAppContext, getPromptsBean, getPromptsList, getRequestKeys, getShowRequired, getStringValue, getSupportedBeanType, getTagsFactory, hasAnswer, initializeImages, initializePromptContent, initializePromptObject, isBackToTopAnchorEnabled, isDhtmlMode, isDimensionalPrompt, isForDefinition, isIFrameRequest, isItemKeptInCartAvailable, isLocked, isLockedForSearch, isNodeComplex, isPromptObjectInitialized, isPromptRequired, isPromptSummaryEnabled, isTrue, isXDA_CustomSQL_Report, isXDA_MDX_Report, isXDAReport, newHiddenInputBuilder, newNamespaceEncoder, onBeforeApplyDefaultDisplaySettings, processAvailableItems, processIncrementalFetch, renderLayout, renderMinMaxHiddenValues, renderPromptAnswerMeaning, renderPromptBackToTopAnchor, renderPromptDefaultAnswer, renderPromptErrorMessage, renderPromptHiddenInputs, renderPromptIFrameRequest, renderPromptMeaning, renderPromptNoSelectionsAvailable, renderPromptNotAnswered, renderPromptQuestion, renderPromptRestrictions, renderPromptSummary, renderPromptSummaryAnswer, renderPromptSummaryTitle, renderPromptTitle, setArgumentValue, setAttrElemBlockCount, setEnableBackToTopAnchor, setIsItemKeptInCartAvailable, setLevelFlag, setLocale, setMatchCaseSensitivity, setObjectsBlockCount, setPromptSummary, setShowRequired, transform

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutContext, getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

showNoneOption

public FormalParameter showNoneOption

Specifies whether or not to radio option for 'none' for all non-required answer prompts.
It indicates to render a radion button for 'none' answer as the first option in the list.
This parameter will be valid if given prompt doesn't require an prompt answer.
This flag is used as boolean value.

Since:

MicroStrategy Web 8.0.0

Constructor Detail

PromptRadioTransform

public PromptRadioTransform()

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

Method Detail

renderAvailable

public void renderAvailable(MarkupOutput out)

Renders the available answers for this prompt.

Parameters:

out - MarkupOutput the transform output

renderRadioOption

public void renderRadioOption(MarkupOutput out,
                              WebDisplayUnit item)

Renders HTML radio option populated with information stored in WebDisplayUnit.

Parameters:

out - MarkupOutput where to write ouput.

item - WebDisplayUnit instance containing info to be parsed.

Since:

MicroStrategy Web 8.0.0

renderNoneRadioOption

public void renderNoneRadioOption(MarkupOutput out)

Renders HTML radio option for 'None' option.

Parameters:

out - MarkupOutput where to write ouput.

Since:

MicroStrategy Web 8.0.0

renderNoneRadioOption

public void renderNoneRadioOption(MarkupOutput out,
                                  java.lang.String argument,
                                  boolean isSelected)

Renders HTML radio option for 'None' option.

Parameters:

out - MarkupOutput where to write output

argument - String unique id for HTML radio button.

isSelected - boolean indicating whether or not to default to selected.

Since:

MicroStrategy Web 8.0.0

renderRadioOption

public void renderRadioOption(MarkupOutput out,
                              WebDisplayUnit item,
                              java.lang.String argument,
                              boolean isAnswerComplex)

Renders HTML radio option populated with information stored in WebDisplayUnit.

Parameters:

out - MarkupOutput where to write ouput.

item - WebDisplayUnit instance containing info to be parsed.

argument - String unique id for identifying given Radio button.

isAnswerComplex - boolean true if answer is considered complex.

Since:

MicroStrategy Web 8.0.0

renderPromptContent

public void renderPromptContent(MarkupOutput out)

Renders the prompt content.

Overrides:

renderPromptContent in class AbstractPromptObjectTransform

Parameters:

out - MarkupOutput the transform output

initializeCss

public void initializeCss()

Initialize the css information to be used by this transform.
It invokes parent method so all shared CSS classes get initialized as well.

Overrides:

initializeCss in class AbstractPromptObjectTransform

Since:

MicroStrategy Web 8.0.0

isAnswerComplex

public boolean isAnswerComplex()

Checks whether a prompt has a default answer, and if it has, if the default answer is complex. Complex answers are those that cannot be displayed by the prompt answer input interface, so they need to be rendered in a separate window

Specified by:

isAnswerComplex in class AbstractPromptObjectTransform

Returns:

true if the prompt has a default answer and it is complex.

canTransform

public boolean canTransform(Transformable data)

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

Specified by:

canTransform in interface Transform

Overrides:

canTransform in class AbstractTransform

Parameters:

data - object (PromptObject) to transform

Returns:

true if the data is a PromptObject of a Expression WebPrompt.

setExtraArguments

protected void setExtraArguments()

Sets extra arguments for this prompt.
These arguments will be render later as hidden inputs.

Overrides:

setExtraArguments in class AbstractPromptObjectTransform

getDescription

public java.lang.String getDescription()

This transforms description

Specified by:

getDescription in interface Transform

Returns:

the description of a radio button answer.

shouldRenderNoneOption

protected boolean shouldRenderNoneOption()

Indicates whether or not 'None' option should be displayed. WebPrompt instance determine whether or not to displaye the 'none' option.

Returns:

boolean true if 'none' is to be displayed.

Since:

MicroStrategy Web 8.0.0