JavaScript Documentation -

Class YAHOO.widget.Calendar_Core

Object
   |
   +--YAHOO.widget.Calendar_Core

Direct Known Subclasses:: YAHOO.widget.Calendar2up_Cal, YAHOO.widget.Calendar

class YAHOO.widget.Calendar_Core

Quick Links: Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

Array[](Integer[])	`cellDates` The collection of calendar cell dates that is parallel to the cells collection.
HTMLTableCellElement[]	`cells` The collection of calendar table cells
Object	`Config` The configuration object used to set up the calendars various locale and style options.
HTMLTableCellElement	`headerCell` The HTML cell element that represents the main header cell TH used in the calendar table
String	`id` The id that uniquely identifies this calendar.
Date	`maxDate` A Date object representing the maximum selectable date
Date	`minDate` A Date object representing the minimum selectable date
HTMLElement	`oDomContainer` The DOM element reference that points to this calendar's container element.
Date	`pageDate` A Date object representing the month/year that the calendar is currently set to
CalendarGroup	`parent` The parent CalendarGroup, only to be set explicitly by the parent group
Array[]	`renderStack` The list of render functions, along with required parameters, used to render cells.
Array[](Integer[])	`selectedDates` The list of currently selected dates.
Boolean	`shellRendered` A boolean indicating whether the shell of the calendar has already been rendered to the page
HTMLTableElement	`table` The HTML table element that represents this calendar
Date	`today` A Date object representing today's date.
HTMLTableCellElement[]	`weekFooterCells` The collection of calendar week footer cells
HTMLTableCellElement[]	`weekHeaderCells` The collection of calendar week header cells
String	`DATE` Type constant used for renderers to represent an individual date (M/D/Y)
Integer	`DISPLAY_DAYS` Constant that represents the total number of date cells that are displayed in a given month including
String	`IMG_ROOT` The path to be used for images loaded for the Calendar
String	`MONTH` Type constant used for renderers to represent a month across any year
String	`MONTH_DAY` Type constant used for renderers to represent an individual date across any year (M/D)
String	`RANGE` Type constant used for renderers to represent a range of individual dates (M/D/Y-M/D/Y)
String	`STOP_RENDER` Constant used for halting the execution of the remainder of the render stack
String	`WEEKDAY` Type constant used for renderers to represent a weekday

Constructor Summary [top]


						YAHOO.widget.Calendar_Core

Method Summary [top]

