Package com.microstrategy.web.app.gui

Interface CartExpression

All Superinterfaces:

Cart, GuiElement

All Known Subinterfaces:

TreeCartExpression

All Known Implementing Classes:

CartExpressionImpl, TreeCartExpressionImpl

public interface CartExpression
extends Cart

CartExpression interface that defines minimum contract all cart expression must implement.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	DISPLAY_ALL_ATTR_FORMS	Indicates to display both ID and Non-Id forms (default behavior).
static int	DISPLAY_ATTR_NON_ID_FORMS	Indicates to ignore ID forms and display all other type of forms.
static int	DISPLAY_ONLY_ATTR_ID_FORMS	Indicates only display ID forms and ignore other forms when displaying.

Method Summary

Modifier and Type	Method	Description
GGCalendar	getCalendar()	Function used for returning instance of calendar object GGCalendar.
int	getSelectedSize()	Gets the current number of selected elements in the cart.
boolean	isCalendarAvailable()	Function that check whether calendar object is enabled or not.
void	renderButtonNextInput(MarkupOutput out)	Render a button next to the input textbox
void	renderExpression(MarkupOutput out)	This function 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)	Function that renders qualification value HTML textbox.This is where users enters qualification values.
void	renderMatch(MarkupOutput out)	Function that outputs AND / OR match output HTML radio button.
void	renderOperators(MarkupOutput out)	Function used for rendering supported operators HTML pull-down list.
void	setCalendar(GGCalendar calendar)	Function used for setting calendar object GGCalendar.

Methods inherited from interface com.microstrategy.web.app.gui.Cart

getProperty, initializeCart, renderActionImage, renderAdd, renderAddAll, renderAvailable, renderAvailable, renderCart, renderCart, renderDown, renderIncrementalFetch, renderLabel, renderLabel, renderMatchCase, renderRemove, renderRemoveAll, renderSearch, renderSearchButton, renderSearchField, renderSelected, 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

Field Detail

DISPLAY_ONLY_ATTR_ID_FORMS

static final int DISPLAY_ONLY_ATTR_ID_FORMS

Indicates only display ID forms and ignore other forms when displaying.

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

DISPLAY_ATTR_NON_ID_FORMS

static final int DISPLAY_ATTR_NON_ID_FORMS

Indicates to ignore ID forms and display all other type of forms.

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

DISPLAY_ALL_ATTR_FORMS

static final int DISPLAY_ALL_ATTR_FORMS

Indicates to display both ID and Non-Id forms (default behavior).

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

Method Detail

renderOperators

void renderOperators(MarkupOutput out)

Function used for rendering supported operators HTML pull-down list.

Parameters:

out - where to write the output of the method.

renderInput

void renderInput(MarkupOutput out)

Function that renders qualification value HTML textbox.This is where users enters qualification values.

Parameters:

out - where to write the output of the method.

renderMatch

void renderMatch(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.

renderIncludeExcludeOption

void renderIncludeExcludeOption(MarkupOutput out)

Function that outputs the Include/Exclude option.

Parameters:

out - where to write the output of the method.

Since:

MicroStrategy Web 8.0.1

renderButtonNextInput

void renderButtonNextInput(MarkupOutput out)

Render a button next to the input textbox

Parameters:

out - where to write the output of the method.

Since:

MicroStrategy Web 8.0.0

isCalendarAvailable

boolean isCalendarAvailable()

Function that check whether calendar object is enabled or not.

Returns:

true if calendar is available.

Since:

MicroStrategy Web 8.0.0

renderExpression

void renderExpression(MarkupOutput out)

This function 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.

setCalendar

void setCalendar(GGCalendar calendar)

Function used for setting calendar object GGCalendar. This function abstracts objec implemented in Javascript code. It's used for facilatating end user to enter date values.

Parameters:

calendar - calendar instance.

getCalendar

GGCalendar getCalendar()

Function used for returning instance of calendar object GGCalendar.

Returns:

GGCalendar calendar instance.

Since:

MicroStrategy Web 7.5.1

getSelectedSize

int getSelectedSize()

Gets the current number of selected elements in the cart.

Returns:

the number of selected elements in the cart.