public class

CartExpressionImpl

extends CartImpl
implements CartExpression

java.lang.Object
↳	com.microstrategy.web.app.gui.AbstractGuiElement
	↳	com.microstrategy.web.app.gui.CartImpl
		↳	com.microstrategy.web.app.gui.CartExpressionImpl

Known Direct Subclasses

TreeCartExpressionImpl

Class Overview

Title: CartExpressionImpl.

Description: CartExpressionImpl abstraction it renders an HMTL "shopping cart" style for Expression type outputs of the Cart output.

Company: Microstrategy, Inc.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.web.app.gui.CartExpression

From interface com.microstrategy.web.app.gui.EnumCartProperties

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 ExpressionHelper.INCLUDE_ARGUMENT_VALUE indicates that the value is Include option ExpressionHelper.EXCLUDE_ARGUMENT_VALUE indicates that the value is Exclude option
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

[Expand]

Inherited Fields

From class com.microstrategy.web.app.gui.AbstractGuiElement

Public Constructors
	CartExpressionImpl() CartExpression constructor, initialize all expression cart properties.

Public Methods
GGCalendar	getCalendar() Function used for returning instance of calendar object `GGCalendar`.
int	getSelectedSize() Returns the number of User selections.
void	initializeCart() InitializeCart, for initializing all Cart properties to default values.
boolean	isCalendarAvailable() Function that check whether calendar object is enabled or not.
void	renderAvailable(MarkupOutput out, Enumeration availableItems) renderAvailable, function that abstracts Available output.
void	renderButtonNextInput(MarkupOutput out) renderButtonNextInput is used to render a button next to the input textbox
void	renderCart(MarkupOutput out, Enumeration availableItems, Enumeration selectedItems) renderCart, function that abstracts standard Cart output.
void	renderExpression(MarkupOutput out) renderExpression is used for rendering group of elements that conform the input and operator in Expression cart
void	renderIncludeExcludeOption(MarkupOutput out) Function that outputs the Include/Exclude option.
void	renderInput(MarkupOutput out) renderInput, function that outputs qualification value textbox.
void	renderMatch(MarkupOutput out) renderMatch, function that outputs AND / OR match output.
void	renderOperators(MarkupOutput out) renderOperators, function that outputs operators pull-down.
void	renderSelected(MarkupOutput out, Enumeration items) renderSelected, function that abstracts Selected output.
void	setCalendar(GGCalendar calendar) setCalendar is used for setting calendar object
String	toString() Function that returns class name

Protected Methods
WebAttributeForms	getAttributeForms(WebAttribute attribute) Returns collection of attribute forms.
PromptExpressionTransform	getExpressionTransform() Function creates instance of prompt expression transform once.
void	renderCalendarScript(MarkupOutput out, String inputArg) Renders the Javascript for the DHTML calendar

[Expand]

Inherited Methods

From class com.microstrategy.web.app.gui.CartImpl

From class com.microstrategy.web.app.gui.AbstractGuiElement

From class java.lang.Object

From interface com.microstrategy.web.app.gui.Cart