void	`addMonthRenderer (<Integer> month, <Function> fnRender)` Adds a month to the render stack.
void	`addMonths (<Integer> count)` Adds the designated number of months to the current calendar month, and sets the current calendar page date to the new month.
void	`addRenderer (<String> sDates, <Function> fnRender)` Adds a renderer to the render stack.
void	`addWeekdayRenderer (weekday, <Function> fnRender)` Adds a weekday to the render stack.
void	`addYears (<Integer> count)` Adds the designated number of years to the current calendar, and sets the current calendar page date to the new month.
String	`buildDayLabel (workingDate)` Builds the date digit that will be displayed in calendar cells
String	`buildMonthLabel ()` Builds the date label that will be displayed in the calendar header or footer, depending on configuration.
void	`buildShell ()` Builds the calendar table shell that will be filled in with dates and formatting.
void	`buildShellBody ()` Builds the calendar shell body (6 weeks by 7 days)
void	`buildShellFooter ()` Builds the calendar shell footer.
void	`buildShellHeader ()` Builds the calendar shell header by inserting a THEAD into the local calendar table.
void	`clear ()` Clears the selected dates in the current calendar widget and sets the calendar to the current month and year.
void	`clearAllBodyCellStyles (style)` Removes all styles from all body cells in the current calendar table.
void	`clearElement (cell)` Clears the inner HTML, CSS class and style information from the specified cell.
void	`customConfig ()` This method is called when subclasses need to override configuration variables or create new ones.
Date[]	`deselect (date)` Deselects a date or a collection of dates on the current calendar.
Date[]	`deselectAll ()` Deselects all dates on the current calendar.
Date[]	`deselectCell (i)` Deselects a date on the current calendar by referencing the index of the cell that should be deselected.
Date[]	`getSelectedDates ()` Gets the list of currently selected dates from the calendar.
void	`init (<String> id, <String> containerId, <String> monthyear, <String> selected)` Initializes the calendar widget.
Boolean	`isDateOOM (<Date> date)` Determines whether a given date is OOM (out of month).
void	`nextMonth ()` Navigates to the next month page in the calendar widget.
void	`nextYear ()` Navigates to the next year in the currently selected month in the calendar widget.
void	`onBeforeDeselect ()` Event executed before a date is deselected in the calendar widget.
void	`onBeforeSelect ()` Event executed before a date is selected in the calendar widget.
void	`onChangePage ()` Event executed when the user navigates to a different calendar page.
void	`onClear ()` Event executed when the calendar widget is completely cleared to the current month with no selections.
void	`onDeselect ()` Event executed when a date is deselected in the calendar widget.
void	`onRender ()` Event executed when the calendar widget is rendered.
void	`onReset ()` Event executed when the calendar widget is reset to its original state.
void	`onSelect ()` Event executed when a date is selected in the calendar widget.
void	`previousMonth ()` Navigates to the previous month page in the calendar widget.
void	`previousYear ()` Navigates to the previous year in the currently selected month in the calendar widget.
void	`render ()` Renders the calendar after it has been configured.
void	`renderBody (<Date> workingDate)` Appends the calendar body.
String	`renderBodyCellRestricted (<Date> workingDate, <HTMLTableCellElement> cell)` Renders the current calendar cell as a non-selectable "black-out" date using the default restricted style.
String	`renderCellDefault (<Date> workingDate, <HTMLTableCellElement> cell)` Renders a single standard calendar cell in the calendar widget table.
String	`renderCellNotThisMonth (<Date> workingDate, <HTMLTableCellElement> cell)` Applies the default style used for rendering dates that are not a part of the current month (preceding or trailing the cells for the current month)
String	`renderCellStyleHighlight1 (<Date> workingDate, <HTMLTableCellElement> cell)` Renders a single standard calendar cell using the CSS hightlight1 style
String	`renderCellStyleHighlight2 (<Date> workingDate, <HTMLTableCellElement> cell)` Renders a single standard calendar cell using the CSS hightlight2 style
String	`renderCellStyleHighlight3 (<Date> workingDate, <HTMLTableCellElement> cell)` Renders a single standard calendar cell using the CSS hightlight3 style
String	`renderCellStyleHighlight4 (<Date> workingDate, <HTMLTableCellElement> cell)` Renders a single standard calendar cell using the CSS hightlight4 style
String	`renderCellStyleSelected (<Date> workingDate, <HTMLTableCellElement> cell)` Applies the default style used for rendering selected dates to the current calendar cell
String	`renderCellStyleToday (<Date> workingDate, <HTMLTableCellElement> cell)` Applies the default style used for rendering today's date to the current calendar cell
void	`renderFooter ()` Appends the contents of the calendar widget footer into the shell.
void	`renderHeader ()` Appends the header contents into the widget header.
Object	`renderOutOfBoundsDate (workingDate, cell)` BEGIN BUILT-IN TABLE CELL RENDERERS
void	`renderRowFooter (<Date> workingDate, <HTMLTableCellElement> cell)` Renders the row footer for a week.
void	`renderRowHeader (<Date> workingDate, <HTMLTableCellElement> cell)` Renders the row header for a week.
void	`renderShell ()` Outputs the calendar shell to the DOM, inserting it into the placeholder element.
void	`reset ()` Resets the calendar widget to the originally selected month and year, and sets the calendar to the initial selection(s).
void	`resetRenderers ()` Resets the render stack of the current calendar to its original pre-render value.
Date[]	`select (date)` Selects a date or a collection of dates on the current calendar.
Date[]	`selectCell (<Integer> cellIndex)` Selects a date on the current calendar by referencing the index of the cell that should be selected.
void	`setMonth (<Integer> month)` Sets the calendar's month explicitly.
void	`setupConfig ()` This method is called to initialize the widget configuration variables, including style, localization, and other display and behavioral options.
void	`setYear (<Integer> year)` Sets the calendar's year explicitly.
void	`subtractMonths (<Integer> count)` Subtracts the designated number of months from the current calendar month, and sets the current calendar page date to the new month.
void	`subtractYears (<Integer> count)` Subtcats the designated number of years from the current calendar, and sets the current calendar page date to the new month.
string	`toString ()` Returns a string representation of the object.
Boolean	`validate ()` Validates the calendar widget.
void	`wireCustomEvents ()` This function can be extended by subclasses to attach additional DOM events to the calendar.
void	`wireDefaultEvents ()` Wires the local DOM events for the Calendar, including cell selection, hover, and default navigation that is used for moving back and forth between calendar pages.
String	`_getBrowser ()` Returns a string representing the current browser.
void	`setCssClasses (<HTMLElement> element, aStyles)` Sets the specified array of CSS classes into the referenced element

