angular-bootstrap-datetimepicker/dl-date-time-picker/dl-model-provider.d.ts

Native Angular (8+) datetime picker component styled by Twitter Bootstrap 4.

/**
 * @license
 * Copyright 2013-present Dale Lotts All Rights Reserved.
 * http://www.dalelotts.com
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://github.com/dalelotts/angular-bootstrap-datetimepicker/blob/master/LICENSE
 */
import { SimpleChanges } from '@angular/core';
import { DlDateTimePickerModel } from './dl-date-time-picker-model';
/**
 * Implemented by classes that provide models for the date/time picker.
 *
 * The terms `left`, `right`, `up`, and `down` are used in place of
 * `previous`, `next`, etc so that the model provider is UI centric
 * rather than time direction centric.
 *
 * For example, another calendar implementation may render `future` dates to the `left`.
 *
 * Having the api method `goLeft` may move the `active` cell to a
 * future or past value depending on the calendar implementation,
 * but both operations are performed with the `left-arrow` key.
 */
export interface DlModelProvider {
    /**
     * Receives configuration changes detected by Angular. (i.e. minuteStep)
     *
     * @param changes
     *  the changes detected by Angular.
     */
    onChanges(changes: SimpleChanges): void;
    /**
     * Returns the model for the specified moment in time.
     * @param milliseconds
     *  the moment in time the model should represent.
     * @param selectedMilliseconds
     *  the current value of the date/time picker.
     * @returns
     *  the model representing the specified moment in time.
     */
    getModel(milliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell one cell down from the specified moment in time.
     *
     * The next cell `down` might be in a different time range than the currently
     * displayed view. In this case, the model time range will include the new active cell.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the next model `down` will be constructed.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  the model representing the next model `down` from the specified moment in time.
     */
    goDown(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell to the `last` cell from the specified moment in time.
     *
     * Typically the view or time range will not change. However, changes to the view
     * or time rage are not specifically prohibited.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the `last` active cell will be calculated.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  a model with the `last` cell in the view as the active cell.
     */
    goEnd(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell to the `first` cell from the specified moment in time.
     *
     * Typically the view or time range will not change. However, changes to the view
     * or time rage are not specifically prohibited.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the `first` active cell will be calculated.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  a model with the `first` cell in the view as the active cell.
     */
    goHome(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell one cell to the `left` from the specified moment in time.
     *
     * The next cell `left` might be in a different time range than the currently
     * displayed view. In this case, the model time range will include the new active cell.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the next model `left` will be constructed.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  the model representing the next model `left` from the specified moment in time.
     */
    goLeft(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell one cell to the `right` from the specified moment in time.
     *
     * The next cell `right` might be in a different time range than the currently
     * displayed view. In this case, the model time range will include the new active cell.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the next model `right` will be constructed.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  the model representing the next model `right` from the specified moment in time.
     */
    goRight(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell one cell `up` from the specified moment in time.
     *
     * The next cell `up` might be in a different time range than the currently
     * displayed view. In this case, the model time range will include the new active cell.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the next model `up` will be constructed.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  the model representing the next model `up` from the specified moment in time.
     */
    goUp(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell one `page-down` from the specified moment in time.
     *
     * The next cell `page-down` will be in a different time range than the currently
     * displayed view and the model time range will include the new active cell.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the next model `page-down` will be constructed.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  the model representing the next model `page-down` from the specified moment in time.
     */
    pageDown(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
    /**
     * Move the `active` cell one `page-up` from the specified moment in time.
     *
     * The next cell `page-up` will be in a different time range than the currently
     * displayed view and the model time range will include the new active cell.
     *
     * What happens is determined entirely by the implementation and it
     * varies from view-to-view.
     *
     * This is used for keyboard navigation.
     *
     * @param fromMilliseconds
     *  the moment in time from which the next model `page-up` will be constructed.
     * @param selectedMilliseconds
     *  the current value of the date/time picker
     * @returns
     *  the model representing the next model `page-up` from the specified moment in time.
     */
    pageUp(fromMilliseconds: number, selectedMilliseconds: number): DlDateTimePickerModel;
}