|
addMonthRenderer(Number month , Function fnRender ) : void |
Calendar |
Adds a month to the render stack. The function reference passed to this method will be executed
when a date cell matc... |
|
addMonths(Number count ) : void |
Calendar |
Adds the designated number of months to the current calendar month, and sets the current
calendar page date to the ne... |
|
addRenderer(String sDates , Function fnRender ) : void |
Calendar |
Adds a renderer to the render stack. The function reference passed to this method will be executed
when a date cell m... |
|
addWeekdayRenderer(Number weekday , Function fnRender ) : void |
Calendar |
Adds a weekday to the render stack. The function reference passed to this method will be executed
when a date cell ma... |
|
addYears(Number count ) : void |
Calendar |
Adds the designated number of years to the current calendar, and sets the current
calendar page date to the new month. |
|
applyListeners() : void |
Calendar |
Applies the Calendar's DOM listeners to applicable elements. |
|
buildDayLabel(Date workingDate ) : String |
Calendar |
Builds the date digit that will be displayed in calendar cells |
|
buildMonthLabel() : String |
Calendar |
Builds the date label that will be displayed in the calendar header or
footer, depending on configuration. |
|
buildWeekdays(Array html ) : Array |
Calendar |
Renders the Calendar's weekday headers. |
|
clear() : void |
Calendar |
Clears the selected dates in the current calendar widget and sets the calendar
to the current month and year. |
|
clearAllBodyCellStyles(style The ) : void |
Calendar |
Removes all styles from all body cells in the current calendar table. |
|
clearElement(HTMLTableCellElement The ) : void |
Calendar |
Clears the inner HTML, CSS class and style information from the specified cell. |
|
configClose() : void |
Calendar |
Default handler for the "close" property |
|
configIframe() : void |
Calendar |
Renders the built-in IFRAME shim for the IE6 and below |
|
configLocale() : void |
Calendar |
The default handler for all configuration locale properties |
|
configLocaleValues() : void |
Calendar |
The default handler for all configuration locale field length properties |
|
configMaxDate() : void |
Calendar |
The default handler for the "maxdate" property |
|
configMinDate() : void |
Calendar |
The default handler for the "mindate" property |
|
configOptions() : void |
Calendar |
The default handler for all configuration options properties |
|
configPageDate() : void |
Calendar |
The default handler for the "pagedate" property |
|
configSelected() : void |
Calendar |
The default handler for the "selected" property |
|
configTitle() : void |
Calendar |
Default handler for the "title" property |
|
deselect(String/Date/Date[] date ) : Date[] |
Calendar |
Deselects a date or a collection of dates on the current calendar. This method, by default,
does not call the render ... |
|
deselectAll() : Date[] |
Calendar |
Deselects all dates on the current calendar. |
|
deselectCell(Number cellIndex ) : Date[] |
Calendar |
Deselects a date on the current calendar by referencing the index of the cell that should be deselected.
This method ... |
|
doCellMouseOut(DOMEvent e , Calendar cal ) : void |
Calendar |
The event that is executed when the user moves the mouse out of a cell |
|
doCellMouseOver(DOMEvent e , Calendar cal ) : void |
Calendar |
The event that is executed when the user hovers over a cell |
|
doSelectCell(DOMEvent e , Calendar cal ) : void |
Calendar |
The default event function that is attached to a date link within a calendar cell
when the calendar is rendered. |
|
getDateByCellId(String id ) : Date |
Calendar |
Retrieves the Date object for the specified Calendar cell |
|
getDateFieldsByCellId(String id ) : Array |
Calendar |
Retrieves the Date object for the specified Calendar cell |
|
getSelectedDates() : Date[] |
Calendar |
Gets the list of currently selected dates from the calendar. |
|
hide() : void |
Calendar |
Hides the Calendar's outer container from view. |
|
init(String id , String containerId , Object config ) : void |
Calendar |
Initializes the Calendar widget. |
|
initEvents() : void |
Calendar |
Initializes Calendar's built-in CustomEvents |
|
initStyles() : void |
Calendar |
Defines the style constants for the Calendar |
|
isDateOOM(Date date ) : Boolean |
Calendar |
Determines whether a given date is OOM (out of month). |
|
nextMonth() : void |
Calendar |
Navigates to the next month page in the calendar widget. |
|
nextYear() : void |
Calendar |
Navigates to the next year in the currently selected month in the calendar widget. |
|
onBeforeDeselect() : void |
Calendar |
Deprecated. Event executed before a date is deselected in the calendar widget. |
|
onBeforeSelect() : void |
Calendar |
Deprecated. Event executed before a date is selected in the calendar widget. |
|
onChangePage() : void |
Calendar |
Deprecated. Event executed when the user navigates to a different calendar page. |
|
onDeselect(Array selected ) : void |
Calendar |
Deprecated. Event executed when a date is deselected in the calendar widget. |
|
onRender() : void |
Calendar |
Deprecated. Event executed when the calendar widget is rendered. |
|
onSelect(Array selected ) : void |
Calendar |
Deprecated. Event executed when a date is selected in the calendar widget. |
|
previousMonth() : void |
Calendar |
Navigates to the previous month page in the calendar widget. |
|
previousYear() : void |
Calendar |
Navigates to the previous year in the currently selected month in the calendar widget. |
|
render() : void |
Calendar |
Deprecated. Event executed when the calendar widget is completely cleared to the current month with no selections. |
|
renderBody(Date workingDate , Array html ) : Array |
Calendar |
Renders the calendar body. |
|
renderBodyCellRestricted(Date workingDate , HTMLTableCellElement cell ) : String |
Calendar |
Renders the current calendar cell as a non-selectable "black-out" date using the default
restricted style. |
|
renderCellDefault(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Renders a single standard calendar cell in the calendar widget table.
All logic for determining how a standard defaul... |
|
renderCellNotThisMonth(Date workingDate , HTMLTableCellElement cell ) : String |
Calendar |
Applies the default style used for rendering dates that are not a part of the current
month (preceding or trailing th... |
|
renderCellStyleHighlight1(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Renders a single standard calendar cell using the CSS hightlight1 style |
|
renderCellStyleHighlight2(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Renders a single standard calendar cell using the CSS hightlight2 style |
|
renderCellStyleHighlight3(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Renders a single standard calendar cell using the CSS hightlight3 style |
|
renderCellStyleHighlight4(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Renders a single standard calendar cell using the CSS hightlight4 style |
|
renderCellStyleSelected(Date workingDate , HTMLTableCellElement cell ) : String |
Calendar |
Applies the default style used for rendering selected dates to the current calendar cell |
|
renderCellStyleToday(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Applies the default style used for rendering today's date to the current calendar cell |
|
renderFooter(Array html ) : Array |
Calendar |
Renders the calendar footer. In the default implementation, there is
no footer. |
|
renderHeader(Array html ) : Array |
Calendar |
Renders the calendar header. |
|
renderOutOfBoundsDate(Date workingDate , HTMLTableCellElement cell ) : String |
Calendar |
Renders a cell that falls before the minimum date or after the maximum date.
widget class. |
|
renderRowFooter(Number weekNum , Array cell ) : void |
Calendar |
Renders the row footer for a week. |
|
renderRowHeader(Number weekNum , Array cell ) : void |
Calendar |
Renders the row header for a week. |
|
reset() : void |
Calendar |
Resets the calendar widget to the originally selected month and year, and
sets the calendar to the initial selection(s). |
|
resetRenderers() : void |
Calendar |
Resets the render stack of the current calendar to its original pre-render value. |
|
select(String/Date/Date[] date ) : Date[] |
Calendar |
Selects a date or a collection of dates on the current calendar. This method, by default,
does not call the render me... |
|
selectCell(Number cellIndex ) : Date[] |
Calendar |
Selects a date on the current calendar by referencing the index of the cell that should be selected.
This method is u... |
|
setMonth(Number month ) : void |
Calendar |
Sets the calendar's month explicitly |
|
setYear(Number year ) : void |
Calendar |
Sets the calendar's year explicitly. |
|
show() : void |
Calendar |
Shows the Calendar's outer container. |
|
styleCellDefault(Date workingDate , HTMLTableCellElement cell ) : void |
Calendar |
Styles a selectable cell. |
|
subtractMonths(Number count ) : void |
Calendar |
Subtracts the designated number of months from the current calendar month, and sets the current
calendar page date to... |
|
subtractYears(Number count ) : void |
Calendar |
Subtcats the designated number of years from the current calendar, and sets the current
calendar page date to the new... |
|
toString() : String |
Calendar |
Returns a string representation of the object. |
|
validate() : Should |
Calendar |
Validates the calendar widget. This method has no default implementation
and must be extended by subclassing the widget. |
CSS_CALENDAR
public Object CSS_CALENDAR
CSS_CELL
public Object CSS_CELL
CSS_CELL_BOTTOM
public Object CSS_CELL_BOTTOM
CSS_CELL_HIGHLIGHT1
public Object CSS_CELL_HIGHLIGHT1
CSS_CELL_HIGHLIGHT2
public Object CSS_CELL_HIGHLIGHT2
CSS_CELL_HIGHLIGHT3
public Object CSS_CELL_HIGHLIGHT3
CSS_CELL_HIGHLIGHT4
public Object CSS_CELL_HIGHLIGHT4
CSS_CELL_HOVER
public Object CSS_CELL_HOVER
CSS_CELL_LEFT
public Object CSS_CELL_LEFT
CSS_CELL_OOB
public Object CSS_CELL_OOB
CSS_CELL_OOM
public Object CSS_CELL_OOM
CSS_CELL_RESTRICTED
public Object CSS_CELL_RESTRICTED
CSS_CELL_RIGHT
public Object CSS_CELL_RIGHT
CSS_CELL_SELECTABLE
public Object CSS_CELL_SELECTABLE
CSS_CELL_SELECTED
public Object CSS_CELL_SELECTED
CSS_CELL_TODAY
public Object CSS_CELL_TODAY
CSS_CELL_TOP
public Object CSS_CELL_TOP
CSS_CONTAINER
public Object CSS_CONTAINER
CSS_FOOTER
public Object CSS_FOOTER
CSS_HEADER
public Object CSS_HEADER
CSS_HEADER_TEXT
public Object CSS_HEADER_TEXT
CSS_NAV_LEFT
public Object CSS_NAV_LEFT
CSS_NAV_RIGHT
public Object CSS_NAV_RIGHT
CSS_ROW_FOOTER
public Object CSS_ROW_FOOTER
CSS_ROW_HEADER
public Object CSS_ROW_HEADER
CSS_SINGLE
public Object CSS_SINGLE
CSS_WEEKDAY_CELL
public Object CSS_WEEKDAY_CELL
CSS_WEEKDAY_ROW
public Object CSS_WEEKDAY_ROW
DATE<static>
public String DATE<static>
<static> Type constant used for renderers to represent an individual date (M/D/Y)
DISPLAY_DAYS<static>
public Number DISPLAY_DAYS<static>
<static> Constant that represents the total number of date cells that are displayed in a given month
Locale
public Object Locale
The local object which contains the Calendar's locale settings
MONTH<static>
public String MONTH<static>
<static> Type constant used for renderers to represent a month across any year
MONTH_DAY<static>
public String MONTH_DAY<static>
<static> Type constant used for renderers to represent an individual date across any year (M/D)
Options
public Object Options
The local object which contains the Calendar's options
RANGE<static>
public String RANGE<static>
<static> Type constant used for renderers to represent a range of individual dates (M/D/Y-M/D/Y)
STOP_RENDER<static>
public String STOP_RENDER<static>
<static> Constant used for halting the execution of the remainder of the render stack
Style
public Object Style
Collection of Style constants for the Calendar
WEEKDAY<static>
public String WEEKDAY<static>
<static> Type constant used for renderers to represent a weekday
browser
public String browser
Returns a string representing the current browser.
cellDates
public Array[](Number[]) 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].
cells
public HTMLTableCellElement[] cells
The collection of calendar table cells
cfg
public YAHOO.util.Config cfg
The Config object used to hold the configuration variables for the Calendar
domEventMap
public Object domEventMap
A map of DOM event handlers to attach to cells associated with specific CSS class names
https
public String https
<static> The path to be used for images loaded for the Calendar
id
public String id
The id that uniquely identifies this calendar. This id should match the id of the placeholder element on the page.
index
public Number index
The index of this item in the parent group
oDomContainer
public 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.
parent
public CalendarGroup parent
The parent CalendarGroup, only to be set explicitly by the parent group
renderStack
public Array[] renderStack
The list of render functions, along with required parameters, used to render cells.
today
public Date today
A Date object representing today's date.