dijit/_TimePicker.js

• Provides:

  • dijit._TimePicker

• Requires:

  • dijit.form._FormWidget in common
  • dojo.date.locale in common

• dijit._TimePicker.__Constraints

  • type

    Function

  • chains:
    • dojo.date.locale.__FormatOptions: (prototype)
    • dojo.date.locale.__FormatOptions: (call)

• dijit._TimePicker.__Constraints.clickableIncrement

  • type

    String

  • summary

    See <code>dijit._TimePicker.clickableIncrement</code>

• dijit._TimePicker.__Constraints.visibleIncrement

  • type

    String

  • summary

    See <code>dijit._TimePicker.visibleIncrement</code>

• dijit._TimePicker.__Constraints.visibleRange

  • type

    String

  • summary

    See <code>dijit._TimePicker.visibleRange</code>

• dijit._TimePicker

  • type

    Function

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

    A graphical time picker.
    This widget is used internally by other widgets and is not available
    as a standalone widget due to lack of accessibility support.

• dijit._TimePicker.templateString

  • type

    Object

• dijit._TimePicker.baseClass

  • tags:
  • type

    String

  • summary

    The root className to use for the various states of this widget

• dijit._TimePicker.clickableIncrement

  • type

    String

  • summary

    ISO-8601 string representing the amount by which
    every clickable element in the time picker increases.
    Set in local time, without a time zone.
    Example: <code>T00:15:00</code> creates 15 minute increments
    Must divide dijit._TimePicker.visibleIncrement evenly

• dijit._TimePicker.visibleIncrement

  • type

    String

  • summary

    ISO-8601 string representing the amount by which
    every element with a visible time in the time picker increases.
    Set in local time, without a time zone.
    Example: <code>T01:00:00</code> creates text in every 1 hour increment

• dijit._TimePicker.visibleRange

  • type

    String

  • summary

    ISO-8601 string representing the range of this TimePicker.
    The TimePicker will only display times in this range.
    Example: <code>T05:00:00</code> displays 5 hours of options

• dijit._TimePicker.value

  • type

    String

  • summary

    Date to display.
    Defaults to current time and date.
    Can be a Date object or an ISO-8601 string.
    If you specify the GMT time zone (<code>-01:00</code>),
    the time will be converted to the local time in the local time zone.
    Otherwise, the time is considered to be in the local time zone.
    If you specify the date and isDate is true, the date is used.
    Example: if your local time zone is <code>GMT -05:00</code>,
    <code>T10:00:00</code> becomes <code>T10:00:00-05:00</code> (considered to be local time),
    <code>T10:00:00-01:00</code> becomes <code>T06:00:00-05:00</code> (4 hour difference),
    <code>T10:00:00Z</code> becomes <code>T05:00:00-05:00</code> (5 hour difference between Zulu and local time)
    <code>yyyy-mm-ddThh:mm:ss</code> is the format to set the date and time
    Example: <code>2007-06-01T09:00:00</code>

• dijit._TimePicker._visibleIncrement

  • type

    Number

• dijit._TimePicker._clickableIncrement

  • type

    Number

• dijit._TimePicker._totalIncrements

  • type

    Number

• dijit._TimePicker.constraints

  • type

    dijit._TimePicker.__Constraints

  • summary

    Specifies valid range of times (start time, end time)

• dijit._TimePicker.serialize

  • parameters:
    • val: (typeof Date)

      The current value

    • options: (typeof Object)
  • summary

    User overridable function used to convert the attr('value') result to a String

  • tags:
  • alias - dojo.date.stamp.toISOString
  • type

    Function

• dijit._TimePicker.filterString

  • type

    string

  • summary

    The string to filter by

• dijit._TimePicker.setValue

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

    Deprecated.  Used set('value') instead.

  • tags:
  • type

    Function

