Class SweetDevRia.MultiCalendar

MultiCalendar is an implementation of the CalendarGroup base class, when used in a X-up view.
Defined in: MultiCalendarGroup.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SweetDevRia.MultiCalendar(nbMonth, childCalClass, id, containerId, monthyear, selected)

Field Summary
Field Attributes	Field Name and Description
	acceptDate This function checks the date on input type field(s).
	addHiddenDateField Set the input HTML hidden field on calendar in order to update selected date(s).
<private>	checkCalendarDate This fonction throw an exception if the range is not valid to be sure that the date is well formatted
	clearBadFormat Clear all bad format CSS style class on input type.
	CssBadFormat CSS class for date bad format.
	dateDayField HTML day date field object.
	dateMonthField HTML month date field object.
	dateYearField HTML year date field object.
	emptyDatefields Empty dates HTML input text fields (single field and 3 parts fields).
	fillDateInfields Fill dates HTML input text fields (single field and 3 parts fields).
	getErrorMessage This function return the error message depending on the exception
	handleError This function handle a date error
	hiddenDateField HTML hidden date field object.
	mustBeRendered If calendar is hidden, we don't need to render it but we must know that it must be rendered when it will be displayed.
	openTooltip Open the tooltip or set the focus on it if it's still opened.
	Options Options.
	renderBodyCellRestricted Wiring renderBodyCellRestricted to YAHOO.widget.Calendar_Core.
	setSingleValue This function set a new date value from a date If it's correct, date is set on the Calendar, if not, an error class is returned
	setValue This function set a new date value from a date If it's correct, date is set on the Calendar, if not, an error class is returned
	singleDateField Single date field HTML object.
	tooltip Click to open tooltip JavaScript object.

Method Summary
Method Attributes	Method Name and Description
	addAcronymRender(Date, List, CSS) Add a acronym and a rendering for specified dates in dateList.
	addExplodedDateField(yearFieldId, monthFieldId, dayFieldId) Set the 3 input HTML text fields (day, month and year) synchronized with the calendar.
	addPeriodRenderer(Date) Override SweetDevRia.DateRangeCalendar.prototype.addPeriodRenderer
	addRenderer(sDates, fnRender) Override YAHOO.widget.Calendar_Core.prototype.addRenderer
	addSingleDateField(singleDateFieldId) Set the input HTML text field synchronized with the calendar.
	buildWrapper(containerId) Builds the wrapper container for the X-up calendar.
	clearPeriodDateRange() For DateRangerCalendar : Clear period for date range calendar.
	constructChild(id, childCalClass, containerId, monthyear, selected) Implementation of CalendarGroup.constructChild that add some multi-calendar actions.
	customConfig() Define custom config for multi-calendar.
	doGoOnToday(e, calGroup) Go on today's date.
	doGoOnTodayOnDateRange(e, calGroup) For DateRangerCalendar : Override DateRangeCalendar.prototype.goOnToday.
	doResetCalendar(e, calGroup) Clear calendar.
	doResetCalendarOnDateRange(e, calGroup) For DateRangerCalendar : Override DateRangeCalendar.prototype.resetCalendar.
	focus() Override SweetDevRia.SimpleCalendar.focus function.
	getSelDates() Override SweetDevRia.SimpleCalendar.getSelDates.
	init(pageCount, childCalClass, id, containerId, monthyear, selected) Initializes the calendar group.
	render() Renders the X-up calendar.
	selectCellOnDateRange(cellIndex) For DateRangerCalendar : Override DateRangeCalendar.prototype.selectCell.
	selectOnDateRange(date) For DateRangerCalendar : Override DateRangeCalendar.prototype.selectCell.
	setNewDate(the) This function set the new date on calendar.
	setNewDateAndFillDateInFields(the) This function set the new date on calendar and fills html inputs fields.
	setupConfig() Override YAHOO.widget.Calendar_Core.prototype.setupConfig.

Class Detail

SweetDevRia.MultiCalendar(nbMonth, childCalClass, id, containerId, monthyear, selected)

Parameters:
{Int} nbMonth: Number of months wich should be displayed.
{Object} childCalClass: Calendar class (StandAloneCalendar, SimpleCalendar, etc) used to instanciate child calendars.
{String} id: The id of the table element that will represent the calendar widget
{String} containerId: The id of the container element that will contain the calendar table
{String} monthyear: The month/year string used to set the current calendar page
{String} selected: A string of date values formatted using the date parser. The built-in default date format is MM/DD/YYYY. Ranges are defined using MM/DD/YYYY-MM/DD/YYYY. Month/day combinations are defined using MM/DD. Any combination of these can be combined by delimiting the string with commas. Example: "12/24/2005,12/25,1/18/2006-1/21/2006"

Field Detail

acceptDate

This function checks the date on input type field(s). If it's correct, date is set on the Calendar, if not, an error class is applied on input type field(s).

addHiddenDateField

Set the input HTML hidden field on calendar in order to update selected date(s).

<private> checkCalendarDate

This fonction throw an exception if the range is not valid to be sure that the date is well formatted

clearBadFormat

Clear all bad format CSS style class on input type.

{String} CssBadFormat

CSS class for date bad format.

{HTMLInputElement} dateDayField

HTML day date field object.

{HTMLInputElement} dateMonthField

HTML month date field object.

{HTMLInputElement} dateYearField

HTML year date field object.

emptyDatefields

Empty dates HTML input text fields (single field and 3 parts fields).

fillDateInfields

Fill dates HTML input text fields (single field and 3 parts fields).