Field Detail [top]

cellDates


								Array[](Integer[])
								 
								cellDates

The collection of calendar cell dates that is parallel to the cells collection. The array contains dates field arrays in the format of [YYYY, M, D].

Config


								Object
								 
								Config

The configuration object used to set up the calendars various locale and style options.

headerCell


								HTMLTableCellElement
								 
								headerCell

The HTML cell element that represents the main header cell TH used in the calendar table

id


								String
								 
								id

The id that uniquely identifies this calendar. This id should match the id of the placeholder element on the page.

maxDate


								Date
								 
								maxDate

A Date object representing the maximum selectable date

minDate


								Date
								 
								minDate

A Date object representing the minimum selectable date

oDomContainer


								HTMLElement
								 
								oDomContainer

The DOM element reference that points to this calendar's container element. The calendar will be inserted into this element when the shell is rendered.

pageDate


								Date
								 
								pageDate

A Date object representing the month/year that the calendar is currently set to

parent


								CalendarGroup
								 
								parent

The parent CalendarGroup, only to be set explicitly by the parent group

renderStack


								Array[]
								 
								renderStack

The list of render functions, along with required parameters, used to render cells.

selectedDates


								Array[](Integer[])
								 
								selectedDates

The list of currently selected dates. The data format for this local collection is an array of date field arrays, e.g: [ [2004,5,25], [2004,5,26] ]

shellRendered


								Boolean
								 
								shellRendered

A boolean indicating whether the shell of the calendar has already been rendered to the page

table


								HTMLTableElement
								 
								table

The HTML table element that represents this calendar

weekFooterCells


								HTMLTableCellElement[]
								 
								weekFooterCells

The collection of calendar week footer cells

weekHeaderCells


								HTMLTableCellElement[]
								 
								weekHeaderCells

The collection of calendar week header cells

DATE


								String
								 
								DATE

Type constant used for renderers to represent an individual date (M/D/Y)

DISPLAY_DAYS


								Integer
								 
								DISPLAY_DAYS

Constant that represents the total number of date cells that are displayed in a given month including

IMG_ROOT


								String
								 
								IMG_ROOT

The path to be used for images loaded for the Calendar

MONTH


								String
								 
								MONTH

Type constant used for renderers to represent a month across any year

MONTH_DAY


								String
								 
								MONTH_DAY

Type constant used for renderers to represent an individual date across any year (M/D)

RANGE


								String
								 
								RANGE

Type constant used for renderers to represent a range of individual dates (M/D/Y-M/D/Y)