• dijit._TimePicker._setValueAttr

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

    Hook so set('value', ...) works.

  • description

    Set the value of the TimePicker.
    Redraws the TimePicker around the new date.

  • tags:
  • type

    Function

• dijit._TimePicker._setFilterStringAttr

  • parameters:
    • val
  • summary

    Called by TimeTextBox to filter the values shown in my list

  • type

    Function

• dijit._TimePicker.isDisabledDate

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

    Boolean

  • summary

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

  • type

    Function

• dijit._TimePicker._getFilteredNodes

  • parameters:
    • start: (typeof number)
    • maxNum: (typeof number)
    • before: (typeof Boolean)
    • lastNode: (typeof DOMnode)
  • summary

    Returns an array of nodes with the filter applied.  At most maxNum nodes
    will be returned - but fewer may be returned as well.  If the
    before parameter is set to true, then it will return the elements
    before the given index

  • tags:
  • type

    Function

• dijit._TimePicker._showText

  • summary

    Displays the relevant choices in the drop down list

  • tags:
  • type

    Function

• dijit._TimePicker.timeMenu.innerHTML

  • type

    String

• dijit._TimePicker._clickableIncrementDate

  • type

    Object

• dijit._TimePicker._visibleIncrementDate

  • type

    Object

• dijit._TimePicker._visibleRangeDate

  • type

    Object

• dijit._TimePicker._refDate

  • type

    Object

• dijit._TimePicker._maxIncrement

  • type

    Number

• dijit._TimePicker.constructor

  • constructor - constructor
  • type

    Function

• dijit._TimePicker.postMixInProperties

  • type

    Function

• dijit._TimePicker._setConstraintsAttr

  • parameters:
    • constraints: (typeof Object)
  • type

    Function

• dijit._TimePicker.postCreate

  • type

    Function

• dijit._TimePicker._buttonMouse

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

    Handler for hover (and unhover) on up/down arrows

  • tags:
  • type

    Function

• dijit._TimePicker._createOption

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

    Creates a clickable time option

  • tags:
  • type

    Function

• dijit._TimePicker._onOptionSelected

  • parameters:
    • tgt: (typeof Object)
  • summary

    Called when user clicks an option in the drop down list

  • tags:
  • type

    Function

• dijit._TimePicker._highlighted_option

  • type

    Object

• dijit._TimePicker.onChange

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

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

  • tags: public
  • type

    Function

• dijit._TimePicker._highlightOption

  • parameters:
    • node: (typeof node)
    • highlight: (typeof Boolean)
  • summary

    Turns on/off highlight effect on a node based on mouse out/over event

  • tags:
  • type

    Function

• dijit._TimePicker.onmouseover

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

    Handler for onmouseover event

  • tags:
  • type

    Function

• dijit._TimePicker._keyboardSelected

  • type

    Object

• dijit._TimePicker.onmouseout

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

    Handler for onmouseout event

  • tags:
  • type

    Function

• dijit._TimePicker._mouseWheeled

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

    Handle the mouse wheel events

  • tags:
  • type

    Function

• dijit._TimePicker._onArrowUp

  • parameters:
    • count
  • returns

    typematic end

  • summary

    Handler for up arrow key.

  • description

    Removes the bottom time and add one to the top

  • tags:
  • type

    Function

• dijit._TimePicker.timeMenu.childNodes.0.index

• dijit._TimePicker._onArrowDown

  • parameters:
    • count
  • returns

    typematic end

  • summary

    Handler for up arrow key.

  • description

    Remove the top time and add one to the bottom

  • tags:
  • type

    Function

• dijit._TimePicker.handleKey

  • parameters:
    • e: (typeof Event)
  • returns

    true means don't call stopEvent()

  • summary

    Called from <code>dijit.form._DateTimeTextBox</code> to pass a keypress event
    from the <code>dijit.form.TimeTextBox</code> to be handled in this widget

  • tags:
  • type

    Function

• dijit._TimePicker.timeMenu

• dijit

  • type

    Object