public class

CartExpressionImpl

extends CartImpl
implements CartExpression
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.CartImpl
       ↳ com.microstrategy.web.app.gui.CartExpressionImpl
Known Direct Subclasses

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.gui.CartExpression
From interface com.microstrategy.web.app.gui.EnumCartProperties
[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Constructors
CartExpressionImpl()
CartExpression constructor, initialize all expression cart properties.
Public Methods
GGCalendar getCalendar()
Function used for returning instance of calendar object GGCalendar.
int getSelectedSize()
Returns the number of User selections.
void initializeCart()
InitializeCart, for initializing all Cart properties to default values.
boolean isCalendarAvailable()
Function that check whether calendar object is enabled or not.
void renderAvailable(MarkupOutput out, Enumeration availableItems)
renderAvailable, function that abstracts Available output.
void renderButtonNextInput(MarkupOutput out)
renderButtonNextInput is used to render a button next to the input textbox
void renderCart(MarkupOutput out, Enumeration availableItems, Enumeration selectedItems)
renderCart, function that abstracts standard Cart output.
void renderExpression(MarkupOutput out)
renderExpression 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)
renderInput, function that outputs qualification value textbox.
void renderMatch(MarkupOutput out)
renderMatch, function that outputs AND / OR match output.
void renderOperators(MarkupOutput out)
renderOperators, function that outputs operators pull-down.
void renderSelected(MarkupOutput out, Enumeration items)
renderSelected, function that abstracts Selected output.
void setCalendar(GGCalendar calendar)
setCalendar is used for setting calendar object
String toString()
Function that returns class name
Protected Methods
WebAttributeForms getAttributeForms(WebAttribute attribute)
Returns collection of attribute forms.
PromptExpressionTransform getExpressionTransform()
Function creates instance of prompt expression transform once.
void renderCalendarScript(MarkupOutput out, String inputArg)
Renders the Javascript for the DHTML calendar
[Expand]
Inherited Methods
From class com.microstrategy.web.app.gui.CartImpl
From class com.microstrategy.web.app.gui.AbstractGuiElement
From class java.lang.Object
From interface com.microstrategy.web.app.gui.Cart
From interface com.microstrategy.web.app.gui.CartExpression
From interface com.microstrategy.web.app.gui.GuiElement

Public Constructors

public CartExpressionImpl ()

CartExpression constructor, initialize all expression cart properties.

Public Methods

public GGCalendar getCalendar ()

Function used for returning instance of calendar object GGCalendar.

Returns
  • GGCalendar calendar instance.

public int getSelectedSize ()

Returns the number of User selections.

Returns
  • int size of selected elements

public void initializeCart ()

InitializeCart, for initializing all Cart properties to default values.

public boolean isCalendarAvailable ()

Function that check whether calendar object is enabled or not.

Returns
  • true if calendar is available.

public void renderAvailable (MarkupOutput out, Enumeration availableItems)

renderAvailable, function that abstracts Available output.

Parameters
out where to write the output of the method.
availableItems argument Name for generating Event output.

public void renderButtonNextInput (MarkupOutput out)

renderButtonNextInput is used to render a button next to the input textbox

Parameters
out where to write the output of the method.

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

renderCart, 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 void renderExpression (MarkupOutput out)

renderExpression 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 void renderIncludeExcludeOption (MarkupOutput out)

Function that outputs the Include/Exclude option.

Parameters
out where to write the output of the method.

public void renderInput (MarkupOutput out)

renderInput, function that outputs qualification value textbox.

Parameters
out where to write the output of the method.

public void renderMatch (MarkupOutput out)

renderMatch, function that outputs AND / OR match output.

Parameters
out where to write the output of the method.

public void renderOperators (MarkupOutput out)

renderOperators, function that outputs operators pull-down.

Parameters
out where to write the output of the method.

public void renderSelected (MarkupOutput out, Enumeration items)

renderSelected, function that abstracts Selected output.

Parameters
out where to write the output of the method.
items enumeration of all selected items

public void setCalendar (GGCalendar calendar)

setCalendar is used for setting calendar object

Parameters
calendar GGCalendar instance.

public String toString ()

Function that returns class name

Returns
  • class name

Protected Methods

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

protected PromptExpressionTransform getExpressionTransform ()

Function creates instance of prompt expression transform once.

Returns
  • PromptExpressionTransform

protected void renderCalendarScript (MarkupOutput out, String inputArg)

Renders the Javascript for the DHTML calendar