STOP_RENDER


								String
								 
								STOP_RENDER

Constant used for halting the execution of the remainder of the render stack

WEEKDAY


								String
								 
								WEEKDAY

Type constant used for renderers to represent a weekday

Constructor Detail [top]

YAHOO.widget.Calendar_Core


							YAHOO.widget.Calendar_Core
							()

Parameters:: id - The id of the table element that will represent the calendar widget; containerId - The id of the container element that will contain the calendar table; monthyear - The month/year string used to set the current calendar page; 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"

HASH(0x1daea14)

Method Detail [top]

addMonthRenderer


								void 
								addMonthRenderer
								(<Integer> month, <Function> fnRender)

Adds a month to the render stack. The function reference passed to this method will be executed when a date cell matches the month passed to this method.

Parameters:: month - The month (1-12) to associate with this renderer; fnRender - The function executed to render cells that match the render rules for this renderer.

HASH(0x1db6658)

addMonths


								void 
								addMonths
								(<Integer> count)

Adds the designated number of months to the current calendar month, and sets the current calendar page date to the new month.

Parameters:: count - The number of months to add to the current calendar

HASH(0x1db67c0)

addRenderer


								void 
								addRenderer
								(<String> sDates, <Function> fnRender)

Adds a renderer to the render stack. The function reference passed to this method will be executed when a date cell matches the conditions specified in the date string for this renderer.

Parameters:: sDates - A date string to associate with the specified renderer. Valid formats include date (12/24/2005), month/day (12/24), and range (12/1/2004-1/1/2005); fnRender - The function executed to render cells that match the render rules for this renderer.

HASH(0x1db68f8)

addWeekdayRenderer


								void 
								addWeekdayRenderer
								(weekday, <Function> fnRender)

Adds a weekday to the render stack. The function reference passed to this method will be executed when a date cell matches the weekday passed to this method.

Parameters:: fnRender - The function executed to render cells that match the render rules for this renderer.; weekay - The weekday (1-7) to associate with this renderer

HASH(0x1db6a60)

addYears


								void 
								addYears
								(<Integer> count)

Adds the designated number of years to the current calendar, and sets the current calendar page date to the new month.

Parameters:: count - The number of years to add to the current calendar

HASH(0x1db6bc8)

buildDayLabel


								String 
								buildDayLabel
								(workingDate)

Builds the date digit that will be displayed in calendar cells

Returns:: The formatted day label

HASH(0x1db6cf4)

buildMonthLabel


								String 
								buildMonthLabel
								()

Builds the date label that will be displayed in the calendar header or footer, depending on configuration.

Returns:: The formatted calendar month label

HASH(0x1db6dfc)

buildShell


								void 
								buildShell
								()

Builds the calendar table shell that will be filled in with dates and formatting. This method calls buildShellHeader, buildShellBody, and buildShellFooter (in that order) to construct the pieces of the calendar table. The construction of the shell should only happen one time when the calendar is initialized. HASH(0x1dc8020)

buildShellBody


								void 
								buildShellBody
								()

Builds the calendar shell body (6 weeks by 7 days) HASH(0x1dc8140)

buildShellFooter


								void 
								buildShellFooter
								()

Builds the calendar shell footer. In the default implementation, there is no footer. HASH(0x1dc8260)

buildShellHeader


								void 
								buildShellHeader
								()

Builds the calendar shell header by inserting a THEAD into the local calendar table. HASH(0x1dc8380)

clear


								void 
								clear
								()

Clears the selected dates in the current calendar widget and sets the calendar to the current month and year. HASH(0x1dc84a0)

clearAllBodyCellStyles


								void 
								clearAllBodyCellStyles
								(style)

Removes all styles from all body cells in the current calendar table.

Parameters:: The - CSS class name to remove from all calendar body cells

HASH(0x1dc85b4)

clearElement


								void 
								clearElement
								(cell)

