ContactsCart

implements Cart

com.microstrategy.web.app.gui.ContactsCart

Summary

Public Methods
abstract void	renderCart(MarkupOutput out, Enumeration personalList, Enumeration sharedList, Enumeration selectedTo, Enumeration selectedCc, Enumeration selectedBcc) Renders Subscription Contacts Cart
abstract void	setDevices(SimpleList devices) sets devices to be rendered on the address creation part.

[Expand]

Inherited Methods

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

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

abstract AppContext	getAppContext() Get the `AppContext` instance used by this element
abstract String	getDescriptor(int key) Get the descriptor associated with the numeric key given
abstract String	getDescriptor(String key) Get the descriptor associated with the string 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 Methods

public abstract void renderCart (MarkupOutput out, Enumeration personalList, Enumeration sharedList, Enumeration selectedTo, Enumeration selectedCc, Enumeration selectedBcc)

Renders Subscription Contacts Cart

Parameters

out	markup output
personalList	list of personal contacs as an Enumeration of `ContactCartElement` objects.
sharedList	list of shared contacs as an Enumeration of `ContactCartElement` objects.
selectedTo	list of selected contacs for "To" field as an Enumeration of `ContactCartElement` objects.
selectedCc	list of selected contacs for "Cc" field as an Enumeration of `ContactCartElement` objects.
selectedBcc	list of selected contacs for "Bcc" field as an Enumeration of `ContactCartElement` objects.

public abstract void setDevices (SimpleList devices)

sets devices to be rendered on the address creation part.

Interfaces

Classes

ContactsCart

Summary

Public Methods

public abstract void renderCart (MarkupOutput out, Enumeration personalList, Enumeration sharedList, Enumeration selectedTo, Enumeration selectedCc, Enumeration selectedBcc)

Parameters

public abstract void setDevices (SimpleList devices)