Package com.microstrategy.web.app.gui

Interface GGCalendar

All Superinterfaces:

GuiElement

All Known Implementing Classes:

GGCalendarImpl

public interface GGCalendar
extends GuiElement

GGCalendar interface that defines minimum contract all GGCalendar must implement.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
void	displayDescriptors(MarkupOutput out)	function for rendering localized names for months and days.
java.lang.String	getCalendarButtonName()	Returns calendar HTML button name.
void	setCalendarButtonName(java.lang.String calendarButtonName)	Function for setting calendar button name
void	setCalendarRestrictions(java.lang.String dateMax, java.lang.String dateMin)	function that renders Javascript code for creating an Calendar object.
void	setCalendarRestrictions(java.lang.String dateMax, java.lang.String dateMin, java.lang.String maxDateRestStr, java.lang.String minDateRestStr)	function that renders Javascript code for creating an Calendar object.
void	setCSS(java.lang.String calendarCSS)
void	setImage(java.lang.String calendarImage)	function for initializing calendar image name
void	showCalendar(MarkupOutput out, java.lang.String textBoxName)	function that renders Javascript code for creating an Calendar object.
void	showCalendar(MarkupOutput out, java.lang.String textBoxName, int dataType)	function that renders Javascript code for creating an Calendar object.
void	showCalendarButton(MarkupOutput out, java.lang.String calendarButtonName)	function that makes visible the calendar button.
void	showOrHideCalendarButton(MarkupOutput out, java.lang.String pulldownMenu)	Function that triggers javascript code for showing or hiding a Calendar object.
void	updateOperator(MarkupOutput out, java.lang.String operatorPullDownMenuName)	function for updating global variable for defining name of pulldown menu for a give operator.

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

Method Detail

showCalendar

void showCalendar(MarkupOutput out,
                  java.lang.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)

setCalendarRestrictions

void setCalendarRestrictions(java.lang.String dateMax,
                             java.lang.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

Since:

MicroStrategy Web 7.5.1

setCalendarRestrictions

void setCalendarRestrictions(java.lang.String dateMax,
                             java.lang.String dateMin,
                             java.lang.String maxDateRestStr,
                             java.lang.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

Since:

MicroStrategy Web 9.0.0

showCalendar

void showCalendar(MarkupOutput out,
                  java.lang.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

showCalendarButton

void showCalendarButton(MarkupOutput out,
                        java.lang.String calendarButtonName)

function that makes visible the calendar button.

Parameters:

out - where to write the output of the method.

calendarButtonName - button name

showOrHideCalendarButton

void showOrHideCalendarButton(MarkupOutput out,
                              java.lang.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

displayDescriptors

void displayDescriptors(MarkupOutput out)

function for rendering localized names for months and days.

Parameters:

out - where to write the output of the method.

setImage

void setImage(java.lang.String calendarImage)

function for initializing calendar image name

Parameters:

calendarImage - path to image used for rendering calendar.

setCSS

void setCSS(java.lang.String calendarCSS)

setCalendarButtonName

void setCalendarButtonName(java.lang.String calendarButtonName)

Function for setting calendar button name

Parameters:

calendarButtonName - name of calendar button.

getCalendarButtonName

java.lang.String getCalendarButtonName()

Returns calendar HTML button name.

Returns:

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

updateOperator

void updateOperator(MarkupOutput out,
                    java.lang.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.

operatorPullDownMenuName -