Clears the inner HTML, CSS class and style information from the specified cell.

Parameters:: The - cell to clear

HASH(0x1dc86ec)

customConfig


								void 
								customConfig
								()

This method is called when subclasses need to override configuration variables or create new ones. Values can be explicitly set as follows:

this.Config.Style.CSS_CELL = "newcalcell"; this.Config.Locale.MONTHS_SHORT = ["Jan", "Fv", "Mars", "Avr", "Mai", "Juin", "Juil", "Aot", "Sept", "Oct", "Nov", "Dc"];

HASH(0x1dc8830)

deselect


								Date[] 
								deselect
								(date)

Deselects a date or a collection of dates on the current calendar. This method, by default, does not call the render method explicitly. Once deselection has completed, render must be called for the changes to be reflected visually.

Parameters:: String - /Date/Date[]} date The date string of dates to deselect 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.

HASH(0x1dc892c)

deselectAll


								Date[] 
								deselectAll
								()

Deselects all dates on the current calendar.

Returns:: Array of JavaScript Date objects representing all individual dates that are currently selected. Assuming that this function executes properly, the return value should be an empty array. However, the empty array is returned for the sake of being able to check the selection status of the calendar.

HASH(0x1dc8a58)

deselectCell


								Date[] 
								deselectCell
								(i)

Deselects a date on the current calendar by referencing the index of the cell that should be deselected. This method is used to easily deselect a single cell (usually with a mouse click) without having to do a full render. The selected style is removed from the cell directly.

Parameters:: cellIndex - The index of the cell to deselect in the current calendar.

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

HASH(0x1dc8b54)

getSelectedDates


								Date[] 
								getSelectedDates
								()

Gets the list of currently selected dates from the calendar.

Returns:: An array of currently selected JavaScript Date objects.

HASH(0x1dc8c80)

init


								void 
								init
								(<String> id, <String> containerId, <String> monthyear, <String> selected)

Initializes the calendar widget. This method must be called by all subclass constructors.

Parameters:: id - The id of the table element that will represent the calendar widget; containerId - The id of the container element that will contain the calendar table; monthyear - The month/year string used to set the current calendar page; 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"

HASH(0x1dc8d94)

isDateOOM


								Boolean 
								isDateOOM
								(<Date> date)

Determines whether a given date is OOM (out of month).

Parameters:: date - The JavaScript Date object for which to check the OOM status

Returns:: true if the date is OOM

HASH(0x1dc8f44)

nextMonth


								void 
								nextMonth
								()

Navigates to the next month page in the calendar widget. HASH(0x1dca580)

nextYear


								void 
								nextYear
								()

Navigates to the next year in the currently selected month in the calendar widget. HASH(0x1dca6a0)

onBeforeDeselect


								void 
								onBeforeDeselect
								()

Event executed before a date is deselected in the calendar widget. HASH(0x1dca7c0)

onBeforeSelect


								void 
								onBeforeSelect
								()

Event executed before a date is selected in the calendar widget. HASH(0x1dca8e0)

onChangePage


								void 
								onChangePage
								()

Event executed when the user navigates to a different calendar page. HASH(0x1dcaa00)

onClear


								void 
								onClear
								()

Event executed when the calendar widget is completely cleared to the current month with no selections. HASH(0x1dcab20)

onDeselect


								void 
								onDeselect
								()

Event executed when a date is deselected in the calendar widget. HASH(0x1dcac40)

onRender


								void 
								onRender
								()

Event executed when the calendar widget is rendered. HASH(0x1dcad60)

onReset


								void 
								onReset
								()

Event executed when the calendar widget is reset to its original state. HASH(0x1dcae80)

onSelect


								void 
								onSelect
								()

Event executed when a date is selected in the calendar widget. HASH(0x1dcafa0)

previousMonth


								void 
								previousMonth
								()

Navigates to the previous month page in the calendar widget. HASH(0x1dcb0c0)

