Class PromptHierarchicalCartXHTMLTransform
- 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.PromptCartXHTMLTransform
-
- com.microstrategy.web.app.transforms.PromptExpressionCartXHTMLTransform
-
- com.microstrategy.web.app.transforms.PromptHierarchicalCartXHTMLTransform
-
- All Implemented Interfaces:
EnumPromptsBeanEvents
,LayoutTransform
,Transform
- Direct Known Subclasses:
PromptHierarchicalTreeXHTMLTransform
public class PromptHierarchicalCartXHTMLTransform extends PromptExpressionCartXHTMLTransform
Renders a hierarhical prompt in "shopping cart" style.
This transforms makes use ofTag
instances to render HTML output. See reference toTagsFactory
. The output of this Transform generates well-formed XHTML, supports layout-xml, and it's designed to use external css files for all formatting.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Enumeration
_answers
Collection of WebNode which is the current prompt answer.protected WebDisplayUnit
_attribute
Indicates current active attribute instance.protected WebDisplayUnits
_attributeList
Current collection of attributes defined in active Hierarchy object.protected CartExpression
_cartHelper
CartExpression
instance used for storing and rendering information regarding this prompt options and answers.protected java.util.Enumeration
_drillList
Current collection of items defined in Drilling list.protected WebDisplayUnits
_elementList
Current collection of elements defined in active Attribute object.protected WebDisplayUnit
_hierarchy
Indicates current active hierarchy object.protected WebDisplayUnits
_hierarchyList
Current collection of hierarchies defined in Prompt.protected WebObjectInfo
_origin
Indicates origin object.protected int
_selectedPane
Indicates which pane mode is selected.protected boolean
_showHierarchicalSubFolders
Class variable that specifies a flag indicating whether or not to show hierarchical sub folders in pull-down menu.protected static int
ARGUMENT_PANE_QUALIFY
Constant indicating that 'Qualify' tab is active.protected static int
ARGUMENT_PANE_SELECT
Constant indicating that 'Select' tab is active.protected static int
ARGUMENT_PANE_STATUS
Constant indicating argument Id for Tab's status value.protected static int
ARGUMENT_ROOT_FOLDER_BROWSE_ID
Argument Id for folder browser event.FormalParameter
attributeSearchRequired
Indicates whether or not a search is required for displaying attribute elements.FormalParameter
isQualifyAvailable
Indicates if qualification pane is available.protected static java.lang.String
NONE_VALUE
Default text for 'None' value to be used in Pull-down menus.protected static int
PANE_QUALIFY
protected static int
PANE_SELECT
Constans denoting possible Hierarchical Web states.FormalParameter
showAttributeSelection
Specifies whether or not to show or hide the Attribute Selection dropdown for hierarchical prompts.FormalParameter
showEntryPointSelectBox
Specifies whether or not to show the entry point select box for hierarchical prompts.-
Fields inherited from class com.microstrategy.web.app.transforms.PromptExpressionCartXHTMLTransform
loadFileSeparator, logicalOperatorAvailableUserDefined, logicalOperatorDefault, logicalOperatorSelectionMethod, truncateUploadedAnswersDisplay, truncateUploadedAnswersDisplaySize
-
Fields inherited from class com.microstrategy.web.app.transforms.PromptCartXHTMLTransform
_imgBlank, availableSize, matchCase, searchAvailable, selectedSize
-
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 PromptHierarchicalCartXHTMLTransform()
Default no-args constructor, initialize all the formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
areThereAvailableSelections()
Indicates whether or not there are available items in collection.protected void
cleanHierarchyList()
Filters out hierarchy list by eliminating any item different to aWebDimension
.protected java.util.Enumeration
filterAttributesList(WebDisplayUnits list)
Filters out attribute's list.protected java.lang.String
getArgumentName(int argumentId)
Returns an argument name for the given id.WebDisplayUnits
getAttributeElementList()
Returns list of all elements defined in selected attribute.protected java.lang.String
getAttributeFormattedValue(WebDisplayUnit attribute)
Returns formatted string to be passed as request parameter.WebDisplayUnits
getAvailableDisplayUnits()
Returns an enumeration with the available items to display as part of the cart information.protected java.util.Enumeration
getAvailableItems()
Returns an enumeration with the available items to display as part of the cart information.CartExpression
getCartHelper()
Returns instance of cart helper object.java.util.Enumeration
getDrillList()
Returns collection for Drilling list.protected java.lang.String
getErrorMessage(WebBeanError promptError)
Return localized error message, associated with theWebBeanError
code.WebDisplayUnit
getFirstHighlightedItem(WebDisplayUnits units)
Returns the first highlighted item found.WebDisplayUnit
getFirstNonHighlightedEntryPoint(WebDisplayUnits units)
Returns the first non-highlighted entry point found.WebDisplayUnit
getFirstNonHighlightedItem(WebDisplayUnits units)
Returns the first non-highlighted item found.WebDisplayUnits
getHierarchyAttributeList()
Returns instance of active hierarchy list of attributes.WebDisplayUnit
getSelectedAttribute()
Returns instance of active hierarchy attribute.protected boolean
hasAccessGranted(WebObjectInfo objInfo)
Indicates whether or not current user has access granted to given WebObjectInfo instance.void
initializeCart()
Initializes this transform'sCartExpression
instance properties to the default values required.void
initializeCss()
Initialize the css information to be used by this transform.void
initializeDrillList()
Initializes the elements to be displayed in drill-to list.void
initializePromptContent()
Initializes prompt content.boolean
isAttributeElementSearchRequired()
Indicates whether or not search is required before listing selected attribute's elements.boolean
isAttributeInformationVisible()
Indicates if the attribute information will remain visible for this cart's display.boolean
isButtonTabControlVisible()
Indicates if the tab control buttons (for allowing users to switch from Select to Qualify) will be visible.boolean
isDrillButtonEnabled()
Deprecated.This method is no longer used in the application as we do not disable the button.boolean
isDrillVisible()
Indicates if the drill information and options will remain visible for this cart's display.boolean
isExpressionVisible()
Indicates if the expression information and options will remain visible for this cart's display.boolean
isFolderInformationVisible()
Indicates if folder information and browsing options will remain visible for this cart's display.boolean
isHierarchyInformationVisible()
Indicates if the hierarchy information will remain visible when displaying Cart.protected boolean
isNodeComplex(WebNode node)
Indicates if a single subexpression denoted by a WebNode instance is complex.protected boolean
isQualifyAvailable()
Returns true isQualifyAvailable FormalParameter is true and the expression is not a SAP Expression.protected boolean
isSAPExpression()
Check whether the prompt is a SAP Expression Promptboolean
isSearchVisible()
Indicates if the search information and options will remain visible for this cart's display.void
parserHierarchicalSubFolderCollection(WebDisplayUnits subFolders, int level)
Parses hierarchy list and creates all sub folder browsing in pull-down menu.protected void
processAvailableItems()
Initializes the avaialble units to be displayed in available pull-down.protected void
processHierarchicalSubFolders()
Parses hierarchy sub folder list and initialize collection for its rendering.protected void
processIncrementalFetch()
Initializes incremental fetching settings.void
rederSearch(MarkupOutput out)
Deprecated.UserenderSearch(MarkupOutput)
instead.void
renderAdd(MarkupOutput out)
Renders the add button information for the cart.void
renderAttributeInformation(MarkupOutput out)
Renders the attribute information for this cart prompt according to the information available.void
renderAttributeInformationDisabled(MarkupOutput out)
Renders the attribute information combo box when is not yet available to the user.void
renderAttributeInformationList(MarkupOutput out)
Renders the attribute information combo box corresponding to the hierarchy previously selected.void
renderAvailable(MarkupOutput out)
Renders the list of available objects on the cart.void
renderAvailableHeaderContent(MarkupOutput out)
Renders the label that will go as header of the available list of objects on the cart.void
renderButtonTabControl(MarkupOutput out)
Renders the tab control buttons which allow the user to switch from Select to Qualify - if allowed - when defining the prompt answers.void
renderCart(MarkupOutput out)
Renders a hierarchical shopping cart output by calling different methods that will render the individual sections of the prompt layout.void
renderDrillInformation(MarkupOutput out)
Renders the drill information and options section.void
renderElementList(MarkupOutput out)
Renders the list of attribute elements to be shown as available to the user.void
renderElementListDrillInformation(MarkupOutput out)
Renders drilling item pull-down menu.void
renderEmptyAttributeList(MarkupOutput out)
Renders the HTML corresponding to an empty list of attributes.void
renderFolderInformation(MarkupOutput out)
Renders Folder pull-down menu.void
renderHierarchyInformation(MarkupOutput out)
Renders the hierarchy information of the prompt cart being displayed.void
renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch information for the cart available list.void
renderInputLabel(MarkupOutput out)
Renders label for Input textbox.void
renderMatch(MarkupOutput out)
Renders the match information and options for this prompt.void
renderOperatorLabel(MarkupOutput out)
Renders Operator label.void
renderPromptHiddenInput(MarkupOutput out)
Renders hidden inputs for Web GUI specific actions.void
renderPromptHiddenInputs(MarkupOutput out)
Renders the hidden inputs of this prompt.void
renderPromptSummary(MarkupOutput out)
Renders prompt's default answer defininiton.void
renderRemove(MarkupOutput out)
Renders the remove button information for the cart.void
renderSearch(MarkupOutput out)
Renders search section.void
renderSelected(MarkupOutput out)
Renders the selected list of answers given for this prompt.protected boolean
validateItemForDrillingList(WebDisplayUnit item)
Indicates whether or not given item is a valid item to be appended to Drilling list.protected boolean
validateItemsList(SimpleList items)
Deprecated.not used anymore.-
Methods inherited from class com.microstrategy.web.app.transforms.PromptExpressionCartXHTMLTransform
areUPandDownButtonsAvailable, canTransform, checkLogicalOperatorMethod, createCartExpression, getAnswer, getAttributeForms, getCart, getCartExpression, getDescription, getSelectedItems, isAnswerComplex, isCalendarAvailable, isCart, isExpressionAFilter, isExpressionAMetric, isInputFromTextFile, isNextInputButtonAvailable, processSelectedItems, renderAvailableLabel, renderCalendarButton, renderInputTextFile, renderNextInputButton, renderOperators, renderPromptContent, renderQualificationInputBox
-
Methods inherited from class com.microstrategy.web.app.transforms.PromptCartXHTMLTransform
createCart, getSearchPattern, initializeFormalParameters, initializeImages, isIncrementalFetchAvailable, isSearchActive, isSearchAvailable, isSearchPossible, isUpDownArrowsAvailable, onBeforeApplyDefaultDisplaySettings, renderAddAll, renderDown, renderLabel, renderLabel, renderRemoveAll, renderUp, setExtraArguments, supports, supports, updateIncrementalFetchCartProperties
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
getDimtyAsString, getDimtyAttributesAsString, getOutputLevel, isBrowserIE6, isMQLevelEditingSupported, isNodeDimtyEmpty, renderHiddenInputsForMQEditor, renderOutputLevelLabel, setMetricQualOutputLevelAndDimty
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
addFormalParameter, arePromptsLoadedFirstTime, checkLevel, getAnswerEvent, getAttrElemBlockCount, getCalendar, getContainerServices, getDescriptor, getDescriptor, getDescriptor, getDimensionAttribute, getDisplayHelper, getIntValue, getLocale, getMatchCaseSensitivity, getMultipleEvent, getMultipleEventArgumentString, getObjectsBlockCount, getPrompt, getPromptsAppContext, getPromptsBean, getPromptsList, getRequestKeys, getShowRequired, getStringValue, getSupportedBeanType, getTagsFactory, hasAnswer, initializePromptObject, isBackToTopAnchorEnabled, isDhtmlMode, isDimensionalPrompt, isForDefinition, isIFrameRequest, isItemKeptInCartAvailable, isLocked, isLockedForSearch, isPromptObjectInitialized, isPromptRequired, isPromptSummaryEnabled, isTrue, isXDA_CustomSQL_Report, isXDA_MDX_Report, isXDAReport, newHiddenInputBuilder, newNamespaceEncoder, renderLayout, renderMinMaxHiddenValues, renderPromptAnswerMeaning, renderPromptBackToTopAnchor, renderPromptDefaultAnswer, renderPromptErrorMessage, renderPromptIFrameRequest, renderPromptMeaning, renderPromptNoSelectionsAvailable, renderPromptNotAnswered, renderPromptQuestion, renderPromptRestrictions, 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
-
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, transform
-
-
-
-
Field Detail
-
_origin
protected WebObjectInfo _origin
Indicates origin object.
Object used for determining hierarchy list folder.
-
_hierarchy
protected WebDisplayUnit _hierarchy
Indicates current active hierarchy object.
-
_attribute
protected WebDisplayUnit _attribute
Indicates current active attribute instance.
-
_hierarchyList
protected WebDisplayUnits _hierarchyList
Current collection of hierarchies defined in Prompt.
-
_attributeList
protected WebDisplayUnits _attributeList
Current collection of attributes defined in active Hierarchy object.
-
_elementList
protected WebDisplayUnits _elementList
Current collection of elements defined in active Attribute object.
-
_drillList
protected java.util.Enumeration _drillList
Current collection of items defined in Drilling list.
-
_answers
protected java.util.Enumeration _answers
Collection of WebNode which is the current prompt answer.
-
PANE_SELECT
protected static final int PANE_SELECT
Constans denoting possible Hierarchical Web states.
PANE_SELECT corresponds to mode of listing items and allowing end-user to select them. PANE_QUALIFY corresponds to GUI mode where end-user are expected to create their own qualifications.- See Also:
- Constant Field Values
-
PANE_QUALIFY
protected static final int PANE_QUALIFY
- See Also:
- Constant Field Values
-
_selectedPane
protected int _selectedPane
Indicates which pane mode is selected.
It defaults to PANE_SELECT.
-
ARGUMENT_PANE_STATUS
protected static final int ARGUMENT_PANE_STATUS
Constant indicating argument Id for Tab's status value.
In order to get request value, it's required to provide an argument Id which is associated to an argument name in the request.- See Also:
- Constant Field Values
-
ARGUMENT_PANE_SELECT
protected static final int ARGUMENT_PANE_SELECT
Constant indicating that 'Select' tab is active.
Value denoted by argumentARGUMENT_PANE_STATUS
in request compared against this constant will indicate this transform that current tab is 'Select'.- See Also:
- Constant Field Values
-
ARGUMENT_PANE_QUALIFY
protected static final int ARGUMENT_PANE_QUALIFY
Constant indicating that 'Qualify' tab is active.
Value denoted by argumentARGUMENT_PANE_STATUS
in request compared against this constant will indicate this transform that current tab is 'Qualify'.- See Also:
- Constant Field Values
-
ARGUMENT_ROOT_FOLDER_BROWSE_ID
protected static final int ARGUMENT_ROOT_FOLDER_BROWSE_ID
Argument Id for folder browser event.- See Also:
- Constant Field Values
-
_showHierarchicalSubFolders
protected boolean _showHierarchicalSubFolders
Class variable that specifies a flag indicating whether or not to show hierarchical sub folders in pull-down menu.
-
_cartHelper
protected CartExpression _cartHelper
CartExpression
instance used for storing and rendering information regarding this prompt options and answers.
-
NONE_VALUE
protected static final java.lang.String NONE_VALUE
Default text for 'None' value to be used in Pull-down menus.- See Also:
- Constant Field Values
-
isQualifyAvailable
public FormalParameter isQualifyAvailable
Indicates if qualification pane is available.
-
showAttributeSelection
public FormalParameter showAttributeSelection
Specifies whether or not to show or hide the Attribute Selection dropdown for hierarchical prompts.
This flag is used as a boolean value.
-
attributeSearchRequired
public FormalParameter attributeSearchRequired
Indicates whether or not a search is required for displaying attribute elements.
FP associated to Hierarchical prompt style and it is applied when search is required before displaying current highlighted attribute elements.
-
showEntryPointSelectBox
public FormalParameter showEntryPointSelectBox
Specifies whether or not to show the entry point select box for hierarchical prompts.
This flag is used as a boolean value.
-
-
Method Detail
-
initializeCss
public void initializeCss()
Initialize the css information to be used by this transform.- Overrides:
initializeCss
in classPromptExpressionCartXHTMLTransform
-
initializePromptContent
public void initializePromptContent() throws WebObjectsException
Initializes prompt content.
Extends theinitializePromptContent
by reading from theRequestKeys
the current attribute qualification type.- Overrides:
initializePromptContent
in classPromptCartXHTMLTransform
- Throws:
WebObjectsException
- if an error happens while the prompt is initialized.
-
validateItemsList
protected boolean validateItemsList(SimpleList items)
Deprecated.not used anymore. UsevalidateItemForDrillingList(WebDisplayUnit)
for individual items in drilling list.Verifies that for each item in collection, end-user has priviliges to access it.- Parameters:
items
- SimpleList collection of item to be validated.- Returns:
- boolean true if user has access priviliges to all items.
-
validateItemForDrillingList
protected boolean validateItemForDrillingList(WebDisplayUnit item)
Indicates whether or not given item is a valid item to be appended to Drilling list.
It checks if the user has access to given item (attribute).- Parameters:
item
- WebDisplayUnit item being validated.- Returns:
- boolean true if user has access granted to given item.
- Since:
- MicroStrategy Web 8.0.1
-
initializeDrillList
public void initializeDrillList() throws WebObjectsException
Initializes the elements to be displayed in drill-to list.- Throws:
WebObjectsException
-
initializeCart
public void initializeCart()
Initializes this transform'sCartExpression
instance properties to the default values required.- Overrides:
initializeCart
in classPromptExpressionCartXHTMLTransform
-
processIncrementalFetch
protected void processIncrementalFetch() throws WebObjectsException
Initializes incremental fetching settings.
OverridesprocessIncrementalFetch
since hierarchical prompts gets the available items in a different schema.- Overrides:
processIncrementalFetch
in classPromptExpressionCartXHTMLTransform
- Throws:
WebObjectsException
- needs to be handled.
-
processHierarchicalSubFolders
protected void processHierarchicalSubFolders() throws WebObjectsException
Parses hierarchy sub folder list and initialize collection for its rendering.
It parses hierarchy list and constructs a collection of sub folders to be displayed.- Throws:
WebObjectsException
-
parserHierarchicalSubFolderCollection
public void parserHierarchicalSubFolderCollection(WebDisplayUnits subFolders, int level) throws WebObjectsException
Parses hierarchy list and creates all sub folder browsing in pull-down menu.- Parameters:
subFolders
- WebDisplayUnits collection of subfolderslevel
- int value indicating indentation size.- Throws:
WebObjectsException
-
processAvailableItems
protected void processAvailableItems() throws WebObjectsException
Initializes the avaialble units to be displayed in available pull-down.- Overrides:
processAvailableItems
in classPromptExpressionCartXHTMLTransform
- Throws:
WebObjectsException
- if an error happens while processing the information.
-
isNodeComplex
protected boolean isNodeComplex(WebNode node)
Indicates if a single subexpression denoted by a WebNode instance is complex.
An expression is complex if it cannot be created using the Web interface.
This method overridesisNodeComplex
by supporting expressions of typeEnumDSSXMLExpressionType.DssXmlFilterListQual
(element list expressions). It also checks if the styles supports attribute qualification, if it doesn't all other type of expressions are also considered complex, if it does, then it callssuper.isNodeComplex
to check if the expression is normally supported by attribute qualification- Overrides:
isNodeComplex
in classAbstractPromptExpressionTransform
- Parameters:
node
- the root node of the subexpression to check- Returns:
True
if the Node is complex, that is, it cannot be created using this transform.
-
areThereAvailableSelections
public boolean areThereAvailableSelections()
Indicates whether or not there are available items in collection.
ReturnsFalse
when selections are less or equal to zero.- Overrides:
areThereAvailableSelections
in classPromptCartXHTMLTransform
- Returns:
- boolean
True
if available selection is greater than zero.
-
isHierarchyInformationVisible
public boolean isHierarchyInformationVisible()
Indicates if the hierarchy information will remain visible when displaying Cart.- Returns:
- boolean
True
if the hierarchy information should be included on the HTML output for the user.
-
isButtonTabControlVisible
public boolean isButtonTabControlVisible()
Indicates if the tab control buttons (for allowing users to switch from Select to Qualify) will be visible.- Returns:
- boolean
True
if the button tab control information should be included on the HTML output for the user.
-
isAttributeInformationVisible
public boolean isAttributeInformationVisible()
Indicates if the attribute information will remain visible for this cart's display.- Returns:
- boolean
True
if the attribute information should be included on the HTML output for the user.
-
isAttributeElementSearchRequired
public boolean isAttributeElementSearchRequired()
Indicates whether or not search is required before listing selected attribute's elements.
Associated to Hierarchical prompt style where search is required.- Returns:
- boolean true when search is required.
-
isSearchVisible
public boolean isSearchVisible()
Indicates if the search information and options will remain visible for this cart's display.- Returns:
- boolean
True
if the search information should be included on the HTML output for the user.
-
isDrillVisible
public boolean isDrillVisible()
Indicates if the drill information and options will remain visible for this cart's display.- Returns:
- boolean
True
if the drill information should be included on the HTML output for the user.
-
isExpressionVisible
public boolean isExpressionVisible()
Indicates if the expression information and options will remain visible for this cart's display.- Returns:
- boolean
True
if the expression definition details should be included on the HTML output for the user.
-
isFolderInformationVisible
public boolean isFolderInformationVisible()
Indicates if folder information and browsing options will remain visible for this cart's display.- Returns:
- boolean
True
if the folder sbrowsing information should be included on the HTML output for the user.
-
getArgumentName
protected java.lang.String getArgumentName(int argumentId)
Returns an argument name for the given id.
Since the argument name depends on the PromptPosition, this method automatically returns the argument corresponding to the current Prompt- Overrides:
getArgumentName
in classAbstractPromptObjectTransform
- Parameters:
argumentId
- the id of the argument to process- Returns:
- the full argument name for the given id to use
-
getAttributeFormattedValue
protected java.lang.String getAttributeFormattedValue(WebDisplayUnit attribute)
Returns formatted string to be passed as request parameter.
It parses attribute parameter in order to create a formatted text of its name.- Parameters:
attribute
- to be parsed.- Returns:
- String formatted text.
-
cleanHierarchyList
protected void cleanHierarchyList()
Filters out hierarchy list by eliminating any item different to aWebDimension
.
-
getErrorMessage
protected java.lang.String getErrorMessage(WebBeanError promptError)
Return localized error message, associated with theWebBeanError
code.- Overrides:
getErrorMessage
in classPromptCartXHTMLTransform
- Parameters:
promptError
- instance ofWebBeanError
, most likely an validation error thrown in process prompt phase.- Returns:
- error message as
String
, localized to active language.
-
getAvailableItems
protected java.util.Enumeration getAvailableItems()
Returns an enumeration with the available items to display as part of the cart information.
CallsgetAvailableDisplayUnits
.- Overrides:
getAvailableItems
in classPromptCartXHTMLTransform
- Returns:
Enumeration
with the available list of items.
-
getAvailableDisplayUnits
public WebDisplayUnits getAvailableDisplayUnits()
Returns an enumeration with the available items to display as part of the cart information.- Overrides:
getAvailableDisplayUnits
in classAbstractPromptObjectTransform
- Returns:
WebDisplayUnits
instance with the available list of items.
-
hasAccessGranted
protected boolean hasAccessGranted(WebObjectInfo objInfo)
Indicates whether or not current user has access granted to given WebObjectInfo instance.- Parameters:
objInfo
- WebObjectInfo instance which user is validated against- Returns:
- boolean true if user can access given WebObjectInfo instance.
-
getFirstHighlightedItem
public WebDisplayUnit getFirstHighlightedItem(WebDisplayUnits units)
Returns the first highlighted item found.- Parameters:
units
-WebDisplayUnits
instance with all the items available- Returns:
WebDisplayUnit
corresponding to the one being highlighted.
-
getFirstNonHighlightedEntryPoint
public WebDisplayUnit getFirstNonHighlightedEntryPoint(WebDisplayUnits units)
Returns the first non-highlighted entry point found.- Parameters:
units
-WebDisplayUnits
instance with all the items available- Returns:
WebDisplayUnit
corresponding to a not highlighted entry point.
-
getFirstNonHighlightedItem
public WebDisplayUnit getFirstNonHighlightedItem(WebDisplayUnits units)
Returns the first non-highlighted item found.- Parameters:
units
-WebDisplayUnits
instance with all the items available- Returns:
WebDisplayUnit
corresponding to a not-highlighted item.
-
getCartHelper
public CartExpression getCartHelper()
Returns instance of cart helper object.- Returns:
CartExpression
instance corresponding to this transform.
-
getHierarchyAttributeList
public WebDisplayUnits getHierarchyAttributeList()
Returns instance of active hierarchy list of attributes.- Returns:
WebDisplayUnits
instance.
-
getSelectedAttribute
public WebDisplayUnit getSelectedAttribute()
Returns instance of active hierarchy attribute.- Returns:
WebDisplayUnit
instance.
-
getAttributeElementList
public WebDisplayUnits getAttributeElementList()
Returns list of all elements defined in selected attribute.- Returns:
WebDisplayUnits
instance
-
getDrillList
public java.util.Enumeration getDrillList()
Returns collection for Drilling list.- Returns:
Enumeration
instance with the drilling items.
-
renderPromptHiddenInputs
public void renderPromptHiddenInputs(MarkupOutput out)
Renders the hidden inputs of this prompt.
The inputs are retrieved from the answer event.- Overrides:
renderPromptHiddenInputs
in classAbstractPromptExpressionTransform
- Parameters:
out
- the transform output
-
renderPromptHiddenInput
public void renderPromptHiddenInput(MarkupOutput out)
Renders hidden inputs for Web GUI specific actions.
It adds new argument for Pane Status.- Parameters:
out
- MarkupOutput where to write hidden inputs.
-
renderPromptSummary
public void renderPromptSummary(MarkupOutput out)
Renders prompt's default answer defininiton.
It displays default answer without any promtp question form.- Overrides:
renderPromptSummary
in classAbstractPromptObjectTransform
- Parameters:
out
- the transform output
-
renderIncrementalFetch
public void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch information for the cart available list.
Overwrites the parent method by not updating the incremental fetch information before rendering it since it has been already defined on theinitCart
method, associated with the list of attribute selections.- Overrides:
renderIncrementalFetch
in classPromptCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderHierarchyInformation
public void renderHierarchyInformation(MarkupOutput out)
Renders the hierarchy information of the prompt cart being displayed.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderAttributeInformationDisabled
public void renderAttributeInformationDisabled(MarkupOutput out)
Renders the attribute information combo box when is not yet available to the user.
since a hierarchy has not been pre-selected first.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderAttributeInformationList
public void renderAttributeInformationList(MarkupOutput out)
Renders the attribute information combo box corresponding to the hierarchy previously selected.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
filterAttributesList
protected java.util.Enumeration filterAttributesList(WebDisplayUnits list)
Filters out attribute's list.
It removes from list thos attributes which user doesn't have access granted.- Parameters:
list
- WebDisplayUnits list of attributes- Returns:
- Enumeration filtered list of attributes.
-
renderAttributeInformation
public void renderAttributeInformation(MarkupOutput out)
Renders the attribute information for this cart prompt according to the information available.
If it is not enabled, thenrenderAttributeInformationDisabled(MarkupOutput)
will be called, if no elements are available to display,renderEmptyAttributeList(MarkupOutput)
is executed, otherwiserenderAttributeInformationList
renders the information if applicable.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderButtonTabControl
public void renderButtonTabControl(MarkupOutput out)
Renders the tab control buttons which allow the user to switch from Select to Qualify - if allowed - when defining the prompt answers.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderCart
public void renderCart(MarkupOutput out)
Renders a hierarchical shopping cart output by calling different methods that will render the individual sections of the prompt layout.
The output is organized with a series ofDIV
HTML tags created.- Overrides:
renderCart
in classPromptExpressionCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderOperatorLabel
public void renderOperatorLabel(MarkupOutput out)
Renders Operator label.
It creates an HTML label to be displayed along with operators pull-down menu.- Overrides:
renderOperatorLabel
in classPromptExpressionCartXHTMLTransform
- Parameters:
out
-MarkupOutput
where to write the Label.
-
renderInputLabel
public void renderInputLabel(MarkupOutput out)
Renders label for Input textbox.
It creates an HTML label to be displayed along with input textbox menu.- Parameters:
out
-MarkupOutput
where to write the Label.
-
rederSearch
public void rederSearch(MarkupOutput out)
Deprecated.UserenderSearch(MarkupOutput)
instead.Renders search section.
It invokesCart.renderSearch(MarkupOutput)
method which takes out parameter.- Parameters:
out
-MarkupOutput
where to write search section.
-
renderSearch
public void renderSearch(MarkupOutput out)
Renders search section.
It invokesCart.renderSearch(MarkupOutput)
method which takes out parameter.- Overrides:
renderSearch
in classPromptCartXHTMLTransform
- Parameters:
out
-MarkupOutput
where to write search section.- Since:
- MicroStrategy Web 8.0.2
-
renderAvailableHeaderContent
public void renderAvailableHeaderContent(MarkupOutput out)
Renders the label that will go as header of the available list of objects on the cart.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderAvailable
public void renderAvailable(MarkupOutput out)
Renders the list of available objects on the cart.- Overrides:
renderAvailable
in classPromptCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderEmptyAttributeList
public void renderEmptyAttributeList(MarkupOutput out)
Renders the HTML corresponding to an empty list of attributes.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderElementList
public void renderElementList(MarkupOutput out)
Renders the list of attribute elements to be shown as available to the user.
If none is available, messages indicate so.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderDrillInformation
public void renderDrillInformation(MarkupOutput out)
Renders the drill information and options section.
It is consisted of a header label and then it calls therenderElementListDrillInformation(MarkupOutput)
method, plus its corresponding submit button.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
isDrillButtonEnabled
public boolean isDrillButtonEnabled()
Deprecated.This method is no longer used in the application as we do not disable the button.Determines whether or not Drill 'Go' button is enabled when rendering it.
It makes sure there are available selections in order to enable this button.- Returns:
- boolean true if there's at least one item to be selected in Elements list.
- Since:
- MicroStrategy Web 8.0.1
-
renderElementListDrillInformation
public void renderElementListDrillInformation(MarkupOutput out)
Renders drilling item pull-down menu.
Update theCartExpression
instance with the information for the available drilling options and call for itsrenderAvailable(MarkupOutput)
method for showing them to the user.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderFolderInformation
public void renderFolderInformation(MarkupOutput out)
Renders Folder pull-down menu.
Obtain and render folder information that gives the option from where to obtain the hierarchies to be available for the prompt.- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderSelected
public void renderSelected(MarkupOutput out)
Renders the selected list of answers given for this prompt.- Overrides:
renderSelected
in classPromptCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the output HTML will be stored.
-
renderAdd
public void renderAdd(MarkupOutput out)
Renders the add button information for the cart.
It overwrites the parentrenderAdd
method by initializing specific JavaScript code associated with the button depending on what the user is adding: a qualification or the selection of a single element.- Overrides:
renderAdd
in classPromptCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the HTML content generated by this method will be saved
-
renderRemove
public void renderRemove(MarkupOutput out)
Renders the remove button information for the cart.
It overwrites the parentrenderRemove
method by initializing specific JavaScript code associated with the button depending on what the user is deleting: a qualification or the selection of a single element.- Overrides:
renderRemove
in classPromptCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the HTML content generated by this method will be saved
-
renderMatch
public void renderMatch(MarkupOutput out)
Renders the match information and options for this prompt.- Overrides:
renderMatch
in classPromptExpressionCartXHTMLTransform
- Parameters:
out
-MarkupOutput
instance where the HTML content generated by this method will be saved
-
isSAPExpression
protected boolean isSAPExpression()
Check whether the prompt is a SAP Expression Prompt- Returns:
- true if the Prompt's ExpressionType is
EnumDSSXMLExpressionType.DssXmlExpressionMDXSAPVariable
- Since:
- MicroStrategy Web 8.0.1
-
isQualifyAvailable
protected boolean isQualifyAvailable()
Returns true isQualifyAvailable FormalParameter is true and the expression is not a SAP Expression.- Returns:
- whether the Qualify Section is Available
- Since:
- MicroStrategy Web 8.0.1
-
-