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 |
![]() |
Renders a hierarhical prompt in "shopping cart" style.
This transforms makes use of Tag
instances to render HTML output.
See reference to TagsFactory
.
The output of this Transform generates well-formed XHTML, supports layout-xml,
and it's designed to use
external css files for all formatting.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | ARGUMENT_PANE_QUALIFY | Constant indicating that 'Qualify' tab is active. | |||||||||
int | ARGUMENT_PANE_SELECT | Constant indicating that 'Select' tab is active. | |||||||||
int | ARGUMENT_PANE_STATUS | Constant indicating argument Id for Tab's status value. | |||||||||
int | ARGUMENT_ROOT_FOLDER_BROWSE_ID | Argument Id for folder browser event. | |||||||||
String | NONE_VALUE | Default text for 'None' value to be used in Pull-down menus. | |||||||||
int | PANE_QUALIFY | ||||||||||
int | PANE_SELECT | Constans denoting possible Hierarchical Web states. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected 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 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. | |||||||||
public FormalParameter | attributeSearchRequired | Indicates whether or not a search is required for displaying attribute elements. | |||||||||
public FormalParameter | isQualifyAvailable | Indicates if qualification pane is available. | |||||||||
public FormalParameter | showAttributeSelection | Specifies whether or not to show or hide the Attribute Selection dropdown for hierarchical prompts. | |||||||||
public FormalParameter | showEntryPointSelectBox | Specifies whether or not to show the entry point select box for hierarchical prompts. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PromptHierarchicalCartXHTMLTransform()
Default no-args constructor, initialize all the formal parameters.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean |
areThereAvailableSelections()
Indicates whether or not there are available items in collection.
| ||||||||||
WebDisplayUnits |
getAttributeElementList()
Returns list of all elements defined in selected attribute.
| ||||||||||
WebDisplayUnits |
getAvailableDisplayUnits()
Returns an enumeration with the available items to display as part of the cart information.
| ||||||||||
CartExpression |
getCartHelper()
Returns instance of cart helper object.
| ||||||||||
Enumeration |
getDrillList()
Returns collection for Drilling list.
| ||||||||||
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.
| ||||||||||
void |
initializeCart()
Initializes this transform's
CartExpression 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()
This method is 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.
| ||||||||||
boolean |
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.
| ||||||||||
void |
rederSearch(MarkupOutput out)
This method is deprecated.
Use
renderSearch(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 Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void |
cleanHierarchyList()
Filters out hierarchy list by eliminating any item different to a
WebDimension . | ||||||||||
Enumeration |
filterAttributesList(WebDisplayUnits list)
Filters out attribute's list.
| ||||||||||
String |
getArgumentName(int argumentId)
Returns an argument name for the given id.
| ||||||||||
String |
getAttributeFormattedValue(WebDisplayUnit attribute)
Returns formatted string to be passed as request parameter.
| ||||||||||
Enumeration |
getAvailableItems()
Returns an enumeration with the available items to display as part of the cart information.
| ||||||||||
String |
getErrorMessage(WebBeanError promptError)
Return localized error message, associated with the
WebBeanError code. | ||||||||||
boolean |
hasAccessGranted(WebObjectInfo objInfo)
Indicates whether or not current user has access granted to given WebObjectInfo instance.
| ||||||||||
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. | ||||||||||
boolean |
isQualifyAvailable()
Returns true isQualifyAvailable FormalParameter is true and the expression is not
a SAP Expression.
| ||||||||||
boolean |
isSAPExpression()
Check whether the prompt is a SAP Expression Prompt
| ||||||||||
void |
processAvailableItems()
Initializes the avaialble units to be displayed in available pull-down.
| ||||||||||
void |
processHierarchicalSubFolders()
Parses hierarchy sub folder list and initialize collection for its rendering.
| ||||||||||
void |
processIncrementalFetch()
Initializes incremental fetching settings.
| ||||||||||
boolean |
validateItemForDrillingList(WebDisplayUnit item)
Indicates whether or not given item is a valid item to be appended to Drilling list.
| ||||||||||
boolean |
validateItemsList(SimpleList items)
This method is deprecated.
not used anymore. Use
validateItemForDrillingList(WebDisplayUnit) for individual items in drilling list.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constant indicating that 'Qualify' tab is active.
Value denoted by argument ARGUMENT_PANE_STATUS
in request compared
against this constant will indicate this transform that current tab is
'Qualify'.
Constant indicating that 'Select' tab is active.
Value denoted by argument ARGUMENT_PANE_STATUS
in request compared
against this constant will indicate this transform that current tab is
'Select'.
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.
Argument Id for folder browser event.
Default text for 'None' value to be used in Pull-down menus.
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.
Collection of WebNode which is the current prompt answer.
Current collection of attributes defined in active Hierarchy object.
CartExpression
instance used for storing and rendering information regarding this prompt options and answers.
Current collection of items defined in Drilling list.
Current collection of elements defined in active Attribute object.
Indicates origin object.
Object used for determining hierarchy list folder.
Indicates which pane mode is selected.
It defaults to PANE_SELECT.
Class variable that specifies a flag indicating whether or not to show hierarchical sub folders
in pull-down menu.
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.
Specifies whether or not to show or hide the Attribute Selection dropdown for hierarchical prompts.
This flag is used as a boolean value.
Specifies whether or not to show the entry point select box for hierarchical prompts.
This flag is used as a boolean value.
Default no-args constructor, initialize all the formal parameters.
Indicates whether or not there are available items in collection.
Returns False
when
selections are less or equal to zero.
True
if available selection is greater than zero.
Returns list of all elements defined in selected attribute.
WebDisplayUnits
instance
Returns an enumeration with the available items to display as part of the cart information.
WebDisplayUnits
instance with the available list of items.
Returns instance of cart helper object.
CartExpression
instance corresponding to this transform.
Returns collection for Drilling list.
Returns the first highlighted item found.
units | WebDisplayUnits instance with all the items available |
---|
WebDisplayUnit
corresponding to the one being highlighted.
Returns the first non-highlighted entry point found.
units | WebDisplayUnits instance with all the items available |
---|
WebDisplayUnit
corresponding to a not highlighted entry point.
Returns the first non-highlighted item found.
units | WebDisplayUnits instance with all the items available |
---|
WebDisplayUnit
corresponding to a not-highlighted item.
Returns instance of active hierarchy list of attributes.
WebDisplayUnits
instance.
Returns instance of active hierarchy attribute.
WebDisplayUnit
instance.
Initializes this transform's CartExpression
instance properties to the default values
required.
Initialize the css information to be used by this transform.
Initializes the elements to be displayed in drill-to list.
WebObjectsException} if an error happens while the drill information is initialized. | |
WebObjectsException |
Initializes prompt content.
Extends the initializePromptContent
by reading from the RequestKeys
the current
attribute qualification type.
WebObjectsException} if an error happens while the prompt is initialized. | |
WebObjectsException |
Indicates whether or not search is required before listing selected attribute's elements.
Associated to Hierarchical prompt style where search is required.
Indicates if the attribute information will remain visible for this cart's display.
True
if the attribute information should be
included on the HTML output for the user.
Indicates if the tab control buttons (for allowing users to switch from Select to Qualify)
will be visible.
True
if the button tab control information should be
included on the HTML output for the user.
This method is 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.
Indicates if the drill information and options will remain visible for this cart's display.
True
if the drill information should be
included on the HTML output for the user.
Indicates if the expression information and options will remain visible for this cart's display.
True
if the expression definition details should be
included on the HTML output for the user.
Indicates if folder information and browsing options will remain visible for this cart's display.
True
if the folder sbrowsing information should be
included on the HTML output for the user.
Indicates if the hierarchy information will remain visible when displaying Cart.
True
if the hierarchy information should be
included on the HTML output for the user.
Indicates if the search information and options will remain visible for this cart's display.
True
if the search information should be
included on the HTML output for the user.
Parses hierarchy list and creates all sub folder browsing in pull-down menu.
subFolders | WebDisplayUnits collection of subfolders |
---|---|
level | int value indicating indentation size. |
WebObjectsException} thrown likely when retrieving backend info. | |
WebObjectsException |
This method is deprecated.
Use renderSearch(MarkupOutput)
instead.
Renders search section.
It invokes renderSearch(MarkupOutput)
method which takes out parameter.
out | MarkupOutput where to write search section. |
---|
Renders the add button information for the cart.
It overwrites the parent renderAdd
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.
out | MarkupOutput instance where the HTML content generated by this method will be saved
|
---|
Renders the attribute information for this cart prompt according to the information
available.
If it is not enabled, then renderAttributeInformationDisabled(MarkupOutput)
will be called, if
no elements are available to display, renderEmptyAttributeList(MarkupOutput)
is executed,
otherwise renderAttributeInformationList
renders the information if applicable.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the attribute information combo box when is not yet available to the user.
since a hierarchy has not been pre-selected first.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the attribute information combo box corresponding to the hierarchy
previously selected.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the list of available objects on the cart.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the label that will go as header of the available list of objects on the cart.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the tab control buttons which allow the user to switch from Select to Qualify
- if allowed - when defining the prompt answers.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
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 of DIV
HTML tags created.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the drill information and options section.
It is consisted of a header label and then it calls
the renderElementListDrillInformation(MarkupOutput)
method, plus
its corresponding submit button.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the list of attribute elements to be shown as available to the user.
If none is available, messages indicate so.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders drilling item pull-down menu.
Update the CartExpression
instance with the information for the available drilling options
and call for its renderAvailable(MarkupOutput)
method for showing them to the user.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the HTML corresponding to an empty list of attributes.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
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.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders the hierarchy information of the prompt cart being displayed.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
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 the initCart
method, associated with the list of attribute selections.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Renders label for Input textbox.
It creates an HTML label to be displayed along with input textbox menu.
out | MarkupOutput where to write the Label.
|
---|
Renders the match information and options for this prompt.
out | MarkupOutput instance where the HTML content generated by this method will be saved
|
---|
Renders Operator label.
It creates an HTML label to be displayed along with operators pull-down menu.
out | MarkupOutput where to write the Label.
|
---|
Renders hidden inputs for Web GUI specific actions.
It adds new argument for Pane Status.
out | MarkupOutput where to write hidden inputs. |
---|
Renders the hidden inputs of this prompt.
The inputs are retrieved from the answer event.
out | the transform output |
---|
Renders prompt's default answer defininiton.
It displays default answer without any promtp question form.
out | the transform output |
---|
Renders the remove button information for the cart.
It overwrites the parent renderRemove
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.
out | MarkupOutput instance where the HTML content generated by this method will be saved
|
---|
Renders search section.
It invokes renderSearch(MarkupOutput)
method which takes out parameter.
out | MarkupOutput where to write search section. |
---|
Renders the selected list of answers given for this prompt.
out | MarkupOutput instance where the output HTML will be stored.
|
---|
Filters out hierarchy list by eliminating any item different to a WebDimension
.
Filters out attribute's list.
It removes from list thos attributes which user doesn't have access granted.
list | WebDisplayUnits list of attributes |
---|
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
argumentId | the id of the argument to process |
---|
Returns formatted string to be passed as request parameter.
It parses attribute parameter in order to create a formatted text of its name.
attribute | to be parsed. |
---|
Returns an enumeration with the available items to display as part of the cart information.
Calls getAvailableDisplayUnits
.
Return localized error message, associated with the WebBeanError
code.
promptError | instance of WebBeanError , most likely an validation error thrown in process prompt phase. |
---|
String
, localized to active language.
Indicates whether or not current user has access granted to given WebObjectInfo instance.
objInfo | WebObjectInfo instance which user is validated against |
---|
This method is deprecated.
This method has been deprecated since this is specific to expression prompts.
Use the method on AbstractPromptExpressionTransform.
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 overrides isNodeComplex
by supporting
expressions of type 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 calls super.isNodeComplex
to check if the expression is normally supported by attribute qualification
node | the root node of the subexpression to check |
---|
True
if the Node is complex, that is, it cannot be created using this transform.
Returns true isQualifyAvailable FormalParameter is true and the expression is not a SAP Expression.
Check whether the prompt is a SAP Expression Prompt
EnumDSSXMLExpressionType.DssXmlExpressionMDXSAPVariable
Initializes the avaialble units to be displayed in available pull-down.
WebObjectsException} if an error happens while the available item list information is obtained. | |
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.
WebObjectsException} when highlighting WebDisplayUnit instances.
|
|
WebObjectsException |
Initializes incremental fetching settings.
Overrides processIncrementalFetch
since hierarchical prompts gets the available items in a different schema.
WebObjectsException} if an error happens while the incremental fetch information is defined. | |
WebObjectsException |
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).
item | WebDisplayUnit item being validated. |
---|
This method is deprecated.
not used anymore. Use validateItemForDrillingList(WebDisplayUnit)
for individual items in drilling list.
Verifies that for each item in collection, end-user has priviliges to access it.
items | SimpleList collection of item to be validated. |
---|