previousYear


								void 
								previousYear
								()

Navigates to the previous year in the currently selected month in the calendar widget. HASH(0x1dcb1e0)

render


								void 
								render
								()

Renders the calendar after it has been configured. The render() method has a specific call chain that will execute when the method is called: renderHeader, renderBody, renderFooter. Refer to the documentation for those methods for information on individual render tasks. HASH(0x1dcb300)

renderBody


								void 
								renderBody
								(<Date> workingDate)

Appends the calendar body. The default implementation calculates the number of OOM (out of month) cells that need to be rendered at the start of the month, renders those, and renders all the day cells using the built-in cell rendering methods. While iterating through all of the cells, the calendar checks for renderers in the local render stack that match the date of the current cell, and then applies styles as necessary.

Parameters:: workingDate - The current working Date object being used to generate the calendar

HASH(0x1dcb414)

renderBodyCellRestricted


								String 
								renderBodyCellRestricted
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders the current calendar cell as a non-selectable "black-out" date using the default restricted style.

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd3050)

renderCellDefault


								String 
								renderCellDefault
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders a single standard calendar cell in the calendar widget table. All logic for determining how a standard default cell will be rendered is encapsulated in this method, and must be accounted for when extending the widget class.

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd31a0)

renderCellNotThisMonth


								String 
								renderCellNotThisMonth
								(<Date> workingDate, <HTMLTableCellElement> cell)

Applies the default style used for rendering dates that are not a part of the current month (preceding or trailing the cells for the current month)

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd32f0)

renderCellStyleHighlight1


								String 
								renderCellStyleHighlight1
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders a single standard calendar cell using the CSS hightlight1 style

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd3440)

renderCellStyleHighlight2


								String 
								renderCellStyleHighlight2
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders a single standard calendar cell using the CSS hightlight2 style

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd3590)

renderCellStyleHighlight3


								String 
								renderCellStyleHighlight3
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders a single standard calendar cell using the CSS hightlight3 style

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd36e0)

renderCellStyleHighlight4


								String 
								renderCellStyleHighlight4
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders a single standard calendar cell using the CSS hightlight4 style

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd3830)

renderCellStyleSelected


								String 
								renderCellStyleSelected
								(<Date> workingDate, <HTMLTableCellElement> cell)

Applies the default style used for rendering selected dates to the current calendar cell

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd3980)

renderCellStyleToday


								String 
								renderCellStyleToday
								(<Date> workingDate, <HTMLTableCellElement> cell)

Applies the default style used for rendering today's date to the current calendar cell

Parameters:: workingDate - The current working Date object being used to generate the calendar; cell - The current working cell in the calendar

Returns:: YAHOO.widget.Calendar_Core.STOP_RENDER if rendering should stop with this style, null or nothing if rendering should not be terminated

HASH(0x1dd3ad0)

renderFooter


								void 
								renderFooter
								()

Appends the contents of the calendar widget footer into the shell. By default, the calendar does not contain a footer, and this method must be implemented by subclassing the widget. HASH(0x1dd3c44)

renderHeader


								void 
								renderHeader
								()

Appends the header contents into the widget header. HASH(0x1dd3d64)

renderOutOfBoundsDate


								Object 
								renderOutOfBoundsDate
								(workingDate, cell)

BEGIN BUILT-IN TABLE CELL RENDERERS HASH(0x1dd3e84)

renderRowFooter


								void 
								renderRowFooter
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders the row footer for a week. The date passed in should be the first date of the given week.

Parameters:: workingDate - The current working Date object (beginning of the week) being used to generate the calendar; cell - The current working cell in the calendar

HASH(0x1dd3f8c)

renderRowHeader


								void 
								renderRowHeader
								(<Date> workingDate, <HTMLTableCellElement> cell)

Renders the row header for a week. The date passed in should be the first date of the given week.

