dijit/Calendar.js

• Provides:

  • dijit.Calendar

• Requires:

  • dojo.cldr.supplemental in common
  • dojo.date in common
  • dojo.date.locale in common
  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._CssStateMixin in common
  • dijit.form.DropDownButton in common

• dijit.Calendar

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._CssStateMixin.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
    • dijit._CssStateMixin: (call)
  • parameters:
    • args: (typeof Object)
  • summary

    A simple GUI for choosing a date in the context of a monthly calendar.

  • description

    A simple GUI for choosing a date in the context of a monthly calendar.
    This widget can't be used in a form because it doesn't serialize the date to an
    `<input>` field.  For a form element, use dijit.form.DateTextBox instead.
    
    Note that the parser takes all dates attributes passed in the
    [RFC 3339 format](http://www.faqs.org/rfcs/rfc3339.html), e.g. `2005-06-30T08:05:00-07:00`
    so that they are serializable and locale-independent.

  • example

    	var calendar = new dijit.Calendar({}, dojo.byId("calendarNode"));

  • example

    	<div dojoType="dijit.Calendar"></div>

• dijit.Calendar.templateString

  • type

    Object

• dijit.Calendar.widgetsInTemplate

  • type

    Object

• dijit.Calendar.value

  • type

    Date

  • summary

    The currently selected Date, initially set to invalid date to indicate no selection.
    
    
    TODO: for 2.0 make this a string (ISO format) rather than a Date

• dijit.Calendar.datePackage

  • type

    String

  • summary

    JavaScript namespace to find Calendar routines.  Uses Gregorian Calendar routines
    at dojo.date by default.

• dijit.Calendar.dayWidth

  • type

    String

  • summary

    How to represent the days of the week in the calendar header. See dojo.date.locale

• dijit.Calendar.tabIndex

  • type

    Integer

  • summary

    Order fields are traversed when user hits the tab key

• dijit.Calendar.currentFocus

  • type

    Date

  • summary

    Date object containing the currently focused date, or the date which would be focused
    if the calendar itself was focused.   Also indicates which year and month to display,
    i.e. the current "page" the calendar is on.

• dijit.Calendar.baseClass

  • type

    String

• dijit.Calendar.cssStateNodes

  • type

    Object

• dijit.Calendar.cssStateNodes.decrementMonth

  • type

    String

• dijit.Calendar.cssStateNodes.incrementMonth

  • type

    String

• dijit.Calendar.cssStateNodes.previousYearLabelNode

  • type

    String

• dijit.Calendar.cssStateNodes.nextYearLabelNode

  • type

    String

• dijit.Calendar._isValidDate

  • parameters:
    • value: (typeof Date)
  • summary

    Runs various tests on the value, checking that it's a valid date, rather
    than blank or NaN.

  • tags:
  • type

    Function

• dijit.Calendar.setValue

  • parameters:
    • value: (typeof Date)
  • summary

    Deprecated.   Use set('value', ...) instead.

  • tags:
  • type

    Function

• dijit.Calendar._getValueAttr

  • summary

    Support get('value')

  • type

    Function

• dijit.Calendar._setValueAttr

  • parameters:
    • value: (typeof Date|Number)

      Either a Date or the number of seconds since 1970.

    • priorityChange: (typeof Boolean)
  • summary

    Support set("value", ...)

  • description

    Set the current date and update the UI.  If the date is disabled, the value will
    not change, but the display will change to the corresponding month.

  • tags:
  • type

    Function

• dijit.Calendar._setText

  • parameters:
    • node
    • text
  • summary

    This just sets the content of node to the specified text.
    Can't do "node.innerHTML=text" because of an IE bug w/tables, see #3434.

  • tags:
  • type

    Function

• dijit.Calendar._populateGrid

  • summary

    Fills in the calendar grid with each day (1-31)

  • tags:
  • type

    Function

• dijit.Calendar.monthDropDownButton.containerNode.innerHTML

  • type

    String

• dijit.Calendar.goToToday

  • summary

    Sets calendar's value to today's date

  • type

    Function

• dijit.Calendar.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

• dijit.Calendar.postMixInProperties

  • type

    Function

• dijit.Calendar.buildRendering

  • type

    Function

• dijit.Calendar.monthDropDownButton.dropDown

  • type

    Object

• dijit.Calendar._adjustDisplay

  • parameters:
    • part: (typeof String)

      "month" or "year"

    • amount: (typeof int)

      Number of months or years

  • summary

    Moves calendar forwards or backwards by months or years

  • tags:
  • type

    Function

• dijit.Calendar._setCurrentFocusAttr

  • parameters:
    • date: (typeof Date)
    • forceFocus: (typeof Boolean)

      If true, will focus() the cell even if calendar itself doesn't have focus

  • summary

    If the calendar currently has focus, then focuses specified date,
    changing the currently displayed month/year if necessary.
    If the calendar doesn't have focus, updates currently
    displayed month/year, and sets the cell that will get focus.

  • type

    Function

• dijit.Calendar.focus

  • summary

    Focus the calendar by focusing one of the calendar cells

  • type

    Function

• dijit.Calendar._onMonthSelect

  • parameters:
    • newMonth: (typeof Number)
  • summary

    Handler for when user selects a month from the drop down list

  • tags:
  • type

    Function

• dijit.Calendar._onDayClick

  • parameters:
    • evt: (typeof Event)
  • summary

    Handler for day clicks, selects the date if appropriate

  • tags:
  • type

    Function

• dijit.Calendar._onDayMouseOver

  • parameters:
    • evt: (typeof Event)
  • summary

    Handler for mouse over events on days, sets hovered style

  • tags:
  • type

    Function

• dijit.Calendar._currentNode

  • type

    Object

• dijit.Calendar._onDayMouseOut

  • parameters:
    • evt: (typeof Event)
  • summary

    Handler for mouse out events on days, clears hovered style

  • tags:
  • type

    Function

• dijit.Calendar._onDayMouseDown

  • parameters:
    • evt: (typeof Event)
  • type

    Function

• dijit.Calendar._onDayMouseUp

  • parameters:
    • evt: (typeof Event)
  • type

    Function

• dijit.Calendar.handleKey

  • parameters:
    • evt: (typeof Event)
  • summary

    Provides keyboard navigation of calendar.

  • description

    Called from _onKeyPress() to handle keypress on a stand alone Calendar,
    and also from `dijit.form._DateTimeTextBox` to pass a keypress event
    from the `dijit.form.DateTextBox` to be handled in this widget

  • return_summary

    False if the key was recognized as a navigation key,
    to indicate that the event was handled by Calendar and shouldn't be propogated

  • tags:
  • type

    Function

• dijit.Calendar._onKeyPress

  • parameters:
    • evt: (typeof Event)
  • summary

    For handling keypress events on a stand alone calendar

  • type

    Function

• dijit.Calendar.onValueSelected

  • parameters:
    • date: (typeof Date)
  • summary

    Notification that a date cell was selected.  It may be the same as the previous value.

  • description

    Formerly used by `dijit.form._DateTimeTextBox` (and thus `dijit.form.DateTextBox`)
    to get notification when the user has clicked a date.  Now onExecute() (above) is used.

  • tags:
  • type

    Function

• dijit.Calendar.onChange

  • parameters:
    • date: (typeof Date)
  • summary

    Called only when the selected date has changed

  • type

    Function

• dijit.Calendar._isSelectedDate

  • parameters:
    • dateObject: (typeof Date)
    • locale: (typeof String)
  • summary

    Extension point so developers can subclass Calendar to
    support multiple (concurrently) selected dates

  • tags: extension
  • type

    Function

• dijit.Calendar.isDisabledDate

  • parameters:
    • dateObject: (typeof Date)
    • locale: (typeof String)
  • returns

    Boolean

  • summary

    May be overridden to disable certain dates in the calendar e.g. <code>isDisabledDate=dojo.date.locale.isWeekend</code>

  • tags: extension
  • type

    Function

• dijit.Calendar.getClassForDate

  • parameters:
    • dateObject: (typeof Date)
    • locale: (typeof String)
  • returns

    String

  • summary

    May be overridden to return CSS classes to associate with the date entry for the given dateObject,
    for example to indicate a holiday in specified locale.

  • tags: extension
  • type

    Function

• dijit.Calendar.dateClassObj

  • type

    Object

• dijit.Calendar.dateFuncObj

  • type

    Object

• dijit.Calendar.dateLocaleModule

  • type

    Object

• dijit.Calendar._MonthDropDown

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    The month drop down

• dijit.Calendar._MonthDropDown.months

  • type

    String[]

  • summary

    List of names of months, possibly w/some undefined entries for Hebrew leap months
    (ex: ["January", "February", undefined, "April", ...])

• dijit.Calendar._MonthDropDown.templateString

  • type

    String

• dijit.Calendar._MonthDropDown._setMonthsAttr

  • parameters:
    • months: (typeof String[])
  • type

    Function

• dijit.Calendar._MonthDropDown.domNode.innerHTML

  • type

    Object

• dijit.Calendar._MonthDropDown._onClick

  • parameters:
    • evt: (typeof Event)
  • type

    Function

• dijit.Calendar._MonthDropDown.onChange

  • parameters:
    • month: (typeof Number)
  • summary

    Callback when month is selected from drop down

  • type

    Function

• dijit.Calendar._MonthDropDown._onMenuHover

  • parameters:
    • evt
  • type

    Function

• dijit

  • type

    Object