abstract Object	getProperty(String key) Function for getting Cart properties `EnumCartProperties` current values.
abstract void	initializeCart() InitializeCart, for initializing all Cart properties to default values.
abstract void	renderActionImage(MarkupOutput out, String[] jsFunction, String name, String imageClass, String title) Dsiplays an image that the user will be enabled to click on and submit a request.
abstract void	renderAdd(MarkupOutput out) Displays add HTML image arrow button.
abstract void	renderAddAll(MarkupOutput out) Displays add all HTML image arrow button.
abstract void	renderAvailable(MarkupOutput out, Enumeration items) This function will display available list of units for a given prompt question.
abstract void	renderAvailable(MarkupOutput out, CartElements items) This function will display available list of units defined in `CartElements` collection.
abstract void	renderCart(MarkupOutput out, Enumeration availableItems, Enumeration selectedItems) Function that abstracts standard Cart output.
abstract void	renderCart(MarkupOutput out, CartElements availableItems, CartElements selectedItems) Function that abstracts standard Cart output.
abstract void	renderDown(MarkupOutput out) Displays move down HTML image arrow button.
abstract void	renderIncrementalFetch(MarkupOutput out) Function that renders incremental fetch abstraction.
abstract void	renderLabel(MarkupOutput out, String labelName, String forValue) Function for displaying HTML labels.
abstract void	renderLabel(MarkupOutput out, String labelName) Function for displaying HTML labels.
abstract void	renderMatchCase(MarkupOutput out) Function that outputs AND / OR match output HTML radio button.
abstract void	renderRemove(MarkupOutput out) Displays remove HTML image arrow button.
abstract void	renderRemoveAll(MarkupOutput out) Displays remove all HTML image arrow button.
abstract void	renderSearch(MarkupOutput out) Function that renders search HTML output.
abstract void	renderSearchButton(MarkupOutput out) Function called by renderSeach function.
abstract void	renderSearchField(MarkupOutput out) Function called by renderSearch function.
abstract void	renderSelected(MarkupOutput out, CartElements items) This function will display selected list of units defined in `CartElements` collection.
abstract void	renderSelected(MarkupOutput out, Enumeration items) This function will display selected list of units for a given prompt question.
abstract void	renderUp(MarkupOutput out) Displays move up HTML image arrow button.
abstract void	setEnabled(boolean flag) Function for enabling or disabling the interaction scripts on the cart rendering.
abstract void	setHideWaitPageFlag(boolean flag) Function for making sure javascript code for hiding wait page is appended to add/remove image buttons
abstract void	setProperty(String key, Object obj) Function for initializing individual Cart properties `EnumCartProperties` to given values.

From interface com.microstrategy.web.app.gui.CartExpression

abstract GGCalendar	getCalendar() Function used for returning instance of calendar object `GGCalendar`.
abstract int	getSelectedSize() Gets the current number of selected elements in the cart.
abstract boolean	isCalendarAvailable() Function that check whether calendar object is enabled or not.
abstract void	renderButtonNextInput(MarkupOutput out) Render a button next to the input textbox
abstract void	renderExpression(MarkupOutput out) This function is used for rendering group of elements that conform the input and operator in Expression cart
abstract void	renderIncludeExcludeOption(MarkupOutput out) Function that outputs the Include/Exclude option.
abstract void	renderInput(MarkupOutput out) Function that renders qualification value HTML textbox.This is where users enters qualification values.
abstract void	renderMatch(MarkupOutput out) Function that outputs AND / OR match output HTML radio button.
abstract void	renderOperators(MarkupOutput out) Function used for rendering supported operators HTML pull-down list.
abstract void	setCalendar(GGCalendar calendar) Function used for setting calendar object `GGCalendar`.

From interface com.microstrategy.web.app.gui.GuiElement

abstract AppContext	getAppContext() Get the `AppContext` instance used by this element
abstract String	getDescriptor(String key) Get the descriptor associated with the string key given
abstract String	getDescriptor(int key) Get the descriptor associated with the numeric key given
abstract EventManager	getEventManager() get the `EventManager` object associated with this gui element
abstract String	getExtraInput() get extra input info for the gui element
abstract String	getExtraUrl() get extra url info for the gui element
abstract WebFeatures	getFeatures() Get the `WebFeatures` instance used by this element
abstract Messages	getMessages() Get the `Messages` instance used by this element
abstract String	getName() Get the name property of this GUI element
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract WebComponent	getWebComponent() Get the `WebComponent` instance used by this element
abstract boolean	renderElement(MarkupOutput out)
abstract MarkupOutput	renderElement() Render the GUI Element represented by this instance
abstract void	setAppContext(AppContext value) Set the `AppContext` instance to be used by this element
abstract void	setExtraInput(String newValue) set extra input info for the gui element
abstract void	setExtraUrl(String newValue) set extra url info for the gui element
abstract void	setName(String editorName) Set the name property of this GUI element
abstract void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output
abstract void	setWebComponent(WebComponent value) Set the `WebComponent` instance to be used by this element

Public Constructors

public CartExpressionImpl ()

CartExpression constructor, initialize all expression cart properties.