Parameters:: workingDate - The current working Date object (beginning of the week) being used to generate the calendar; cell - The current working cell in the calendar

HASH(0x1de0a58)

renderShell


								void 
								renderShell
								()

Outputs the calendar shell to the DOM, inserting it into the placeholder element. HASH(0x1de0bcc)

reset


								void 
								reset
								()

Resets the calendar widget to the originally selected month and year, and sets the calendar to the initial selection(s). HASH(0x1de0cec)

resetRenderers


								void 
								resetRenderers
								()

Resets the render stack of the current calendar to its original pre-render value. HASH(0x1de0e0c)

select


								Date[] 
								select
								(date)

Selects a date or a collection of dates on the current calendar. This method, by default, does not call the render method explicitly. Once selection has completed, render must be called for the changes to be reflected visually.

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.

HASH(0x1de0f08)

selectCell


								Date[] 
								selectCell
								(<Integer> cellIndex)

Selects a date on the current calendar by referencing the index of the cell that should be selected. This method is used to easily select a single cell (usually with a mouse click) without having to do a full render. The selected style is applied to the cell directly.

Parameters:: 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.

HASH(0x1de1028)

setMonth


								void 
								setMonth
								(<Integer> month)

Sets the calendar's month explicitly.

Parameters:: month - The numeric month, from 1 (January) to 12 (December)

HASH(0x1de1160)

setupConfig


								void 
								setupConfig
								()

This method is called to initialize the widget configuration variables, including style, localization, and other display and behavioral options.

Config: Container for the CSS style configuration variables.

Config.Style - Defines the CSS classes used for different calendar elements

CSS_CALENDAR : Container table

CSS_HEADER :

CSS_HEADER_TEXT : Calendar header

CSS_FOOTER : Calendar footer

CSS_CELL : Calendar day cell

CSS_CELL_OOM : Calendar OOM (out of month) cell

CSS_CELL_SELECTED : Calendar selected cell

CSS_CELL_RESTRICTED : Calendar restricted cell

CSS_CELL_TODAY : Calendar cell for today's date

CSS_ROW_HEADER : The cell preceding a row (used for week number by default)

CSS_ROW_FOOTER : The cell following a row (not implemented by default)

CSS_WEEKDAY_CELL : The cells used for labeling weekdays

CSS_WEEKDAY_ROW : The row containing the weekday label cells

CSS_CONTAINER : The border style used for the default UED rendering

CSS_2UPWRAPPER : Special container class used to properly adjust the sizing and float

CSS_NAV_LEFT : Left navigation arrow

CSS_NAV_RIGHT : Right navigation arrow

CSS_CELL_TOP : Outlying cell along the top row

CSS_CELL_LEFT : Outlying cell along the left row

CSS_CELL_RIGHT : Outlying cell along the right row

CSS_CELL_BOTTOM : Outlying cell along the bottom row

CSS_CELL_HOVER : Cell hover style

CSS_CELL_HIGHLIGHT1 : Highlight color 1 for styling cells

CSS_CELL_HIGHLIGHT2 : Highlight color 2 for styling cells

CSS_CELL_HIGHLIGHT3 : Highlight color 3 for styling cells

CSS_CELL_HIGHLIGHT4 : Highlight color 4 for styling cells

Config.Locale - Defines the locale string arrays used for localization

MONTHS_SHORT : Array of 12 months in short format ("Jan", "Feb", etc.)

MONTHS_LONG : Array of 12 months in short format ("Jan", "Feb", etc.)

WEEKDAYS_1CHAR : Array of 7 days in 1-character format ("S", "M", etc.)

WEEKDAYS_SHORT : Array of 7 days in short format ("Su", "Mo", etc.)

WEEKDAYS_MEDIUM : Array of 7 days in medium format ("Sun", "Mon", etc.)

WEEKDAYS_LONG : Array of 7 days in long format ("Sunday", "Monday", etc.)