{String} getErrorMessage

This function return the error message depending on the exception

handleError

This function handle a date error

{HTMLInputElement} hiddenDateField

HTML hidden date field object.

mustBeRendered

If calendar is hidden, we don't need to render it but we must know that it must be rendered when it will be displayed.

openTooltip

Open the tooltip or set the focus on it if it's still opened.

{Array} Options

Options.

renderBodyCellRestricted

Wiring renderBodyCellRestricted to YAHOO.widget.Calendar_Core.

setSingleValue

This function set a new date value from a date If it's correct, date is set on the Calendar, if not, an error class is returned

setValue

This function set a new date value from a date If it's correct, date is set on the Calendar, if not, an error class is returned

{HTMLInputElement} singleDateField

Single date field HTML object.

{ClickToOpen object} tooltip

Click to open tooltip JavaScript object.

Method Detail

addAcronymRender(Date, List, CSS)

Add a acronym and a rendering for specified dates in dateList.

Parameters:
{String} Date: List, separated by comma.
{String[]} List: of acronyms in same order than date list.
{String[]} CSS: Style class.

addExplodedDateField(yearFieldId, monthFieldId, dayFieldId)

Set the 3 input HTML text fields (day, month and year) synchronized with the calendar.

Parameters:
{HTMLInputElement} yearFieldId: HTML year input text field.
{HTMLInputElement} monthFieldId: HTML month input text field.
{HTMLInputElement} dayFieldId: HTML day input text field.

addPeriodRenderer(Date)

Override SweetDevRia.DateRangeCalendar.prototype.addPeriodRenderer

Parameters:
{String} Date: List. See YAHOO.widget.Calendar_Core.prototype.addRenderer#sDates

addRenderer(sDates, fnRender)

Override YAHOO.widget.Calendar_Core.prototype.addRenderer

Parameters:
sDates
fnRender

addSingleDateField(singleDateFieldId)

Set the input HTML text field synchronized with the calendar.

Parameters:
{HTMLInputElement} singleDateFieldId: HTML input text field.

buildWrapper(containerId)

Builds the wrapper container for the X-up calendar.

Parameters:
{String} containerId: The id of the outer container element.

clearPeriodDateRange()

For DateRangerCalendar : Clear period for date range calendar.

constructChild(id, childCalClass, containerId, monthyear, selected)

Implementation of CalendarGroup.constructChild that add some multi-calendar actions.

Parameters:
id
childCalClass
containerId
monthyear
selected

customConfig()

Define custom config for multi-calendar. Override YAHOO.widget.Calendar_Core.prototype.customConfig.

doGoOnToday(e, calGroup)

Go on today's date.

Parameters:
e
calGroup

doGoOnTodayOnDateRange(e, calGroup)

For DateRangerCalendar : Override DateRangeCalendar.prototype.goOnToday.

Parameters:
e
calGroup

doResetCalendar(e, calGroup)

Clear calendar.

Parameters:
e
calGroup

doResetCalendarOnDateRange(e, calGroup)

For DateRangerCalendar : Override DateRangeCalendar.prototype.resetCalendar.

Parameters:
e
calGroup

focus()

Override SweetDevRia.SimpleCalendar.focus function.

{Array} getSelDates()

Override SweetDevRia.SimpleCalendar.getSelDates.

Returns:: 2-dim arrays : [ [ year, month, day ], [...] ]

init(pageCount, childCalClass, id, containerId, monthyear, selected)

Initializes the calendar group. All subclasses must call this method in order for the group to be initialized properly.

Parameters:
{int} pageCount: The number of pages that this calendar should display.
{Object} childCalClass: Calendar class (StandAloneCalendar, SimpleCalendar, etc) used to instanciate child calendars.
{String} id: The id of the element that will be inserted into the DOM.
{String} containerId: The id of the container element that the calendar will be inserted into.
{String} monthyear: The month/year string used to set the current calendar page
{String} selected: A string of date values formatted using the date parser. The built-in default date format is MM/DD/YYYY. Ranges are defined using MM/DD/YYYY-MM/DD/YYYY. Month/day combinations are defined using MM/DD. Any combination of these can be combined by delimiting the string with commas. Example: "12/24/2005,12/25,1/18/2006-1/21/2006"

render()

Renders the X-up calendar.

{Date[]} selectCellOnDateRange(cellIndex)

For DateRangerCalendar : Override DateRangeCalendar.prototype.selectCell.

Parameters:
{int} cellIndex: The index of the cell to select in the current calendar.

Returns:: Array of JavaScript Date objects representing all individual dates that are currently selected.

{Date[]} selectOnDateRange(date)

For DateRangerCalendar : Override DateRangeCalendar.prototype.selectCell.

Parameters:
{String/Date/Date[]} date: The date string of dates to select in the current calendar. Valid formats are individual date(s) (12/24/2005,12/26/2005) or date range(s) (12/24/2005-1/1/2006). Multiple comma-delimited dates can also be passed to this method (12/24/2005,12/11/2005-12/13/2005). This method can also take a JavaScript Date object or an array of Date objects.

Returns:: Array of JavaScript Date objects representing all individual dates that are currently selected.

setNewDate(the)

This function set the new date on calendar.

Parameters:
{Date} the: new date to set.

setNewDateAndFillDateInFields(the)

This function set the new date on calendar and fills html inputs fields.

Parameters:
{Date} the: new date to set.

setupConfig()

Override YAHOO.widget.Calendar_Core.prototype.setupConfig.

Classes

Class SweetDevRia.MultiCalendar