Package com.microstrategy.web.app.transforms

Class PromptExpressionTextboxTransform

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

com.microstrategy.web.app.transforms.PromptExpressionTextboxTransform

All Implemented Interfaces:

EnumPromptsBeanEvents, LayoutTransform, Transform

public class PromptExpressionTextboxTransform
extends PromptExpressionNonCartTransform

Renders each available expression 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 inherited from class com.microstrategy.web.app.transforms.PromptExpressionNonCartTransform

_availableArgument, _availableLabel, _inputLabel, _inputValue, _operator, _operatorArg, _operatorDimensionality, _operatorLabel, _operatorType, inputSize, selectSize

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

attrFormTypeInAvailableList, defaultOperatorId, editMetricQualificationOutputLevel, inputFromTextFile

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
PromptExpressionTextboxTransform()	Default no-args constructor, initialize all the formal parameters.

Method Summary

Modifier and Type	Method	Description
protected void	displayOption(MarkupOutput out, java.lang.String argument, java.lang.String displayName, java.lang.String value, boolean isSelected, java.lang.String dataType)	Renders HTML option tag.
void	initializeCss()	Initializes CSS information to be used by this transform.
protected boolean	isNodeComplex(WebNode node)	Indicates whether or not prompt's answer is considered complex.
void	renderAvailable(MarkupOutput out)	Renders available list.
void	renderOperators(MarkupOutput out)	Renders operators HTML pull-down.
void	renderPromptContent(MarkupOutput out)	Renders current prompt's content.

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

canTransform, displayOption, getAnswer, getDefaultShortcutId, getDescription, getObjectIDfromAnswer, initializeFormalParameters, initializePromptContent, isAnswerComplex, processIncrementalFetch, processSelectedItems, renderAvailableLabel, renderEditContentBelowInput, renderInput, renderInputLabel, renderOperatorLabel

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

getDimtyAsString, getDimtyAttributesAsString, getOutputLevel, isBrowserIE6, isCart, isMQLevelEditingSupported, isNodeDimtyEmpty, renderHiddenInputsForMQEditor, renderOutputLevelLabel, renderPromptHiddenInputs, setExtraArguments, setMetricQualOutputLevelAndDimty

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, initializePromptObject, isBackToTopAnchorEnabled, isDhtmlMode, isDimensionalPrompt, isForDefinition, isIFrameRequest, isItemKeptInCartAvailable, isLocked, isLockedForSearch, isPromptObjectInitialized, isPromptRequired, isPromptSummaryEnabled, isTrue, isXDA_CustomSQL_Report, isXDA_MDX_Report, isXDAReport, newHiddenInputBuilder, newNamespaceEncoder, onBeforeApplyDefaultDisplaySettings, processAvailableItems, renderLayout, renderMinMaxHiddenValues, renderPromptAnswerMeaning, renderPromptBackToTopAnchor, renderPromptDefaultAnswer, renderPromptErrorMessage, 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

Constructor Detail

PromptExpressionTextboxTransform

public PromptExpressionTextboxTransform()

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

Method Detail

initializeCss

public void initializeCss()

Initializes CSS information to be used by this transform.

Overrides:

initializeCss in class PromptExpressionNonCartTransform

Since:

MicroStrategy Web 8.0.0

renderPromptContent

public void renderPromptContent(MarkupOutput out)

Renders current prompt's content.
It defines layout for current prompt question.

Overrides:

renderPromptContent in class PromptExpressionNonCartTransform

Parameters:

out - the transform output

renderAvailable

public void renderAvailable(MarkupOutput out)

Renders available list.
HTML list will be populated with all items in available list which is part of current prompt question.

Overrides:

renderAvailable in class PromptExpressionNonCartTransform

Parameters:

out - the transform output

isNodeComplex

protected boolean isNodeComplex(WebNode node)

Indicates whether or not prompt's answer is considered complex.
This method checks if a single subexpression is Complex. For textbox the only expressions we support is In for Attribute qualifications, and GreaterThan for MetricQualifications.

Overrides:

isNodeComplex in class PromptExpressionNonCartTransform

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.

displayOption

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

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

Overrides:

displayOption in class PromptExpressionNonCartTransform

Parameters:

out - MarkupOutput the transform output

argument - String argument name for the option tag

displayName - String display value

value - String what's submitted as value

isSelected - boolean indicates whether this option is selected

dataType - String indicates HTML Tag property.

renderOperators

public void renderOperators(MarkupOutput out)

Renders operators HTML pull-down.
Populated with operators only supported in Expression prompts.

Overrides:

renderOperators in class PromptExpressionNonCartTransform

Parameters:

out - where to write the output of the method.