DATE_DELIMITER : The value used to delimit series of multiple dates (Default: ",")

DATE_FIELD_DELIMITER : The value used to delimit date fields (Default: "/")

DATE_RANGE_DELIMITER : The value used to delimit date fields (Default: "-")

MY_MONTH_POSITION : The value used to determine the position of the month in a month/year combo (e.g. 12/2005) (Default: 1)

MY_YEAR_POSITION : The value used to determine the position of the year in a month/year combo (e.g. 12/2005) (Default: 2)

MD_MONTH_POSITION : The value used to determine the position of the month in a month/day combo (e.g. 12/25) (Default: 1)

MD_DAY_POSITION : The value used to determine the position of the day in a month/day combo (e.g. 12/25) (Default: 2)

MDY_MONTH_POSITION : The value used to determine the position of the month in a month/day/year combo (e.g. 12/25/2005) (Default: 1)

MDY_DAY_POSITION : The value used to determine the position of the day in a month/day/year combo (e.g. 12/25/2005) (Default: 2)

MDY_YEAR_POSITION : The value used to determine the position of the year in a month/day/year combo (e.g. 12/25/2005) (Default: 3)

Config.Options - Defines other configurable calendar widget options

SHOW_WEEKDAYS : Boolean, determines whether to display the weekday headers (defaults to true)

LOCALE_MONTHS : Array, points to the desired Config.Locale array (defaults to Config.Locale.MONTHS_LONG)

LOCALE_WEEKDAYS : Array, points to the desired Config.Locale array (defaults to Config.Locale.WEEKDAYS_SHORT)

START_WEEKDAY : Integer, 0-6, representing the day that a week begins on

SHOW_WEEK_HEADER : Boolean, determines whether to display row headers

SHOW_WEEK_FOOTER : Boolean, determines whether to display row footers

HIDE_BLANK_WEEKS : Boolean, determines whether to hide extra weeks that are completely OOM

NAV_ARROW_LEFT : String, the image path used for the left navigation arrow

NAV_ARROW_RIGHT : String, the image path used for the right navigation arrow

HASH(0x1de12a4)

setYear


								void 
								setYear
								(<Integer> year)

Sets the calendar's year explicitly.

Parameters:: year - The numeric 4-digit year

HASH(0x1de13b8)

subtractMonths


								void 
								subtractMonths
								(<Integer> count)

Subtracts the designated number of months from the current calendar month, and sets the current calendar page date to the new month.

Parameters:: count - The number of months to subtract from the current calendar

HASH(0x1de14f0)

subtractYears


								void 
								subtractYears
								(<Integer> count)

Subtcats the designated number of years from the current calendar, and sets the current calendar page date to the new month.

Parameters:: count - The number of years to subtract from the current calendar

HASH(0x1de1628)

toString


								string 
								toString
								()

Returns a string representation of the object. HASH(0x1de176c)

validate


								Boolean 
								validate
								()

Validates the calendar widget. This method has no default implementation and must be extended by subclassing the widget.

Returns:: Should return true if the widget validates, and false if it doesn't.

HASH(0x1de1874)

wireCustomEvents


								void 
								wireCustomEvents
								()

This function can be extended by subclasses to attach additional DOM events to the calendar. By default, this method is unimplemented. HASH(0x1dec090)

wireDefaultEvents


								void 
								wireDefaultEvents
								()

Wires the local DOM events for the Calendar, including cell selection, hover, and default navigation that is used for moving back and forth between calendar pages. HASH(0x1dec1b0)

_getBrowser


								String 
								_getBrowser
								()

Returns a string representing the current browser. HASH(0x1dec2d0)

setCssClasses


								void 
								setCssClasses
								(<HTMLElement> element, aStyles)

Sets the specified array of CSS classes into the referenced element

Parameters:: element - The element to set the CSS classes into; String - []} aStyles An array of CSS class names

HASH(0x1dec3e4)