public interface

Cart

implements GuiElement
com.microstrategy.web.app.gui.Cart
Known Indirect Subclasses

Class Overview

Cart interface that defines minimum contract all cart must implement.

Summary

Public Methods
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, CartElements availableItems, CartElements selectedItems)
Function that abstracts standard Cart output.
abstract void renderCart(MarkupOutput out, Enumeration availableItems, Enumeration 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.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Public Methods

public abstract Object getProperty (String key)

Function for getting Cart properties EnumCartProperties current values.

Parameters
key index or key property to be retrieved, which value comes from the EnumCartProperties enumeration.
Returns
  • Object instance that was associated with that key.

public abstract void initializeCart ()

InitializeCart, for initializing all Cart properties to default values.

public 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.

Parameters
out where to write the output of the method
jsFunction array of String with the JavaScript information to trigger when the user clicks on the image. If none is provided or the current output mode of the cart is does not support DHTML then the information will not be used.
name identifier for the image tag to create.
imageClass full css class the image to create will have
title tooltip to associate with the image to render

public abstract void renderAdd (MarkupOutput out)

Displays add HTML image arrow button.

Parameters
out where to write the output of the method.

public abstract void renderAddAll (MarkupOutput out)

Displays add all HTML image arrow button.

Parameters
out where to write the output of the method.

public abstract void renderAvailable (MarkupOutput out, Enumeration items)

This function will display available list of units for a given prompt question. It'll abstract what format to be used for rendering available list.

Parameters
out where to write the output of the method.
items list of units to be displayed in available list.

public abstract void renderAvailable (MarkupOutput out, CartElements items)

This function will display available list of units defined in CartElements collection. It'll abstract what format to be used for rendering available list.

Parameters
out where to write the output of the method.
items collection of CartElements to be displayed in available list.

public abstract void renderCart (MarkupOutput out, CartElements availableItems, CartElements selectedItems)

Function that abstracts standard Cart output.

Parameters
out where to write the output of the method.
availableItems CartElements collection of all available items
selectedItems CartElements collection of all selected items

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

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 abstract void renderDown (MarkupOutput out)

Displays move down HTML image arrow button.

Parameters
out where to write the output of the method.

public abstract void renderIncrementalFetch (MarkupOutput out)

Function that renders incremental fetch abstraction. Most likely, it'll be rendered below available list and will be used for page this list based on blocks.

Parameters
out where to write the output of the method.

public abstract void renderLabel (MarkupOutput out, String labelName, String forValue)

Function for displaying HTML labels.

Parameters
out where to write the output of the method.
labelName string of label to be displayed.
forValue string value for the FOR attribute of the LABEL HTML tag.

public abstract void renderLabel (MarkupOutput out, String labelName)

Function for displaying HTML labels.

Parameters
out where to write the output of the method.
labelName string of label to be displayed.

public abstract void renderMatchCase (MarkupOutput out)

Function that outputs AND / OR match output HTML radio button. This is a global operator that groups all qualifications made by the user.

Parameters
out where to write the output of the method.

public abstract void renderRemove (MarkupOutput out)

Displays remove HTML image arrow button.

Parameters
out where to write the output of the method.

public abstract void renderRemoveAll (MarkupOutput out)

Displays remove all HTML image arrow button.

Parameters
out where to write the output of the method.

public abstract void renderSearch (MarkupOutput out)

Function that renders search HTML output. Most likely an HTML textfield along with an image button for submitting search pattern.

Parameters
out where to write the output of the method.

public abstract void renderSearchButton (MarkupOutput out)

Function called by renderSeach function. It abstracts image button used for submitting search pattern.

Parameters
out where to write the output of the method.

public abstract void renderSearchField (MarkupOutput out)

Function called by renderSearch function. It abstracts search textfield to be rendered. Search patttern is entered in this HTML component.

Parameters
out where to write the output of the method.

public abstract void renderSelected (MarkupOutput out, CartElements items)

This function will display selected list of units defined in CartElements collection. It'll abstract what format to be used for rendering selected list.

Parameters
out where to write the output of the method.
items collection of CartElements to be displayed.

public abstract void renderSelected (MarkupOutput out, Enumeration items)

This function will display selected list of units for a given prompt question. It'll abstract what format to be used for rendering selected list.

Parameters
out where to write the output of the method.
items list of units to be displayed.

public abstract void renderUp (MarkupOutput out)

Displays move up HTML image arrow button.

Parameters
out where to write the output of the method.

public abstract void setEnabled (boolean flag)

Function for enabling or disabling the interaction scripts on the cart rendering.

Parameters
flag true

public abstract void setHideWaitPageFlag (boolean flag)

Function for making sure javascript code for hiding wait page is appended to add/remove image buttons

Parameters
flag true if extra code is appended.

public abstract void setProperty (String key, Object obj)

Function for initializing individual Cart properties EnumCartProperties to given values. This function is exposed for allowing Cart customization.

Parameters
key index or key property to be set, which value comes from the EnumCartProperties enumeration.
obj Object instance with the value to associate with key index.