Package com.microstrategy.web.app.gui

Class GGCalendarImpl

java.lang.Object

com.microstrategy.web.app.gui.AbstractGuiElement

com.microstrategy.web.app.gui.GGCalendarImpl

All Implemented Interfaces:

GGCalendar, GuiElement

public class GGCalendarImpl
extends AbstractGuiElement
implements GGCalendar

GGCalendarImpl abstraction

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

_appContext, _name, _webComponent

Constructor Summary

Constructors

Constructor	Description
GGCalendarImpl()	Constructor.
GGCalendarImpl(java.lang.String calendarImage)	Constructor.

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.
MarkupOutput	renderElement()	return render element for writing output
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)	function for initializing calendar css
void	setImage(java.lang.String calendarImage)	function for initializing calendar image name
void	showCalendar(MarkupOutput out, java.lang.String textBoxName)	function for displaying calendar button
void	showCalendar(MarkupOutput out, java.lang.String textBoxName, int dataType)	function for showing calendar button.
void	showCalendarButton(MarkupOutput out, java.lang.String calendarButtonName)	function that makes visible the calendar button.
void	showOrHideCalendarButton(MarkupOutput out, java.lang.String pulldownMenu)	function for rendering SCRIPT code for showing or hiding calendar image.
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 class com.microstrategy.web.app.gui.AbstractGuiElement

getAppContext, getDescriptor, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getTagsFactory, getUseIFrame, getWebComponent, isDhtml, isIFrameEnabled, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Constructor Detail

GGCalendarImpl

public GGCalendarImpl()

Constructor. No arguments.

GGCalendarImpl

public GGCalendarImpl(java.lang.String calendarImage)

Constructor. Takes name for calendar image.

Parameters:

calendarImage -

Method Detail

renderElement

public MarkupOutput renderElement()

return render element for writing output

Specified by:

renderElement in interface GuiElement

Specified by:

renderElement in class AbstractGuiElement

Returns:

MarkupOutput

showCalendar

public void showCalendar(MarkupOutput out,
                         java.lang.String textBoxName,
                         int dataType)

function for showing calendar button. It validates value in textfield has a time data type.

Specified by:

showCalendar in interface GGCalendar

Parameters:

out - where to write the output of the method.

textBoxName - HTML textfield where date values are entered.

dataType - current attribute form data type

setCalendarRestrictions

public void setCalendarRestrictions(java.lang.String dateMax,
                                    java.lang.String dateMin)

Description copied from interface: GGCalendar

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.

Specified by:

setCalendarRestrictions in interface GGCalendar

Parameters:

dateMax - String specifies restriction for minimum date

dateMin - String specifies restriction for maximum date

Since:

MicroStrategy Web 7.5.1

setCalendarRestrictions

public void setCalendarRestrictions(java.lang.String dateMax,
                                    java.lang.String dateMin,
                                    java.lang.String maxDateRestStr,
                                    java.lang.String minDateRestStr)

Description copied from interface: GGCalendar

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.

Specified by:

setCalendarRestrictions in interface GGCalendar

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

public void showCalendar(MarkupOutput out,
                         java.lang.String textBoxName)

function for displaying calendar button

Specified by:

showCalendar in interface GGCalendar

Parameters:

out - where to write the output of the method.

textBoxName -

displayDescriptors

public void displayDescriptors(MarkupOutput out)

function for rendering localized names for months and days.

Specified by:

displayDescriptors in interface GGCalendar

Parameters:

out - where to write the output of the method.

showCalendarButton

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

function that makes visible the calendar button.

Specified by:

showCalendarButton in interface GGCalendar

Parameters:

out - where to write the output of the method.

calendarButtonName - button name

showOrHideCalendarButton

public void showOrHideCalendarButton(MarkupOutput out,
                                     java.lang.String pulldownMenu)

function for rendering SCRIPT code for showing or hiding calendar image.

Specified by:

showOrHideCalendarButton in interface GGCalendar

Parameters:

out - where to write the output of the method.

pulldownMenu -

updateOperator

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

Specified by:

updateOperator in interface GGCalendar

Parameters:

out - where to write the output of the method.

operatorPullDownMenuName -

setImage

public void setImage(java.lang.String calendarImage)

function for initializing calendar image name

Specified by:

setImage in interface GGCalendar

Parameters:

calendarImage -

setCSS

public void setCSS(java.lang.String calendarCSS)

function for initializing calendar css

Specified by:

setCSS in interface GGCalendar

Parameters:

calendarCSS -

setCalendarButtonName

public void setCalendarButtonName(java.lang.String calendarButtonName)

Function for setting calendar button name

Specified by:

setCalendarButtonName in interface GGCalendar

Parameters:

calendarButtonName -

getCalendarButtonName

public java.lang.String getCalendarButtonName()

Returns calendar HTML button name.

Specified by:

getCalendarButtonName in interface GGCalendar

Returns:

String calendar button name