Class PromptListboxTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
-
- com.microstrategy.web.app.transforms.PromptListboxTransform
-
- All Implemented Interfaces:
EnumPromptsBeanEvents
,LayoutTransform
,Transform
public class PromptListboxTransform extends AbstractPromptObjectTransform implements LayoutTransform
Renders the list of available items inside a listbox, items selected become the answer. This transforms makes use ofTag
instances to render HTML output. See reference toTagsFactory
.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description FormalParameter
multiSelect
Boolean flag that specifies whether or not to enable multi-select in selected list.FormalParameter
selectSize
The number of elements that the Selected list box displays.-
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 PromptListboxTransform()
Default no-args constructor, initialize all the formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canTransform(Transformable data)
Extends canTransform() by returning true only if the prompt is of typeEnumWebPromptType.WebPromptTypeObjects
orEnumWebPromptType.WebPromptTypeElements
java.lang.String
getDescription()
This transforms description.void
initializeCss()
Initialize the CSS information to be used by this transform.boolean
isAnswerComplex()
Determines whether a prompt has a default answer, and if it has, if the default answer is complex.protected boolean
isNoneOptionRendered()
Indicates whether or not 'none' options needs to be rendered as part of the available list.void
renderAvailable(MarkupOutput out)
Renders the list of available items.void
renderCloseSelect(MarkupOutput out)
Renders closing HTML tag for Select list.void
renderEmptyOption(MarkupOutput out)
Renders empty HTML option tag.void
renderEmptyOption(MarkupOutput out, int availableSize)
Renders empty HTML option tag.void
renderListOption(MarkupOutput out, WebDisplayUnit item)
Renders HTML option tag populated with data from WebDisplayUnit instance.void
renderListOption(MarkupOutput out, WebDisplayUnit item, boolean isComplexAnswer)
Renders HTML option tag populated with data from WebDisplayUnit instance.void
renderOpenSelect(MarkupOutput out)
Renders open HTML tag for Select list.void
renderPromptContent(MarkupOutput out)
Renders prompt's content in Question area.protected void
setExtraArguments()
Sets extra arguments for this prompt.-
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
-
multiSelect
public FormalParameter multiSelect
Boolean flag that specifies whether or not to enable multi-select in selected list.
Not all prompt types and style support multiselect of elements, so even if this parameter is true, the multiselect functionality might not be available.
This flag is used as a boolean value.
-
selectSize
public FormalParameter selectSize
The number of elements that the Selected list box displays.
This flag is used as an int value.
-
-
Method Detail
-
renderPromptContent
public void renderPromptContent(MarkupOutput out)
Renders prompt's content in Question area.- Overrides:
renderPromptContent
in classAbstractPromptObjectTransform
- Parameters:
out
-MarkupOutput
the transform output
-
renderAvailable
public void renderAvailable(MarkupOutput out)
Renders the list of available items.- Parameters:
out
-MarkupOutput
the transform output
-
renderOpenSelect
public void renderOpenSelect(MarkupOutput out)
Renders open HTML tag for Select list.
Its size is defined by FP selectSize.- Parameters:
out
-MarkupOutput
where to write open select tag.- Since:
- MicroStrategy Web 8.0.0
-
renderCloseSelect
public void renderCloseSelect(MarkupOutput out)
Renders closing HTML tag for Select list.- Parameters:
out
-MarkupOutput
where to write closing HTML tag.- Since:
- MicroStrategy Web 8.0.0
-
renderEmptyOption
public void renderEmptyOption(MarkupOutput out)
Renders empty HTML option tag.
It invokes overloaded function renderEmptyOption where new parameter availableSize is passed. THis parameter value corresponds to value defined in FP selectSize.- Parameters:
out
-MarkupOutput
where to write empty option.- Since:
- MicroStrategy Web 8.0.0
-
renderEmptyOption
public void renderEmptyOption(MarkupOutput out, int availableSize)
Renders empty HTML option tag.
Empty option gets rendered only if availableSize is greater or equal than 1 and if 'None' option hasn't been displayed yet (isNoneOptionRendered() method).- Parameters:
out
-MarkupOutput
where to write empty option.availableSize
- int indicating lenght of the list.- Since:
- MicroStrategy Web 8.0.0
-
renderListOption
public void renderListOption(MarkupOutput out, WebDisplayUnit item)
Renders HTML option tag populated with data from WebDisplayUnit instance.
This is an overloaded method which acts as wrapper method. It determines whether or not current prompt answer is complex and passes it as parameter to wrapped method renderListOption().- Parameters:
out
-MarkupOutput
where to write HTML option tag.item
-
-
renderListOption
public void renderListOption(MarkupOutput out, WebDisplayUnit item, boolean isComplexAnswer)
Renders HTML option tag populated with data from WebDisplayUnit instance.
It parses WebDisplayUnit item in order to get data to be used when creating HTML option tag. It uses HTMLHelper to create HTML option. It selects given HTML option if item isn't marked as selected and prompt answer isn't complex.- Parameters:
out
-MarkupOutput
where to write HTML option tag.item
-WebDisplayUnit
data structure where necessary data is obtained.isComplexAnswer
- boolean true if prompt answer is complex.- Since:
- MicroStrategy Web 8.0.0
-
isNoneOptionRendered
protected boolean isNoneOptionRendered()
Indicates whether or not 'none' options needs to be rendered as part of the available list.- Returns:
- true if '-none-' is to be displayed
-
initializeCss
public void initializeCss()
Initialize the CSS information to be used by this transform.
It invokes parent method so shared CSS get initialized as well.- Overrides:
initializeCss
in classAbstractPromptObjectTransform
- Since:
- MicroStrategy Web 8.0.0
-
isAnswerComplex
public boolean isAnswerComplex()
Determines 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 classAbstractPromptObjectTransform
- 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 typeEnumWebPromptType.WebPromptTypeObjects
orEnumWebPromptType.WebPromptTypeElements
- Specified by:
canTransform
in interfaceTransform
- Overrides:
canTransform
in classAbstractTransform
- Parameters:
data
- objectPromptObject
to transform- Returns:
- true if the data is a
PromptObject
of a ExpressionWebPrompt
.
-
setExtraArguments
protected void setExtraArguments()
Sets extra arguments for this prompt.
These arguments will be render later as hidden inputs.- Overrides:
setExtraArguments
in classAbstractPromptObjectTransform
-
getDescription
public java.lang.String getDescription()
This transforms description.- Specified by:
getDescription
in interfaceTransform
- Returns:
- the description of the listbox.
-
-