public interface

CartExpression

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

Class Overview

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

Summary

Constants
int DISPLAY_ALL_ATTR_FORMS Indicates to display both ID and Non-Id forms (default behavior).
int DISPLAY_ATTR_NON_ID_FORMS Indicates to ignore ID forms and display all other type of forms.
int DISPLAY_ONLY_ATTR_ID_FORMS Indicates only display ID forms and ignore other forms when displaying.
Public Methods
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.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.Cart
From interface com.microstrategy.web.app.gui.GuiElement

Constants

public static final int DISPLAY_ALL_ATTR_FORMS

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

Constant Value: 2 (0x00000002)

public static final int DISPLAY_ATTR_NON_ID_FORMS

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

Constant Value: 1 (0x00000001)

public static final int DISPLAY_ONLY_ATTR_ID_FORMS

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

Constant Value: 0 (0x00000000)

Public Methods

public abstract GGCalendar getCalendar ()

Function used for returning instance of calendar object GGCalendar.

Returns
  • GGCalendar calendar instance.

public abstract int getSelectedSize ()

Gets the current number of selected elements in the cart.

Returns
  • the number of selected elements in the cart.

public abstract boolean isCalendarAvailable ()

Function that check whether calendar object is enabled or not.

Returns
  • true if calendar is available.

public abstract void renderButtonNextInput (MarkupOutput out)

Render a button next to the input textbox

Parameters
out where to write the output of the method.

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

public abstract void renderIncludeExcludeOption (MarkupOutput out)

Function that outputs the Include/Exclude option.

Parameters
out where to write the output of the method.

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

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

public abstract void renderOperators (MarkupOutput out)

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

Parameters
out where to write the output of the method.

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