public interface

GGCalendar

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

Class Overview

GGCalendar interface that defines minimum contract all GGCalendar must implement.

Summary

Public Methods
abstract void displayDescriptors(MarkupOutput out)
function for rendering localized names for months and days.
abstract String getCalendarButtonName()
Returns calendar HTML button name.
abstract void setCSS(String calendarCSS)
abstract void setCalendarButtonName(String calendarButtonName)
Function for setting calendar button name
abstract void setCalendarRestrictions(String dateMax, String dateMin, String maxDateRestStr, String minDateRestStr)
function that renders Javascript code for creating an Calendar object.
abstract void setCalendarRestrictions(String dateMax, String dateMin)
function that renders Javascript code for creating an Calendar object.
abstract void setImage(String calendarImage)
function for initializing calendar image name
abstract void showCalendar(MarkupOutput out, String textBoxName, int dataType)
function that renders Javascript code for creating an Calendar object.
abstract void showCalendar(MarkupOutput out, String textBoxName)
function that renders Javascript code for creating an Calendar object.
abstract void showCalendarButton(MarkupOutput out, String calendarButtonName)
function that makes visible the calendar button.
abstract void showOrHideCalendarButton(MarkupOutput out, String pulldownMenu)
Function that triggers javascript code for showing or hiding a Calendar object.
abstract void updateOperator(MarkupOutput out, String operatorPullDownMenuName)
function for updating global variable for defining name of pulldown menu for a give operator.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Public Methods

public abstract void displayDescriptors (MarkupOutput out)

function for rendering localized names for months and days.

Parameters
out where to write the output of the method.

public abstract String getCalendarButtonName ()

Returns calendar HTML button name.

Returns
  • String calendar button name. Name of HTML textbox where date value are entered by End user

public abstract void setCSS (String calendarCSS)

public abstract void setCalendarButtonName (String calendarButtonName)

Function for setting calendar button name

Parameters
calendarButtonName name of calendar button.

public abstract void setCalendarRestrictions (String dateMax, String dateMin, String maxDateRestStr, String minDateRestStr)

function that renders Javascript code for creating an Calendar object. It invokes javascript code for showing a calendar object. This code will display a calendar if attribute form data type corresponds to any date type.

Parameters
dateMax String specifies restriction for minimum date
dateMin String specifies restriction for maximum date
maxDateRestStr String specifies the id for maximum date in output
minDateRestStr String specifies the id for minimum date in output

public abstract void setCalendarRestrictions (String dateMax, String dateMin)

function that renders Javascript code for creating an Calendar object. It invokes javascript code for showing a calendar object. This code will display a calendar if attribute form data type corresponds to any date type.

Parameters
dateMax String specifies restriction for minimum date
dateMin String specifies restriction for maximum date

public abstract void setImage (String calendarImage)

function for initializing calendar image name

Parameters
calendarImage path to image used for rendering calendar.

public abstract void showCalendar (MarkupOutput out, String textBoxName, int dataType)

function that renders Javascript code for creating an Calendar object. It invokes javascript code for showing a calendar object. This code will display a calendar if attribute form data type corresponds to any date type.

Parameters
out where to write the output of the method.
textBoxName name of HTML textbox where date value are entered by End user
dataType data type of current attribute form (default)

public abstract void showCalendar (MarkupOutput out, String textBoxName)

function that renders Javascript code for creating an Calendar object. It invokes javascript code for showing a calendar object.

Parameters
out where to write the output of the method.
textBoxName name of HTML textbox where date value are entered by End user

public abstract void showCalendarButton (MarkupOutput out, String calendarButtonName)

function that makes visible the calendar button.

Parameters
out where to write the output of the method.
calendarButtonName button name

public abstract void showOrHideCalendarButton (MarkupOutput out, String pulldownMenu)

Function that triggers javascript code for showing or hiding a Calendar object.

Parameters
out where to write the output of the method.
pulldownMenu HTML menu with corresponding attribute forms and datatype

public abstract void updateOperator (MarkupOutput out, String operatorPullDownMenuName)

function for updating global variable for defining name of pulldown menu for a give operator.
This is needed because this variable doesn't reflect default selection value in given operator pulldown.

Parameters
out where to write the output of the method.