YAHOO.widget.CalendarGroup
YAHOO.widget.CalendarGroup is a special container class for YAHOO.widget.Calendar_Core.
Object | +--YAHOO.widget.CalendarGroup
YAHOO.widget.CalendarGroup
YAHOO.widget.CalendarGroup is a special container class for YAHOO.widget.Calendar_Core.
void |
addMonthRenderer
(month, fnRender)
Calls the addMonthRenderer function of all child calendars within the group.
|
void |
addRenderer
(sDates, fnRender)
Calls the addRenderer function of all child calendars within the group.
|
void |
addWeekdayRenderer
(weekday, fnRender)
Calls the addWeekdayRenderer function of all child calendars within the group.
|
void |
callChildFunction
(<String> fnName, <Array> args)
Calls a function within all child Calendars within this CalendarGroup.
|
void |
clear
()
Calls the clear function of all child calendars within the group.
|
YAHOO.widget.Calendar_Core |
constructChild
(<String> id,<String> containerId,<String> monthyear,<String> selected)
Constructs a child calendar.
|
Object |
deselect
(date)
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
(cellIndex)
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
(<Integer> pageCount, <String> id, <String> containerId, <String> monthyear, <String> selected)
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
(date)
Calls the select function of all child calendars within the group.
|
Object |
selectCell
(cellIndex)
Calls the selectCell function of all child calendars within the group.
|
void |
setChildFunction
(<String> fnName, <Function> fn)
Adds a function to all child Calendars within this CalendarGroup.
|
void |
setMonth
(<Integer> month)
Sets the calendar group's month explicitly.
|
void |
setYear
(<Integer> year)
Sets the calendar group's year explicitly.
|
Date[] |
sync
(<YAHOO.widget.Calendar_Core> caller)
Synchronizes the data values for all child calendars within the group.
|
string |
toString
()
Returns a string representation of the object.
|
void |
wireEvent
(<String> eventName, <Function> fn)
Sets an event handler universally across all child calendars within the group.
|
YAHOO.widget.CalendarGroup
()
YAHOO.widget.CalendarGroup is a special container class for YAHOO.widget.Calendar_Core. This class facilitates the ability to have multi-page calendar views that share a single dataset and are dependent on each other.
The calendar group instance will refer to each of its elements using a 0-based index. For example, to construct the placeholder for a calendar group widget with id "cal1" and containerId of "cal1Container", the markup would be as follows:
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"
void
addMonthRenderer
(month, fnRender)
void
addRenderer
(sDates, fnRender)
void
addWeekdayRenderer
(weekday, fnRender)
void
callChildFunction
(<String> fnName, <Array> args)
fnName
-
The name of the function
args
-
The arguments to pass to the function
void
clear
()
YAHOO.widget.Calendar_Core
constructChild
(<String> id,<String> containerId,<String> monthyear,<String> selected)
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"
Object
deselect
(date)
Object
deselectAll
()
Object
deselectCell
(cellIndex)
Date[]
getSelectedDates
()
void
init
(<Integer> pageCount, <String> id, <String> containerId, <String> monthyear, <String> selected)
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"
void
nextMonth
()
void
nextYear
()
void
previousMonth
()
void
previousYear
()
void
render
()
void
reset
()
Object
select
(date)
Object
selectCell
(cellIndex)
void
setChildFunction
(<String> fnName, <Function> fn)
fnName
-
The name of the function
fn
-
The function to apply to each Calendar page object
void
setMonth
(<Integer> month)
month
-
The numeric month, from 1 (January) to 12 (December)
void
setYear
(<Integer> year)
year
-
The numeric 4-digit year
Date[]
sync
(<YAHOO.widget.Calendar_Core> caller)
caller
-
The YAHOO.widget.Calendar_Core that is initiating the call to sync().
string
toString
()
void
wireEvent
(<String> eventName, <Function> fn)
calGroup.wireEvent("onSelect", fnSelect);
eventName
-
The name of the event to handler to set within all child calendars.
fn
-
The function to set into the specified event handler.