Classes

Files

Class YAHOO.widget.CalendarGroup

Object
   |
   +--YAHOO.widget.CalendarGroup
Direct Known Subclasses:
YAHOO.widget.Calendar2up
class YAHOO.widget.CalendarGroup
Quick Links:  Constructor Summary | Method Summary | Method Details

Constructor Summary [top]

YAHOO.widget.CalendarGroup
 

Method Summary [top]

void addMonthRenderer
Calls the addMonthRenderer function of all child calendars within the group. 
void addRenderer
Calls the addRenderer function of all child calendars within the group. 
void addWeekdayRenderer
Calls the addWeekdayRenderer function of all child calendars within the group. 
void callChildFunction
 
void clear
Calls the clear function of all child calendars within the group. 
YAHOO.widget.Calendar_Core constructChild
Constructs a child calendar. 
Object deselect
Calls the deselect function of all child calendars within the group. 
Object deselectAll
Calls the deselectAll function of all child calendars within the group. 
Object deselectCell
Calls the deselectAll function of all child calendars within the group. 
Date[] getSelectedDates
Gets the list of currently selected dates from the calendar. 
void init
Initializes the calendar group. 
void nextMonth
Calls the nextMonth function of all child calendars within the group. 
void nextYear
Calls the nextYear function of all child calendars within the group. 
void previousMonth
Calls the previousMonth function of all child calendars within the group. 
void previousYear
Calls the previousYear function of all child calendars within the group. 
void render
Calls the render function of all child calendars within the group. 
void reset
Calls the reset function of all child calendars within the group. 
Object select
Calls the select function of all child calendars within the group. 
Object selectCell
Calls the selectCell function of all child calendars within the group. 
void setChildFunction
 
void setMonth
Sets the calendar group's month explicitly. 
void setYear
Sets the calendar group's year explicitly. 
Date[] sync
Synchronizes the data values for all child calendars within the group. 
void wireEvent
Sets an event handler universally across all child calendars within the group. 

Constructor Detail [top]

YAHOO.widget.CalendarGroup

YAHOO.widget.CalendarGroup ()
Parameters:
pageCount - The number of pages that this calendar should display.
id - The id of the element that will be inserted into the DOM.
containerId - The id of the container element that the calendar will be inserted into.
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"

Method Detail [top]

addMonthRenderer

void addMonthRenderer
Calls the addMonthRenderer function of all child calendars within the group.

addRenderer

void addRenderer
Calls the addRenderer function of all child calendars within the group.

addWeekdayRenderer

void addWeekdayRenderer
Calls the addWeekdayRenderer function of all child calendars within the group.

callChildFunction

void callChildFunction

clear

void clear
Calls the clear function of all child calendars within the group.

constructChild

YAHOO.widget.Calendar_Core constructChild
Constructs a child calendar. This method can be overridden if a subclassed version of the default calendar is to be used.
Returns:
The YAHOO.widget.Calendar_Core instance that is constructed

deselect

Object deselect
Calls the deselect function of all child calendars within the group.

deselectAll

Object deselectAll
Calls the deselectAll function of all child calendars within the group.

deselectCell

Object deselectCell
Calls the deselectAll function of all child calendars within the group.

getSelectedDates

Date[] getSelectedDates
Gets the list of currently selected dates from the calendar.
Returns:
An array of currently selected JavaScript Date objects.

init

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

nextMonth

void nextMonth
Calls the nextMonth function of all child calendars within the group.

nextYear

void nextYear
Calls the nextYear function of all child calendars within the group.

previousMonth

void previousMonth
Calls the previousMonth function of all child calendars within the group.

previousYear

void previousYear
Calls the previousYear function of all child calendars within the group.

render

void render
Calls the render function of all child calendars within the group.

reset

void reset
Calls the reset function of all child calendars within the group.

select

Object select
Calls the select function of all child calendars within the group.

selectCell

Object selectCell
Calls the selectCell function of all child calendars within the group.

setChildFunction

void setChildFunction

setMonth

void setMonth
Sets the calendar group's month explicitly. This month will be set into the first page of the multi-page calendar, and all other months will be iterated appropriately.

setYear

void setYear
Sets the calendar group's year explicitly. This year will be set into the first page of the multi-page calendar, and all other months will be iterated appropriately.

sync

Date[] sync
Synchronizes the data values for all child calendars within the group. If the sync method is called passing in the caller object, the values of all children will be set to the values of the caller. If the argument is ommitted, the values from all children will be combined into one distinct list and set into each child.
Returns:
Array of selected dates, in JavaScript Date object form.

wireEvent

void wireEvent
Sets an event handler universally across all child calendars within the group. For instance, to set the onSelect handler for all child calendars to a function called fnSelect, the call would be: calGroup.wireEvent("onSelect", fnSelect);