com.microstrategy.web.app.gui.EnumCartProperties |
![]() |
Title: EnumCartProperties.
Description: EnumCartProperties interface. It lists all available Cart's properties.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | ADD_ALL_AND_REMOVE_ALL_AVAILABLE |
This constant is deprecated.
Please use ADD_ALL_AVAILABLE and REMOVE_ALL_AVAILABLE instead. |
|||||||||
String | ADD_ALL_ARGUMENT | Add All image button argument name. | |||||||||
String | ADD_ALL_ARGUMENT_VALUE | Indicates the value for the add argument | |||||||||
String | ADD_ALL_AVAILABLE | indicates whether add all is available | |||||||||
String | ADD_ALL_CSS_IMAGE | Argument name for add image button CSS class information | |||||||||
String | ADD_ALL_IMAGE | Argument name for add all image button source information | |||||||||
String | ADD_ALL_JS_FUNCTION | Array holding, javascript function and arguments for adding elements into selected list from available list. | |||||||||
String | ADD_ARGUMENT | Add image button argument name. | |||||||||
String | ADD_ARGUMENT_VALUE | Indicates the value for the add argument | |||||||||
String | ADD_BLANK_OPTION | Flag indicatin whether or not to add blank entry in selected and available lists. | |||||||||
String | ADD_CSS_IMAGE | Argument name for add image button CSS class information | |||||||||
String | ADD_DBL_CLICK_JS_FUNCTION | Array holding, javascript function and arguments for adding with double click action elements into selected list from available list. | |||||||||
String | ADD_DISABLED | indicates whether add is Disabled | |||||||||
String | ADD_IMAGE | Argument name for add image button source information | |||||||||
String | ADD_JS_FUNCTION | Array holding, javascript function and arguments for adding elements into selected list from available list. | |||||||||
String | APPLIES_TO | Property related with the bone that will represent the cart on JavaScript. | |||||||||
String | AVAILABLEITEMS_AVAILABLE | Flag indicating whether we should show the abailable items This flag is used only for the attributes form cart currently | |||||||||
String | AVAILABLE_ARGUMENT | Available list argument name. | |||||||||
String | AVAILABLE_ATTR_FORM_DISPLAY_TYPE | Indicates cart which kind of form to display in Available list. | |||||||||
String | AVAILABLE_LABEL | Label description for available list | |||||||||
String | AVAILABLE_LIST_SECTION_IDENTIFIER | Indicates the identifier the div HTML tag holding the available list
section on the cart will have |
|||||||||
String | AVAILABLE_SIZE | Size of list for available items | |||||||||
String | AVAILABLE_STYLE | Style specification for the available list | |||||||||
String | BLANK_OPTION_VALUE | Value for blank option entry. | |||||||||
String | BUTTON_NEXT_INPUT_ARGUMENT | Argument for the button next to the input box | |||||||||
String | BUTTON_NEXT_INPUT_AVAILABLE | Flag indicating whether we should show a button next to the input text box | |||||||||
String | BUTTON_NEXT_INPUT_JS_FUNCTION | Javascript to run when the button next to the input box is clicked | |||||||||
String | BUTTON_NEXT_INPUT_LABEL | Label for the button next to the input box | |||||||||
String | CART_EXPRESSION | Instance to expression object | |||||||||
String | CART_INDEX | Index use for giving unique identity to cart objects rendered in page. | |||||||||
String | CHANGE_JS_FUNCTION | Array holding, javascript function and arguments for changing the hierarchy in the available items list. | |||||||||
String | CLEAR_SEARCH_URL | Indicates the URL for the clear search event. | |||||||||
String | CMD_ID | Property related with the bone that will represent the cart on JavaScript. | |||||||||
String | CSS_PREFIX | String with prefix to use on CSS classes of tags generated by this Cart. | |||||||||
String | CUSTOM_ATTRIBUTE_FORMS | Indicates the list of custom attribute forms to be displayed in the cart. | |||||||||
String | DEFAULT_VALUE | Value for default entry | |||||||||
String | DISABLE_ID_FROM_SELECTED_BOX | Indicate that IDs can not be moved from the selected box to the available box. | |||||||||
String | DISABLE_OPERATORS_BASED_ON_DATATYPE_IN_ATTR_QUAL | Indicates whether or not to append JS functionality that disables certain list of operators (in pull-down) based on Attribute's form datatype. | |||||||||
String | DOWN_ARGUMENT | Down image button argument name. | |||||||||
String | DOWN_ARGUMENT_VALUE | Indicates the value for the Down argument | |||||||||
String | DOWN_CSS_IMAGE | Argument name for down image button CSS class information | |||||||||
String | DOWN_IMAGE | Argument name for down image button source information | |||||||||
String | EVENT_URL | String that contains an event url to include in the cart. | |||||||||
String | EXCLUDE_ARGUMENT_LABEL | Indicates the label name to be used in the Cart for displaying Exclude option | |||||||||
String | EXPAND_ATTRIBUTE_FORMS | Flag indicating that all attribute forms must be populated in order to retrieve all its information. | |||||||||
String | EXPAND_ATTRIBUTE_FORMS_TYPE | Flag indicating indicating which type of forms to expand. | |||||||||
String | EXPRESSION_VALUE_SEPARATOR | Indicates a separator charactor to be used when creating expression value. | |||||||||
String | FIND_ARGUMENT | Find image button argument name. | |||||||||
String | FIND_ARGUMENT_VALUE | Indicates the value for the find argument | |||||||||
String | FIND_CSS_IMAGE | Argument name for find (search) image button CSS class information | |||||||||
String | FIND_IMAGE | Argument name for find (search) image button source information | |||||||||
String | HIDDEN_ATTRIBUTE_FORMS | Indicates the list of attribute forms to be hidden in the cart. | |||||||||
String | INCLUDE_ARGUMENT_LABEL | Indicates the label name to be used in the Cart for displaying Include option | |||||||||
String | INCLUDE_EXCLUDE_ARGUMENT_NAME | Indicates the argument name to be used in the Cart for displaying Include/Exclude options | |||||||||
String | INCLUDE_EXCLUDE_ARGUMENT_VALUE | Indicates the argument value to be used in the Cart for displaying Include/Exclude options
The allowed values are
|
|||||||||
String | INCLUDE_EXCLUDE_AVAILABLE | Indicates whether the Cart will display Include/Exclude options | |||||||||
String | INCLUDE_INFO_EXP_SELECTED_LIST | Indicates whether or not to include extre infor in each selected list entry. | |||||||||
String | INCREMENTAL_FETCH | Instance of the Incremental fetch object | |||||||||
String | INCREMENTAL_FETCH_AVAILABLE | Flag indicating whether incremental fetch functionality is enabled or not. | |||||||||
String | INPUT_ARGUMENT | Argument name for textfield used for entering qualification values. | |||||||||
String | INPUT_LABEL | Label description for Input qualification section | |||||||||
String | INPUT_SIZE | Size for Input textfield | |||||||||
String | INPUT_VALUE | Value for textfield used for entering qualification values. | |||||||||
String | MATCH_CASE_ARGUMENT | Match case radio button argument name. | |||||||||
String | MATCH_CASE_AVAILABLE | Flag indicating whether match case functionality is enabled or not. | |||||||||
String | MATCH_CASE_CHECKED | Flag indicating match case checkbox is checked or not. | |||||||||
String | MATCH_CASE_LABEL | Label description for match case section | |||||||||
String | MATCH_CASE_VALUE | Value of match case checkbox. | |||||||||
String | MATCH_OR_AND_ARGUMENT | Argument name for Match case radio button | |||||||||
String | MATCH_OR_AND_ARGUMENT_VALUE | Match case current value checked. | |||||||||
String | MATCH_OR_AND_AVAILABLE | Argument name for enabling Match case radio button | |||||||||
String | MAX_SEARCH_SIZE | Maximum characters allowed for textfield where search criteria is entered. | |||||||||
String | MOVE_DOWN_JS_FUNCTION | Array holding, javascript function and arguments for moving font names down in the selected list. | |||||||||
String | MOVE_UP_JS_FUNCTION | Array holding, javascript function and arguments for moving font names up in the selected list. | |||||||||
String | MULTI_SELECT | Flag indicating whether lists for available and selected have multiselect feature on or off | |||||||||
String | OPERATORS_ON_CHANGE_JS_FUNCTION | Array holding, javascript function and arguments to be invoked when operator list changes. | |||||||||
String | OPERATOR_ARGUMENT | Operator argument name. | |||||||||
String | OPERATOR_LABEL | Label description for Operator pull-down menu | |||||||||
String | OPERATOR_TYPE | Operator type, associated with function type | |||||||||
String | OPERATOR_VALUE | Current Operator ID selected | |||||||||
String | OPTION_TITLE | flag indicating whether each | |||||||||
String | OUTPUT_MODE | Determines whether DHTML is on or off | |||||||||
String | REMOVE_ALL_ARGUMENT | Remove image button argument name. | |||||||||
String | REMOVE_ALL_ARGUMENT_VALUE | Indicates the value for the remove argument | |||||||||
String | REMOVE_ALL_AVAILABLE | indicates whether remove all is available | |||||||||
String | REMOVE_ALL_CSS_IMAGE | Argument name for remove image button CSS class information | |||||||||
String | REMOVE_ALL_IMAGE | Argument name for remove all image button source information | |||||||||
String | REMOVE_ALL_JS_FUNCTION | Array holding, javascript function and arguments for removing elements from selected list into available list. | |||||||||
String | REMOVE_ARGUMENT | Remove image button argument name. | |||||||||
String | REMOVE_ARGUMENT_VALUE | Indicates the value for the remove argument | |||||||||
String | REMOVE_CSS_IMAGE | Argument name for remove image button CSS class information | |||||||||
String | REMOVE_DBL_CLICK_JS_FUNCTION | Array holding, javascript function and arguments for removing with double click action elements from selected list into available list. | |||||||||
String | REMOVE_DISABLED | indicates whether remove is Disabled | |||||||||
String | REMOVE_IMAGE | Argument name for remove image button source information | |||||||||
String | REMOVE_JS_FUNCTION | Array holding, javascript function and arguments for removing elements from selected list into available list. | |||||||||
String | RENDER_CART_CURTAIN | Indicates whether to render a curtain as the last child node of the CART
This curtain can then be toggled on/off by cart bone or other JS code |
|||||||||
String | RENDER_SELECTED_AS_TEXTBOX | Indicates the whether the selected items will be rendered as TextBox instead of the Select List | |||||||||
String | RESTRICTED_OPERATOR | Indicates the restricted operator to be used in the Cart. | |||||||||
String | SCRIPT_CLASS | Property related with the bone that will represent the cart on JavaScript. | |||||||||
String | SEARCH_ARGUMENT | Search textfield argument name. | |||||||||
String | SEARCH_AVAILABLE | Flag indicating whether search functionality is enabled or not. | |||||||||
String | SEARCH_FIELD_ENTER_BUTTON_JAVASCRIPT | Indicates whether pressing the enter button on the search field should invoke javascript to change focus to the search button. | |||||||||
String | SEARCH_LABEL | Label description for search section | |||||||||
String | SEARCH_SIZE | Size for textfield where search criteria is entered. | |||||||||
String | SEARCH_VALUE | Search pattern or criteria. | |||||||||
String | SELECTED_ARGUMENT | Selected list argument name. | |||||||||
String | SELECTED_CHANGE_JS_FUNCTION | Array holding, javascript function and arguments for changing the selected item in the selected box | |||||||||
String | SELECTED_CLICK_JS_FUNCTION | Array holding, javascript function and arguments for selecting an item in the selected box | |||||||||
String | SELECTED_LABEL | Label description for selected list | |||||||||
String | SELECTED_LIST_SECTION_IDENTIFIER | Indicates the identifier the div HTML tag holding the selected list
section on the cart will have |
|||||||||
String | SELECTED_SIZE | Size of list for selected items | |||||||||
String | SELECTED_STYLE | Style specification for the selected list | |||||||||
String | SHOW_CART_CURTAIN | Indicates whether to show the curtain after it is rendered |
|||||||||
String | SHOW_EMPTY_DESCRIPTOR | whether to show descriptor for empty selections.. | |||||||||
String | SWAP_JS_FUNCTION | ||||||||||
String | TREE_NAME | Name used to identify a tree box. | |||||||||
String | TRUNCATE_SELECT_LIST_DISPLAY_MODE | Indicates whether or not to truncate display output in cart Selected list. | |||||||||
String | TRUNCATE_SELECT_LIST_DISPLAY_SIZE | Indicate size to truncate display output. | |||||||||
String | UP_AND_DOWN_AVAILABLE | Flag indicating whether to display up and down arrows. | |||||||||
String | UP_ARGUMENT | Up image button argument name. | |||||||||
String | UP_ARGUMENT_VALUE | Indicates the value for the Up argument | |||||||||
String | UP_CSS_IMAGE | Argument name for up image button CSS class information | |||||||||
String | UP_IMAGE | Argument name for up image button source information | |||||||||
String | USE_DEFAULT | Flag indicating whether to display -Default- in selected list |
This constant is deprecated.
Please use ADD_ALL_AVAILABLE
and REMOVE_ALL_AVAILABLE
instead.
Flag indicating whether to display add all and remove all arrows.
Add All image button argument name.
Indicates the value for the add argument
indicates whether add all is available
Argument name for add image button CSS class information
Argument name for add all image button source information
Array holding, javascript function and arguments for adding elements into selected list from available list.
Add image button argument name.
Indicates the value for the add argument
Flag indicatin whether or not to add blank entry in selected and available lists.
Argument name for add image button CSS class information
Array holding, javascript function and arguments for adding with double click action elements into selected list from available list.
indicates whether add is Disabled
Argument name for add image button source information
Array holding, javascript function and arguments for adding elements into selected list from available list.
Property related with the bone that will represent the cart on JavaScript. Indicates to which other bone it will be attached to. Currently applicable only to TreeView
Flag indicating whether we should show the abailable items This flag is used only for the attributes form cart currently
Available list argument name.
Indicates cart which kind of form to display in Available list.
This formal parameter will only three possible values defined in CartExpression interface:
Label description for available list
Indicates the identifier the div
HTML tag holding the available list
section on the cart will have
Size of list for available items
Style specification for the available list
Value for blank option entry.
Argument for the button next to the input box
Flag indicating whether we should show a button next to the input text box
Javascript to run when the button next to the input box is clicked
Label for the button next to the input box
Instance to expression object
Index use for giving unique identity to cart objects rendered in page.
Array holding, javascript function and arguments for changing the hierarchy in the available items list.
Indicates the URL for the clear search event.
Property related with the bone that will represent the cart on JavaScript. Indicates the identifier of the command that will be triggered on the 'appliesTo' bone related with the cart. Currently applicable only to TreeView
String with prefix to use on CSS classes of tags generated by this Cart.
Indicates the list of custom attribute forms to be displayed in the cart.
Would be used only when the value of EXPAND_ATTRIBUTE_FORMS_TYPE
is set to
WebDisplayedFormsCustom
Value for default entry
Indicate that IDs can not be moved from the selected box to the available box.
Indicates whether or not to append JS functionality that disables certain list of operators (in pull-down) based on Attribute's form datatype. Numerical forms don't support operators such as 'Contains' because these are Text-specific.
Down image button argument name.
Indicates the value for the Down argument
Argument name for down image button CSS class information
Argument name for down image button source information
String that contains an event url to include in the cart.
Indicates the label name to be used in the Cart for displaying Exclude option
Flag indicating that all attribute forms must be populated in order to retrieve all its information. SQL might be triggered if this flag is true.
Flag indicating indicating which type of forms to expand.
It could be any of the values defined in EnumWebDisplayedForms enumeration.
Indicates a separator charactor to be used when creating expression value.
Normally, when uploading multiple answers for an Expression prompt, a different separator
might be specified (customized); hence, it's required to format answer values with
custom separator so it gets processed accordingly.
Find image button argument name.
Indicates the value for the find argument
Argument name for find (search) image button CSS class information
Argument name for find (search) image button source information
Indicates the list of attribute forms to be hidden in the cart.
Indicates the label name to be used in the Cart for displaying Include option
Indicates the argument name to be used in the Cart for displaying Include/Exclude options
Indicates the argument value to be used in the Cart for displaying Include/Exclude options The allowed values are
Indicates whether the Cart will display Include/Exclude options
Indicates whether or not to include extre infor in each selected list entry.
Each option in selected list might include in its html tag properties defining expression type,
attribute or metric Id, attribute form Id, operator Id, value.
Only available in CartExpression objects.
Instance of the Incremental fetch object
Flag indicating whether incremental fetch functionality is enabled or not.
Argument name for textfield used for entering qualification values.
Label description for Input qualification section
Size for Input textfield
Value for textfield used for entering qualification values.
Match case radio button argument name.
Flag indicating whether match case functionality is enabled or not.
Flag indicating match case checkbox is checked or not.
Label description for match case section
Value of match case checkbox.
Argument name for Match case radio button
Match case current value checked.
Argument name for enabling Match case radio button
Maximum characters allowed for textfield where search criteria is entered.
Array holding, javascript function and arguments for moving font names down in the selected list.
Array holding, javascript function and arguments for moving font names up in the selected list.
Flag indicating whether lists for available and selected have multiselect feature on or off
Array holding, javascript function and arguments to be invoked when operator list changes.
Operator argument name.
Label description for Operator pull-down menu
Operator type, associated with function type
Current Operator ID selected
flag indicating whether each
Determines whether DHTML is on or off
Remove image button argument name.
Indicates the value for the remove argument
indicates whether remove all is available
Argument name for remove image button CSS class information
Argument name for remove all image button source information
Array holding, javascript function and arguments for removing elements from selected list into available list.
Remove image button argument name.
Indicates the value for the remove argument
Argument name for remove image button CSS class information
Array holding, javascript function and arguments for removing with double click action elements from selected list into available list.
indicates whether remove is Disabled
Argument name for remove image button source information
Array holding, javascript function and arguments for removing elements from selected list into available list.
Indicates whether to render a curtain
Indicates the whether the selected items will be rendered as TextBox instead of the Select List
Indicates the restricted operator to be used in the Cart.
Property related with the bone that will represent the cart on JavaScript. Indicates which type of bone it will generated for it. Currently applicable only to TreeView
Search textfield argument name.
Flag indicating whether search functionality is enabled or not.
Indicates whether pressing the enter button on the search field should invoke javascript to change focus to the search button. (thus handling the enter key press)
Label description for search section
Size for textfield where search criteria is entered.
Search pattern or criteria. Value displayed in textfield.
Selected list argument name.
Array holding, javascript function and arguments for changing the selected item in the selected box
Array holding, javascript function and arguments for selecting an item in the selected box
Label description for selected list
Indicates the identifier the div
HTML tag holding the selected list
section on the cart will have
Size of list for selected items
Style specification for the selected list
Indicates whether to show the curtain
whether to show descriptor for empty selections..
Name used to identify a tree box.
Indicates whether or not to truncate display output in cart Selected list.
Indicate size to truncate display output.
Flag indicating whether to display up and down arrows.
Up image button argument name.
Indicates the value for the Up argument
Argument name for up image button CSS class information
Argument name for up image button source information
Flag indicating whether to display -Default- in selected list