Public Methods

public GGCalendar getCalendar ()

Function used for returning instance of calendar object GGCalendar.

Returns

GGCalendar calendar instance.

public int getSelectedSize ()

Returns the number of User selections.

Returns

int size of selected elements

public void initializeCart ()

InitializeCart, for initializing all Cart properties to default values.

public boolean isCalendarAvailable ()

Function that check whether calendar object is enabled or not.

Returns

true if calendar is available.

public void renderAvailable (MarkupOutput out, Enumeration availableItems)

renderAvailable, function that abstracts Available output.

Parameters

out	where to write the output of the method.
availableItems	argument Name for generating Event output.

public void renderButtonNextInput (MarkupOutput out)

renderButtonNextInput is used to render a button next to the input textbox

Parameters

out	where to write the output of the method.

public void renderCart (MarkupOutput out, Enumeration availableItems, Enumeration selectedItems)

renderCart, function that abstracts standard Cart output.

Parameters

out	where to write the output of the method.
availableItems	enumeration of all available items
selectedItems	enumeration of all selected items

public void renderExpression (MarkupOutput out)

renderExpression is used for rendering group of elements that conform the input and operator in Expression cart

Parameters

out	where to write the output of the method.

public void renderIncludeExcludeOption (MarkupOutput out)

Function that outputs the Include/Exclude option.

Parameters

out	where to write the output of the method.

public void renderInput (MarkupOutput out)

renderInput, function that outputs qualification value textbox.

Parameters

out	where to write the output of the method.

public void renderMatch (MarkupOutput out)

renderMatch, function that outputs AND / OR match output.

Parameters

out	where to write the output of the method.

public void renderOperators (MarkupOutput out)

renderOperators, function that outputs operators pull-down.

Parameters

out	where to write the output of the method.

public void renderSelected (MarkupOutput out, Enumeration items)

renderSelected, function that abstracts Selected output.

Parameters

out	where to write the output of the method.
items	enumeration of all selected items

public void setCalendar (GGCalendar calendar)

setCalendar is used for setting calendar object

Parameters

calendar	GGCalendar instance.

public String toString ()

Function that returns class name

Returns

class name

Protected Methods

protected WebAttributeForms getAttributeForms (WebAttribute attribute)

Returns collection of attribute forms.
It reads property EXPAND_ATTRIBUTE_FORMS_TYPE which indicates what attribute's forms collection to be returned: All forms, Template forms or Browse forms.

Parameters

attribute	WebAttribute from which specific forms collection will be obtained.

Returns

WebAttributeForms collection

protected PromptExpressionTransform getExpressionTransform ()

Function creates instance of prompt expression transform once.

Returns

PromptExpressionTransform

protected void renderCalendarScript (MarkupOutput out, String inputArg)

Renders the Javascript for the DHTML calendar

Interfaces

Classes

CartExpressionImpl

Class Overview

Summary

Public Constructors

public CartExpressionImpl ()

Public Methods

public GGCalendar getCalendar ()

Returns

public int getSelectedSize ()

Returns

public void initializeCart ()

public boolean isCalendarAvailable ()

Returns

public void renderAvailable (MarkupOutput out, Enumeration availableItems)

Parameters

public void renderButtonNextInput (MarkupOutput out)

Parameters

public void renderCart (MarkupOutput out, Enumeration availableItems, Enumeration selectedItems)

Parameters

public void renderExpression (MarkupOutput out)

Parameters

public void renderIncludeExcludeOption (MarkupOutput out)

Parameters

See Also

public void renderInput (MarkupOutput out)

Parameters

public void renderMatch (MarkupOutput out)

Parameters

public void renderOperators (MarkupOutput out)

Parameters

public void renderSelected (MarkupOutput out, Enumeration items)

Parameters

public void setCalendar (GGCalendar calendar)

Parameters

public String toString ()

Returns

Protected Methods

protected WebAttributeForms getAttributeForms (WebAttribute attribute)

Parameters

Returns

protected PromptExpressionTransform getExpressionTransform ()

Returns

protected void renderCalendarScript (MarkupOutput out, String inputArg)