Package com.microstrategy.web.app.gui
Class CartExpressionImpl
- java.lang.Object
-
- com.microstrategy.web.app.gui.AbstractGuiElement
-
- com.microstrategy.web.app.gui.CartImpl
-
- com.microstrategy.web.app.gui.CartExpressionImpl
-
- All Implemented Interfaces:
Cart,CartExpression,EnumCartProperties,GuiElement
- Direct Known Subclasses:
TreeCartExpressionImpl
public class CartExpressionImpl extends CartImpl implements CartExpression
Title: CartExpressionImpl.
Description: CartExpressionImpl abstraction it renders an HMTL "shopping cart" style for Expression type outputs of the Cart output.
Copyright: Copyright (c) 2002
Company: Microstrategy, Inc.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement
_appContext, _name, _webComponent
-
Fields inherited from interface com.microstrategy.web.app.gui.CartExpression
DISPLAY_ALL_ATTR_FORMS, DISPLAY_ATTR_NON_ID_FORMS, DISPLAY_ONLY_ATTR_ID_FORMS
-
Fields inherited from interface com.microstrategy.web.app.gui.EnumCartProperties
ADD_ALL_AND_REMOVE_ALL_AVAILABLE, ADD_ALL_ARGUMENT, ADD_ALL_ARGUMENT_VALUE, ADD_ALL_AVAILABLE, ADD_ALL_CSS_IMAGE, ADD_ALL_IMAGE, ADD_ALL_JS_FUNCTION, ADD_ARGUMENT, ADD_ARGUMENT_VALUE, ADD_BLANK_OPTION, ADD_CSS_IMAGE, ADD_DBL_CLICK_JS_FUNCTION, ADD_DISABLED, ADD_IMAGE, ADD_JS_FUNCTION, APPLIES_TO, AVAILABLE_ARGUMENT, AVAILABLE_ATTR_FORM_DISPLAY_TYPE, AVAILABLE_LABEL, AVAILABLE_LIST_SECTION_IDENTIFIER, AVAILABLE_SIZE, AVAILABLE_STYLE, AVAILABLEITEMS_AVAILABLE, BLANK_OPTION_VALUE, BUTTON_NEXT_INPUT_ARGUMENT, BUTTON_NEXT_INPUT_AVAILABLE, BUTTON_NEXT_INPUT_JS_FUNCTION, BUTTON_NEXT_INPUT_LABEL, CART_EXPRESSION, CART_INDEX, CHANGE_JS_FUNCTION, CLEAR_SEARCH_URL, CMD_ID, CSS_PREFIX, CUSTOM_ATTRIBUTE_FORMS, DEFAULT_VALUE, DISABLE_ID_FROM_SELECTED_BOX, DISABLE_OPERATORS_BASED_ON_DATATYPE_IN_ATTR_QUAL, DOWN_ARGUMENT, DOWN_ARGUMENT_VALUE, DOWN_CSS_IMAGE, DOWN_IMAGE, EVENT_URL, EXCLUDE_ARGUMENT_LABEL, EXPAND_ATTRIBUTE_FORMS, EXPAND_ATTRIBUTE_FORMS_TYPE, EXPRESSION_VALUE_SEPARATOR, FIND_ARGUMENT, FIND_ARGUMENT_VALUE, FIND_CSS_IMAGE, FIND_IMAGE, HIDDEN_ATTRIBUTE_FORMS, INCLUDE_ARGUMENT_LABEL, INCLUDE_EXCLUDE_ARGUMENT_NAME, INCLUDE_EXCLUDE_ARGUMENT_VALUE, INCLUDE_EXCLUDE_AVAILABLE, INCLUDE_INFO_EXP_SELECTED_LIST, INCREMENTAL_FETCH, INCREMENTAL_FETCH_AVAILABLE, INPUT_ARGUMENT, INPUT_LABEL, INPUT_SIZE, INPUT_VALUE, MATCH_CASE_ARGUMENT, MATCH_CASE_AVAILABLE, MATCH_CASE_CHECKED, MATCH_CASE_LABEL, MATCH_CASE_VALUE, MATCH_OR_AND_ARGUMENT, MATCH_OR_AND_ARGUMENT_VALUE, MATCH_OR_AND_AVAILABLE, MAX_SEARCH_SIZE, MOVE_DOWN_JS_FUNCTION, MOVE_UP_JS_FUNCTION, MULTI_SELECT, OPERATOR_ARGUMENT, OPERATOR_LABEL, OPERATOR_TYPE, OPERATOR_VALUE, OPERATORS_ON_CHANGE_JS_FUNCTION, OPTION_TITLE, OUTPUT_MODE, REMOVE_ALL_ARGUMENT, REMOVE_ALL_ARGUMENT_VALUE, REMOVE_ALL_AVAILABLE, REMOVE_ALL_CSS_IMAGE, REMOVE_ALL_IMAGE, REMOVE_ALL_JS_FUNCTION, REMOVE_ARGUMENT, REMOVE_ARGUMENT_VALUE, REMOVE_CSS_IMAGE, REMOVE_DBL_CLICK_JS_FUNCTION, REMOVE_DISABLED, REMOVE_IMAGE, REMOVE_JS_FUNCTION, RENDER_CART_CURTAIN, RENDER_SELECTED_AS_TEXTBOX, RESTRICTED_OPERATOR, SCRIPT_CLASS, SEARCH_ARGUMENT, SEARCH_AVAILABLE, SEARCH_FIELD_ENTER_BUTTON_JAVASCRIPT, SEARCH_LABEL, SEARCH_SIZE, SEARCH_VALUE, SELECTED_ARGUMENT, SELECTED_CHANGE_JS_FUNCTION, SELECTED_CLICK_JS_FUNCTION, SELECTED_LABEL, SELECTED_LIST_SECTION_IDENTIFIER, SELECTED_SIZE, SELECTED_STYLE, SHOW_CART_CURTAIN, SHOW_EMPTY_DESCRIPTOR, SWAP_JS_FUNCTION, TREE_NAME, TRUNCATE_SELECT_LIST_DISPLAY_MODE, TRUNCATE_SELECT_LIST_DISPLAY_SIZE, UP_AND_DOWN_AVAILABLE, UP_ARGUMENT, UP_ARGUMENT_VALUE, UP_CSS_IMAGE, UP_IMAGE, USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description CartExpressionImpl()CartExpression constructor, initialize all expression cart properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected WebAttributeFormsgetAttributeForms(WebAttribute attribute)Returns collection of attribute forms.GGCalendargetCalendar()Function used for returning instance of calendar objectGGCalendar.protected PromptExpressionTransformgetExpressionTransform()Function creates instance of prompt expression transform once.intgetSelectedSize()Returns the number of User selections.voidinitializeCart()InitializeCart, for initializing all Cart properties to default values.booleanisCalendarAvailable()Function that check whether calendar object is enabled or not.voidrenderAvailable(MarkupOutput out, java.util.Enumeration availableItems)renderAvailable, function that abstracts Available output.voidrenderButtonNextInput(MarkupOutput out)renderButtonNextInput is used to render a button next to the input textboxprotected voidrenderCalendarScript(MarkupOutput out, java.lang.String inputArg)Renders the Javascript for the DHTML calendarvoidrenderCart(MarkupOutput out, java.util.Enumeration availableItems, java.util.Enumeration selectedItems)renderCart, function that abstracts standard Cart output.voidrenderExpression(MarkupOutput out)renderExpression is used for rendering group of elements that conform the input and operator in Expression cartvoidrenderIncludeExcludeOption(MarkupOutput out)Function that outputs the Include/Exclude option.voidrenderInput(MarkupOutput out)renderInput, function that outputs qualification value textbox.voidrenderMatch(MarkupOutput out)renderMatch, function that outputs AND / OR match output.voidrenderOperators(MarkupOutput out)renderOperators, function that outputs operators pull-down.voidrenderSelected(MarkupOutput out, java.util.Enumeration items)renderSelected, function that abstracts Selected output.voidsetCalendar(GGCalendar calendar)setCalendar is used for setting calendar objectjava.lang.StringtoString()Function that returns class name-
Methods inherited from class com.microstrategy.web.app.gui.CartImpl
addCartElement, generateAvailableCartElements, generateSelectedCartElements, getAddAllTitle, getAddTitle, getClickableDiv, getClickableSpan, getDownTitle, getProperty, getRemoveAllTitle, getRemoveTitle, getSelectTag, getTagsFactory, getUpTitle, renderActionImage, renderActionImage, renderAdd, renderAddAll, renderAddRemoveButtonsInCart, renderAvailable, renderAvailableItem, renderAvailableItem, renderCart, renderCartCurtain, renderCartDiv, renderDown, renderElement, renderGenericCart, renderIncrementalFetch, renderJavascriptFunction, renderLabel, renderLabel, renderMatchCase, renderRemove, renderRemoveAll, renderSearch, renderSearchButton, renderSearchDiv, renderSearchField, renderSelected, renderSelectedItem, renderSelectedItem, renderUp, setEnabled, setHideWaitPageFlag, setOptionTagTitle, setProperty
-
Methods inherited from class com.microstrategy.web.app.gui.AbstractGuiElement
getAppContext, getDescriptor, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, isDhtml, isIFrameEnabled, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.app.gui.Cart
getProperty, renderActionImage, renderAdd, renderAddAll, renderAvailable, renderCart, renderDown, renderIncrementalFetch, renderLabel, renderLabel, renderMatchCase, renderRemove, renderRemoveAll, renderSearch, renderSearchButton, renderSearchField, renderSelected, renderUp, setEnabled, setHideWaitPageFlag, setProperty
-
Methods inherited from interface com.microstrategy.web.app.gui.GuiElement
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent
-
-
-
-
Method Detail
-
initializeCart
public void initializeCart()
InitializeCart, for initializing all Cart properties to default values.- Specified by:
initializeCartin interfaceCart- Overrides:
initializeCartin classCartImpl
-
renderCart
public void renderCart(MarkupOutput out, java.util.Enumeration availableItems, java.util.Enumeration selectedItems)
renderCart, function that abstracts standard Cart output.- Specified by:
renderCartin interfaceCart- Overrides:
renderCartin classCartImpl- Parameters:
out- where to write the output of the method.availableItems- enumeration of all available itemsselectedItems- enumeration of all selected items
-
renderAvailable
public void renderAvailable(MarkupOutput out, java.util.Enumeration availableItems)
renderAvailable, function that abstracts Available output.- Specified by:
renderAvailablein interfaceCart- Overrides:
renderAvailablein classCartImpl- Parameters:
out- where to write the output of the method.availableItems- argument Name for generating Event output.
-
getAttributeForms
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
- Since:
- MicroStrategy Web 8.0.0
-
renderSelected
public void renderSelected(MarkupOutput out, java.util.Enumeration items)
renderSelected, function that abstracts Selected output.- Specified by:
renderSelectedin interfaceCart- Overrides:
renderSelectedin classCartImpl- Parameters:
out- where to write the output of the method.items- enumeration of all selected items
-
renderMatch
public void renderMatch(MarkupOutput out)
renderMatch, function that outputs AND / OR match output.- Specified by:
renderMatchin interfaceCartExpression- Parameters:
out- where to write the output of the method.
-
renderOperators
public void renderOperators(MarkupOutput out)
renderOperators, function that outputs operators pull-down.- Specified by:
renderOperatorsin interfaceCartExpression- Parameters:
out- where to write the output of the method.
-
renderInput
public void renderInput(MarkupOutput out)
renderInput, function that outputs qualification value textbox.- Specified by:
renderInputin interfaceCartExpression- Parameters:
out- where to write the output of the method.
-
renderCalendarScript
protected void renderCalendarScript(MarkupOutput out, java.lang.String inputArg)
Renders the Javascript for the DHTML calendar- Parameters:
out-inputArg-- Since:
- MicroStrategy Web 8.0.1
-
renderButtonNextInput
public void renderButtonNextInput(MarkupOutput out)
renderButtonNextInput is used to render a button next to the input textbox- Specified by:
renderButtonNextInputin interfaceCartExpression- Parameters:
out- where to write the output of the method.- Since:
- MicroStrategy Web 8.0.0
-
renderExpression
public void renderExpression(MarkupOutput out)
renderExpression is used for rendering group of elements that conform the input and operator in Expression cart- Specified by:
renderExpressionin interfaceCartExpression- Parameters:
out- where to write the output of the method.
-
toString
public java.lang.String toString()
Function that returns class name
-
setCalendar
public void setCalendar(GGCalendar calendar)
setCalendar is used for setting calendar object- Specified by:
setCalendarin interfaceCartExpression- Parameters:
calendar- GGCalendar instance.
-
getCalendar
public GGCalendar getCalendar()
Function used for returning instance of calendar objectGGCalendar.- Specified by:
getCalendarin interfaceCartExpression- Returns:
- GGCalendar calendar instance.
- Since:
- MicroStrategy Web 7.5.1
-
isCalendarAvailable
public boolean isCalendarAvailable()
Function that check whether calendar object is enabled or not.- Specified by:
isCalendarAvailablein interfaceCartExpression- Returns:
- true if calendar is available.
-
getSelectedSize
public int getSelectedSize()
Returns the number of User selections.- Specified by:
getSelectedSizein interfaceCartExpression- Returns:
- int size of selected elements
-
getExpressionTransform
protected PromptExpressionTransform getExpressionTransform()
Function creates instance of prompt expression transform once.- Returns:
- PromptExpressionTransform
-
renderIncludeExcludeOption
public void renderIncludeExcludeOption(MarkupOutput out)
Description copied from interface:CartExpressionFunction that outputs the Include/Exclude option.- Specified by:
renderIncludeExcludeOptionin interfaceCartExpression- Parameters:
out- where to write the output of the method.- Since:
- MicroStrategy Web 8.0.1
- See Also:
CartExpression.renderIncludeExcludeOption(com.microstrategy.web.beans.MarkupOutput)
-
-