AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.DatePickerBase Class

    Defined in: alloy-ui/src/aui-datepicker/js/aui-datepicker.js:13
    Module: aui-datepicker

    A base class for DatePickerBase.

    Constructor

    A.DatePickerBase

    (
    • config
    )

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:13

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterCalendarDateClick

    () protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:274

    Fires after a click in the Calendar date.

    _afterCalendarSelectionChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:295

    Fires after a selection change in the Calendar.

    Parameters:

    • event Object

    _afterDatePickerSelectionChange

    () protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:319

    Fires when a selection change in the DatePicker.

    _isSameDay

    (
    • date1
    • date2
    )
    protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:339

    Checks if the given dates are referencing the same day, month and year.

    Parameters:

    • date1 Object
    • date2 Object

    _onceUserInteractionRelease

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:354

    Fires when the user's first interaction happens.

    Parameters:

    • event Object

    _setCalendar

    (
    • val
    )
    protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:391

    Sets the calendar value by merging its object with another properties.

    Parameters:

    • val Object

    _setCalendarToFirstSelectedDate

    () protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:371

    Sets the first selected date in the Calendar.

    _setPanes

    (
    • val
    )
    Number protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:405

    Sets the pane value between 1 and 3.

    Parameters:

    • val Object

    Returns:

    Number:

    Clamped number of panes.

    clearSelection

    (
    • silent
    )

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:135

    Clears a selection in the Calendar.

    Parameters:

    • silent Object

    deselectDates

    (
    • dates
    )

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:160

    Deselects a date in the Calendar.

    Parameters:

    • dates Object

    getCalendar

    () Calendar

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:172

    Returns an existent Calendar instance or creates a new one if it doesn't exists.

    Returns:

    Calendar:

    initializer

    () protected

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:118

    Construction logic executed during DatePickerBase instantiation. Lifecycle.

    selectDates

    (
    • dates
    )

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:214

    Selects a date in the Calendar.

    Parameters:

    • dates Object

    selectDatesFromInputValue

    (
    • dates
    )

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:226

    Selects dates in the 'Calendar' while only allowing the calendar to fire 'selectionChange' once.

    Parameters:

    • dates Object

    useInputNode

    (
    • node
    )

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:247

    Renders the widget in an <input> node.

    Parameters:

    • node Object

    Properties

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:37

    Static property used to define the default attribute configuration for the DatePickerBase.

    PANES

    Array static

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:24

    Lists CalendarBase pane templates.

    Attributes

    autoHide

    Boolean

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:47

    Sets the initial visibility.

    Default: true

    calendar

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:59

    Stores the configuration of the Calendar instance.

    Default: {}

    live

    String

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:72

    Sets the aria-live attribute for the datepicker.

    Default: 'assertive'

    panes

    Number

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:84

    Defines how many panes should be rendered.

    Default: 1

    useARIA

    Boolean

    Defined in alloy-ui/src/aui-datepicker/js/aui-datepicker.js:100

    Boolean indicating if use of the WAI-ARIA Roles and States should be enabled.

    Default: true