devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
535 lines (389 loc) • 19.3 kB
TypeScript
import { TransferState } from '@angular/platform-browser';
import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges } from '@angular/core';
import DxTextArea from 'devextreme/ui/text_area';
import { ControlValueAccessor } from '@angular/forms';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
import * as i0 from "@angular/core";
import * as i1 from "devextreme-angular/core";
import * as i2 from "@angular/platform-browser";
/**
* The TextArea is a UI component that enables a user to enter and edit a multi-line text.
*/
export declare class DxTextAreaComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxTextArea;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
get accessKey(): string | undefined;
set accessKey(value: string | undefined);
/**
* Specifies whether the UI component changes its visual state as a result of user interaction.
*/
get activeStateEnabled(): boolean;
set activeStateEnabled(value: boolean);
/**
* A Boolean value specifying whether or not the auto resizing mode is enabled.
*/
get autoResizeEnabled(): boolean;
set autoResizeEnabled(value: boolean);
/**
* Specifies whether the UI component responds to user interaction.
*/
get disabled(): boolean;
set disabled(value: boolean);
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
get elementAttr(): any;
set elementAttr(value: any);
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
get focusStateEnabled(): boolean;
set focusStateEnabled(value: boolean);
/**
* Specifies the UI component's height.
*/
get height(): number | Function | string | undefined;
set height(value: number | Function | string | undefined);
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
get hint(): string | undefined;
set hint(value: string | undefined);
/**
* Specifies whether the UI component changes its state when a user pauses on it.
*/
get hoverStateEnabled(): boolean;
set hoverStateEnabled(value: boolean);
/**
* Specifies the attributes to be passed on to the underlying HTML element.
*/
get inputAttr(): any;
set inputAttr(value: any);
/**
* Specifies or indicates whether the editor's value is valid.
*/
get isValid(): boolean;
set isValid(value: boolean);
/**
* Specifies a text string used to annotate the editor's value.
*/
get label(): string;
set label(value: string);
/**
* Specifies the label's display mode.
*/
get labelMode(): string;
set labelMode(value: string);
/**
* Specifies the maximum height of the UI component.
*/
get maxHeight(): number | string | undefined;
set maxHeight(value: number | string | undefined);
/**
* Specifies the maximum number of characters you can enter into the textbox.
*/
get maxLength(): number | string;
set maxLength(value: number | string);
/**
* Specifies the minimum height of the UI component.
*/
get minHeight(): number | string | undefined;
set minHeight(value: number | string | undefined);
/**
* The value to be assigned to the `name` attribute of the underlying HTML element.
*/
get name(): string;
set name(value: string);
/**
* Specifies a text string displayed when the editor's value is empty.
*/
get placeholder(): string;
set placeholder(value: string);
/**
* Specifies whether the editor is read-only.
*/
get readOnly(): boolean;
set readOnly(value: boolean);
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled(): boolean;
set rtlEnabled(value: boolean);
/**
* Specifies whether or not the UI component checks the inner text for spelling mistakes.
*/
get spellcheck(): boolean;
set spellcheck(value: boolean);
/**
* Specifies how the UI component's text field is styled.
*/
get stylingMode(): string;
set stylingMode(value: string);
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
get tabIndex(): number;
set tabIndex(value: number);
/**
* The read-only property that holds the text displayed by the UI component input element.
*/
get text(): string;
set text(value: string);
/**
* Information on the broken validation rule. Contains the first item from the validationErrors array.
*/
get validationError(): any;
set validationError(value: any);
/**
* An array of the validation rules that failed.
*/
get validationErrors(): Array<any>;
set validationErrors(value: Array<any>);
/**
* Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
*/
get validationMessageMode(): string;
set validationMessageMode(value: string);
/**
* Indicates or specifies the current validation status.
*/
get validationStatus(): string;
set validationStatus(value: string);
/**
* Specifies a value the UI component displays.
*/
get value(): string;
set value(value: string);
/**
* Specifies the DOM events after which the UI component's value should be updated.
*/
get valueChangeEvent(): string;
set valueChangeEvent(value: string);
/**
* Specifies whether the UI component is visible.
*/
get visible(): boolean;
set visible(value: boolean);
/**
* Specifies the UI component's width.
*/
get width(): number | Function | string | undefined;
set width(value: number | Function | string | undefined);
/**
* 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 is rendered and each time the component is repainted.
*/
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 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 | undefined>;
/**
* 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.
*/
autoResizeEnabledChange: 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 | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange: EventEmitter<string | undefined>;
/**
* 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.
*/
isValidChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
labelChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
labelModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxHeightChange: EventEmitter<number | string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxLengthChange: EventEmitter<number | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minHeightChange: EventEmitter<number | string | undefined>;
/**
* 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.
*/
spellcheckChange: EventEmitter<boolean>;
/**
* 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.
*/
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<string>;
/**
* 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 | undefined>;
/**
*
*/
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): DxTextArea;
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;
static ɵfac: i0.ɵɵFactoryDeclaration<DxTextAreaComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DxTextAreaComponent, "dx-text-area", never, { "accessKey": "accessKey"; "activeStateEnabled": "activeStateEnabled"; "autoResizeEnabled": "autoResizeEnabled"; "disabled": "disabled"; "elementAttr": "elementAttr"; "focusStateEnabled": "focusStateEnabled"; "height": "height"; "hint": "hint"; "hoverStateEnabled": "hoverStateEnabled"; "inputAttr": "inputAttr"; "isValid": "isValid"; "label": "label"; "labelMode": "labelMode"; "maxHeight": "maxHeight"; "maxLength": "maxLength"; "minHeight": "minHeight"; "name": "name"; "placeholder": "placeholder"; "readOnly": "readOnly"; "rtlEnabled": "rtlEnabled"; "spellcheck": "spellcheck"; "stylingMode": "stylingMode"; "tabIndex": "tabIndex"; "text": "text"; "validationError": "validationError"; "validationErrors": "validationErrors"; "validationMessageMode": "validationMessageMode"; "validationStatus": "validationStatus"; "value": "value"; "valueChangeEvent": "valueChangeEvent"; "visible": "visible"; "width": "width"; }, { "onChange": "onChange"; "onContentReady": "onContentReady"; "onCopy": "onCopy"; "onCut": "onCut"; "onDisposing": "onDisposing"; "onEnterKey": "onEnterKey"; "onFocusIn": "onFocusIn"; "onFocusOut": "onFocusOut"; "onInitialized": "onInitialized"; "onInput": "onInput"; "onKeyDown": "onKeyDown"; "onKeyUp": "onKeyUp"; "onOptionChanged": "onOptionChanged"; "onPaste": "onPaste"; "onValueChanged": "onValueChanged"; "accessKeyChange": "accessKeyChange"; "activeStateEnabledChange": "activeStateEnabledChange"; "autoResizeEnabledChange": "autoResizeEnabledChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "inputAttrChange": "inputAttrChange"; "isValidChange": "isValidChange"; "labelChange": "labelChange"; "labelModeChange": "labelModeChange"; "maxHeightChange": "maxHeightChange"; "maxLengthChange": "maxLengthChange"; "minHeightChange": "minHeightChange"; "nameChange": "nameChange"; "placeholderChange": "placeholderChange"; "readOnlyChange": "readOnlyChange"; "rtlEnabledChange": "rtlEnabledChange"; "spellcheckChange": "spellcheckChange"; "stylingModeChange": "stylingModeChange"; "tabIndexChange": "tabIndexChange"; "textChange": "textChange"; "validationErrorChange": "validationErrorChange"; "validationErrorsChange": "validationErrorsChange"; "validationMessageModeChange": "validationMessageModeChange"; "validationStatusChange": "validationStatusChange"; "valueChange": "valueChange"; "valueChangeEventChange": "valueChangeEventChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; "onBlur": "onBlur"; }, never, never>;
}
export declare class DxTextAreaModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DxTextAreaModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DxTextAreaModule, [typeof DxTextAreaComponent], [typeof i1.DxIntegrationModule, typeof i1.DxTemplateModule, typeof i2.BrowserTransferStateModule], [typeof DxTextAreaComponent, typeof i1.DxTemplateModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DxTextAreaModule>;
}