UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

327 lines (241 loc) • 9.81 kB
/*! * devextreme-angular * Version: 20.2.5 * Build date: Fri Jan 15 2021 * * Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges } from '@angular/core'; import DxSwitch from 'devextreme/ui/switch'; import { ControlValueAccessor } from '@angular/forms'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; /** * The Switch is a UI component that can be in two states: 'On' and 'Off'. */ export declare class DxSwitchComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxSwitch; /** * Specifies the shortcut key that sets focus on the UI component. */ accessKey: string; /** * Specifies whether or not the UI component changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies whether the UI component responds to user interaction. */ disabled: boolean; /** * Specifies the global attributes to be attached to the UI component's container element. */ elementAttr: any; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Specifies the UI component's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the UI component. */ hint: string; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * Specifies or indicates whether the editor's value is valid. */ isValid: boolean; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name: string; /** * Specifies whether the editor is read-only. */ readOnly: boolean; /** * Switches the UI component to a right-to-left representation. */ rtlEnabled: boolean; /** * Specifies the text displayed when the UI component is switched off. */ switchedOffText: string; /** * Specifies the text displayed when the UI component is switched on. */ switchedOnText: string; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex: number; /** * Information on the broken validation rule. Contains the first item from the validationErrors array. */ validationError: any; /** * An array of the validation rules that failed. */ validationErrors: Array<any>; /** * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ validationMessageMode: string; /** * Indicates or specifies the current validation status. */ validationStatus: string; /** * A Boolean value specifying whether the current switch state is 'On' or 'Off'. */ value: boolean; /** * Specifies whether the UI component is visible. */ visible: boolean; /** * Specifies the UI component's width. */ width: number | Function | string; /** * A function that is executed when the UI component's content is ready and each time the content is changed. */ onContentReady: EventEmitter<any>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<any>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<any>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<any>; /** * A function that is executed after the UI component's value is changed. */ onValueChanged: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ isValidChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ nameChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ readOnlyChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ switchedOffTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ switchedOnTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationErrorChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationErrorsChange: EventEmitter<Array<any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationMessageModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationStatusChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ valueChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter<number | Function | string>; /** * */ onBlur: EventEmitter<any>; change(_: any): void; touched: (_: any) => void; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxSwitch; writeValue(value: any): void; setDisabledState(isDisabled: boolean): void; registerOnChange(fn: (_: any) => void): void; registerOnTouched(fn: () => void): void; _createWidget(element: any): void; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; } export declare class DxSwitchModule { }