/*! * devextreme-angular * Version: 19.1.16 * Build date: Tue Oct 18 2022 * * Copyright (c) 2012 - 2022 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 DxSelectBox from 'devextreme/ui/select_box'; import { ControlValueAccessor } from '@angular/forms'; import { DxComponent } from '../core/component'; import { DxTemplateHost } from '../core/template-host'; import { NestedOptionHost } from '../core/nested-option'; import { WatcherHelper } from '../core/watcher-helper'; import { IterableDifferHelper } from '../core/iterable-differ-helper'; import { DxiButtonComponent } from './nested/button-dxi'; import { DxiItemComponent } from './nested/item-dxi'; /** * The SelectBox widget is an editor that allows an end user to select an item from a drop-down list. */ export declare class DxSelectBoxComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxSelectBox; /** * Specifies whether the widget allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation. */ acceptCustomValue: boolean; /** * Specifies the shortcut key that sets focus on the widget. */ accessKey: string; /** * Specifies whether or not the widget changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Allows you to add custom buttons to the input text field. */ buttons: Array; /** * Binds the widget to data. */ dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array; /** * Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately. */ deferRendering: boolean; /** * Specifies whether the widget responds to user interaction. */ disabled: boolean; /** * Specifies the data field whose values should be displayed. */ displayExpr: Function | string; /** * Returns the value currently displayed by the widget. */ displayValue: string; /** * Specifies a custom template for the drop-down button. */ dropDownButtonTemplate: any; /** * Specifies the attributes to be attached to the widget's root element. */ elementAttr: any; /** * Specifies a custom template for the text field. Must contain the TextBox widget. */ fieldTemplate: any; /** * Specifies whether the widget can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Specifies whether data items should be grouped. */ grouped: boolean; /** * Specifies a custom template for group captions. */ groupTemplate: any; /** * Specifies the widget's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the widget. */ hint: string; /** * Specifies whether the widget 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 whether the editor's value is valid. */ isValid: boolean; /** * An array of items displayed by the widget. */ items: Array; /** * Specifies a custom template for items. */ itemTemplate: any; /** * Specifies the maximum number of characters you can enter into the textbox. */ maxLength: number | string; /** * The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true. */ minSearchLength: number; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name: string; /** * The text or HTML markup displayed by the widget if the item collection is empty. */ noDataText: string; /** * Specifies whether or not the drop-down editor is displayed. */ opened: boolean; /** * Specifies whether a user can open the drop-down list by clicking a text field. */ openOnFieldClick: boolean; /** * The text that is provided as a hint in the select box editor. */ placeholder: string; /** * Specifies whether the editor is read-only. */ readOnly: boolean; /** * Switches the widget to a right-to-left representation. */ rtlEnabled: boolean; /** * Specifies whether to allow searching. */ searchEnabled: boolean; /** * Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ searchExpr: Function | Array; /** * Specifies a comparison operation used to search widget items. */ searchMode: string; /** * Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ searchTimeout: number; /** * Gets the currently selected item. */ selectedItem: any; /** * Specifies whether to display the Clear button in the widget. */ showClearButton: boolean; /** * Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ showDataBeforeSearch: boolean; /** * Specifies whether the drop-down button is visible. */ showDropDownButton: boolean; /** * Specifies whether or not to display selection controls. */ showSelectionControls: boolean; /** * Specifies whether or not the widget checks the inner text for spelling mistakes. */ spellcheck: boolean; /** * Specifies how the widget'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 option that holds the text displayed by the widget input element. */ text: string; /** * Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option. */ validationError: any; /** * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ validationMessageMode: string; /** * Specifies the currently selected value. May be an object if dataSource contains objects and valueExpr is not set. */ value: any; /** * Specifies the DOM events after which the widget's value should be updated. Applies only if acceptCustomValue is set to true. */ valueChangeEvent: string; /** * Specifies which data field provides unique values to the widget's value. */ valueExpr: Function | string; /** * Specifies whether the widget is visible. */ visible: boolean; /** * Specifies the widget's width. */ width: number | Function | string; /** * A function that is executed when the widget loses focus after the text field's content was changed using the keyboard. */ onChange: EventEmitter; /** * A function that is executed once the drop-down editor is closed. */ onClosed: EventEmitter; /** * A function that is executed when the widget's content is ready and each time the content is changed. */ onContentReady: EventEmitter; /** * A function that is executed when the widget's input has been copied. */ onCopy: EventEmitter; /** * A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true. */ onCustomItemCreating: EventEmitter; /** * A function that is executed when the widget's input has been cut. */ onCut: EventEmitter; /** * A function that is executed before the widget is disposed of. */ onDisposing: EventEmitter; /** * A function that is executed when the Enter key has been pressed while the widget is focused. */ onEnterKey: EventEmitter; /** * A function that is executed when the widget gets focus. */ onFocusIn: EventEmitter; /** * A function that is executed when the widget loses focus. */ onFocusOut: EventEmitter; /** * A function used in JavaScript frameworks to save the widget instance. */ onInitialized: EventEmitter; /** * A function that is executed each time the widget's input is changed while the widget is focused. */ onInput: EventEmitter; /** * A function that is executed when a list item is clicked or tapped. */ onItemClick: EventEmitter; /** * A function that is executed when a user is pressing a key on the keyboard. */ onKeyDown: EventEmitter; /** * A function that is executed when a user presses a key on the keyboard. */ onKeyPress: EventEmitter; /** * A function that is executed when a user releases a key on the keyboard. */ onKeyUp: EventEmitter; /** * A function that is executed once the drop-down editor is opened. */ onOpened: EventEmitter; /** * A function that is executed after a widget option is changed. */ onOptionChanged: EventEmitter; /** * A function that is executed when the widget's input has been pasted. */ onPaste: EventEmitter; /** * A function that is executed when a list item is selected or selection is canceled. */ onSelectionChanged: EventEmitter; /** * A function that is executed after the widget's value is changed. */ onValueChanged: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ acceptCustomValueChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ buttonsChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dataSourceChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ deferRenderingChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ displayExprChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ displayValueChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dropDownButtonTemplateChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ fieldTemplateChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupedChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupTemplateChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ inputAttrChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ isValidChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemsChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemTemplateChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ maxLengthChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ minSearchLengthChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ nameChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ noDataTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ openedChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ openOnFieldClickChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ placeholderChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ readOnlyChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchExprChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchTimeoutChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showClearButtonChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showDataBeforeSearchChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showDropDownButtonChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showSelectionControlsChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ spellcheckChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ stylingModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ textChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationErrorChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationMessageModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ valueChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ valueChangeEventChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ valueExprChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter; onBlur: EventEmitter; change(_: any): void; touched: (_: any) => void; buttonsChildren: QueryList; itemsChildren: QueryList; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxSelectBox; 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 DxSelectBoxModule { }