devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
553 lines (394 loc) • 16.3 kB
TypeScript
/*!
* 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, QueryList } from '@angular/core';
import DevExpress from 'devextreme/bundles/dx.all';
import { format } from 'devextreme/ui/widget/ui.widget';
import DxNumberBox from 'devextreme/ui/number_box';
import { ControlValueAccessor } from '@angular/forms';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
import { DxiButtonComponent } from 'devextreme-angular/ui/nested';
/**
* The NumberBox is a UI component that displays a numeric value and allows a user to modify it by typing in a value, and incrementing or decrementing it using the keyboard or mouse.
*/
export declare class DxNumberBoxComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxNumberBox;
/**
* 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;
/**
* Allows you to add custom buttons to the input text field.
*/
buttons: Array<string | DevExpress.ui.dxTextEditorButton>;
/**
* 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 value's display format and controls user input accordingly.
*/
format: format | string;
/**
* 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 the attributes to be passed on to the underlying HTML element.
*/
inputAttr: any;
/**
* Specifies the text of the message displayed if the specified value is not a number.
*/
invalidValueMessage: string;
/**
* Specifies or indicates whether the editor's value is valid.
*/
isValid: boolean;
/**
* The maximum value accepted by the number box.
*/
max: number;
/**
* The minimum value accepted by the number box.
*/
min: number;
/**
* Specifies the value to be passed to the type attribute of the underlying `` element.
*/
mode: string;
/**
* The value to be assigned to the `name` attribute of the underlying HTML element.
*/
name: string;
/**
* The text displayed by the UI component when the UI component value is empty.
*/
placeholder: string;
/**
* Specifies whether the editor is read-only.
*/
readOnly: boolean;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled: boolean;
/**
* Specifies whether to display the Clear button in the UI component.
*/
showClearButton: boolean;
/**
* Specifies whether to show the buttons that change the value by a step.
*/
showSpinButtons: boolean;
/**
* Specifies how much the UI component's value changes when using the spin buttons, Up/Down arrow keys, or mouse wheel.
*/
step: number;
/**
* Specifies how the UI component's text field is styled.
*/
stylingMode: string;
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
tabIndex: number;
/**
* The read-only property that holds the text displayed by the UI component input element.
*/
text: string;
/**
* Specifies whether to use touch friendly spin buttons. Applies only if showSpinButtons is true.
*/
useLargeSpinButtons: boolean;
/**
* 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;
/**
* The current number box value.
*/
value: number;
/**
* Specifies the DOM events after which the UI component's value should be updated.
*/
valueChangeEvent: string;
/**
* 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 loses focus after the text field's content was changed using the keyboard.
*/
onChange: EventEmitter<any>;
/**
* 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 when the UI component's input has been copied.
*/
onCopy: EventEmitter<any>;
/**
* A function that is executed when the UI component's input has been cut.
*/
onCut: EventEmitter<any>;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<any>;
/**
* A function that is executed when the Enter key has been pressed while the UI component is focused.
*/
onEnterKey: EventEmitter<any>;
/**
* A function that is executed when the UI component gets focus.
*/
onFocusIn: EventEmitter<any>;
/**
* A function that is executed when the UI component loses focus.
*/
onFocusOut: EventEmitter<any>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<any>;
/**
* A function that is executed each time the UI component's input is changed while the UI component is focused.
*/
onInput: EventEmitter<any>;
/**
* A function that is executed when a user is pressing a key on the keyboard.
*/
onKeyDown: EventEmitter<any>;
/**
* A function that is executed when a user presses a key on the keyboard.
* @deprecated The `keyPress` event is removed from the web standards and will be deprecated in modern browsers soon. Refer to the MDN topic for details.
*/
onKeyPress: EventEmitter<any>;
/**
* A function that is executed when a user releases a key on the keyboard.
*/
onKeyUp: EventEmitter<any>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<any>;
/**
* A function that is executed when the UI component's input has been pasted.
*/
onPaste: 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.
*/
buttonsChange: EventEmitter<Array<string | DevExpress.ui.dxTextEditorButton>>;
/**
* 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.
*/
formatChange: EventEmitter<format | string>;
/**
* 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.
*/
inputAttrChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
invalidValueMessageChange: EventEmitter<string>;
/**
* 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.
*/
maxChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
modeChange: EventEmitter<string>;
/**
* 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.
*/
placeholderChange: 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.
*/
showClearButtonChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showSpinButtonsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
stepChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
stylingModeChange: 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.
*/
textChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
useLargeSpinButtonsChange: EventEmitter<boolean>;
/**
* 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<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
valueChangeEventChange: EventEmitter<string>;
/**
* 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;
buttonsChildren: QueryList<DxiButtonComponent>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxNumberBox;
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 DxNumberBoxModule {
}