radio-group.d.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. /*!
  2. * devextreme-angular
  3. * Version: 19.1.16
  4. * Build date: Tue Oct 18 2022
  5. *
  6. * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED
  7. *
  8. * This software may be modified and distributed under the terms
  9. * of the MIT license. See the LICENSE file in the root of the project for details.
  10. *
  11. * https://github.com/DevExpress/devextreme-angular
  12. */
  13. import { TransferState } from '@angular/platform-browser';
  14. import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxRadioGroup from 'devextreme/ui/radio_group';
  17. import { ControlValueAccessor } from '@angular/forms';
  18. import { DxComponent } from '../core/component';
  19. import { DxTemplateHost } from '../core/template-host';
  20. import { NestedOptionHost } from '../core/nested-option';
  21. import { WatcherHelper } from '../core/watcher-helper';
  22. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  23. import { DxiItemComponent } from './nested/item-dxi';
  24. /**
  25. * The RadioGroup is a widget that contains a set of radio buttons and allows an end user to make a single selection from the set.
  26. */
  27. export declare class DxRadioGroupComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
  28. private _watcherHelper;
  29. private _idh;
  30. instance: DxRadioGroup;
  31. /**
  32. * Specifies the shortcut key that sets focus on the widget.
  33. */
  34. accessKey: string;
  35. /**
  36. * Specifies whether or not the widget changes its state when interacting with a user.
  37. */
  38. activeStateEnabled: boolean;
  39. /**
  40. * Binds the widget to data.
  41. */
  42. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<DevExpress.ui.CollectionWidgetItem | any>;
  43. /**
  44. * Specifies whether the widget responds to user interaction.
  45. */
  46. disabled: boolean;
  47. /**
  48. * Specifies the data field whose values should be displayed.
  49. */
  50. displayExpr: Function | string;
  51. /**
  52. * Specifies the attributes to be attached to the widget's root element.
  53. */
  54. elementAttr: any;
  55. /**
  56. * Specifies whether the widget can be focused using keyboard navigation.
  57. */
  58. focusStateEnabled: boolean;
  59. /**
  60. * Specifies the widget's height.
  61. */
  62. height: number | Function | string;
  63. /**
  64. * Specifies text for a hint that appears when a user pauses on the widget.
  65. */
  66. hint: string;
  67. /**
  68. * Specifies whether the widget changes its state when a user pauses on it.
  69. */
  70. hoverStateEnabled: boolean;
  71. /**
  72. * Specifies whether the editor's value is valid.
  73. */
  74. isValid: boolean;
  75. /**
  76. * An array of items displayed by the widget.
  77. */
  78. items: Array<any | {
  79. disabled?: boolean;
  80. html?: string;
  81. template?: any;
  82. text?: string;
  83. visible?: boolean;
  84. }>;
  85. /**
  86. * Specifies a custom template for items.
  87. */
  88. itemTemplate: any;
  89. /**
  90. * Specifies the radio group layout.
  91. */
  92. layout: string;
  93. /**
  94. * The value to be assigned to the `name` attribute of the underlying HTML element.
  95. */
  96. name: string;
  97. /**
  98. * Specifies whether the editor is read-only.
  99. */
  100. readOnly: boolean;
  101. /**
  102. * Switches the widget to a right-to-left representation.
  103. */
  104. rtlEnabled: boolean;
  105. /**
  106. * Specifies the number of the element when the Tab key is used for navigating.
  107. */
  108. tabIndex: number;
  109. /**
  110. * Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
  111. */
  112. validationError: any;
  113. /**
  114. * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
  115. */
  116. validationMessageMode: string;
  117. /**
  118. * Specifies the widget's value.
  119. */
  120. value: any;
  121. /**
  122. * Specifies which data field provides unique values to the widget's value.
  123. */
  124. valueExpr: Function | string;
  125. /**
  126. * Specifies whether the widget is visible.
  127. */
  128. visible: boolean;
  129. /**
  130. * Specifies the widget's width.
  131. */
  132. width: number | Function | string;
  133. /**
  134. * A function that is executed when the widget's content is ready and each time the content is changed.
  135. */
  136. onContentReady: EventEmitter<any>;
  137. /**
  138. * A function that is executed before the widget is disposed of.
  139. */
  140. onDisposing: EventEmitter<any>;
  141. /**
  142. * A function used in JavaScript frameworks to save the widget instance.
  143. */
  144. onInitialized: EventEmitter<any>;
  145. /**
  146. * A function that is executed after a widget option is changed.
  147. */
  148. onOptionChanged: EventEmitter<any>;
  149. /**
  150. * A function that is executed after the widget's value is changed.
  151. */
  152. onValueChanged: EventEmitter<any>;
  153. /**
  154. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  155. */
  156. accessKeyChange: EventEmitter<string>;
  157. /**
  158. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  159. */
  160. activeStateEnabledChange: EventEmitter<boolean>;
  161. /**
  162. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  163. */
  164. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<DevExpress.ui.CollectionWidgetItem | any>>;
  165. /**
  166. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  167. */
  168. disabledChange: EventEmitter<boolean>;
  169. /**
  170. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  171. */
  172. displayExprChange: EventEmitter<Function | string>;
  173. /**
  174. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  175. */
  176. elementAttrChange: EventEmitter<any>;
  177. /**
  178. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  179. */
  180. focusStateEnabledChange: EventEmitter<boolean>;
  181. /**
  182. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  183. */
  184. heightChange: EventEmitter<number | Function | string>;
  185. /**
  186. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  187. */
  188. hintChange: EventEmitter<string>;
  189. /**
  190. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  191. */
  192. hoverStateEnabledChange: EventEmitter<boolean>;
  193. /**
  194. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  195. */
  196. isValidChange: EventEmitter<boolean>;
  197. /**
  198. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  199. */
  200. itemsChange: EventEmitter<Array<any | {
  201. disabled?: boolean;
  202. html?: string;
  203. template?: any;
  204. text?: string;
  205. visible?: boolean;
  206. }>>;
  207. /**
  208. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  209. */
  210. itemTemplateChange: EventEmitter<any>;
  211. /**
  212. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  213. */
  214. layoutChange: EventEmitter<string>;
  215. /**
  216. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  217. */
  218. nameChange: EventEmitter<string>;
  219. /**
  220. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  221. */
  222. readOnlyChange: EventEmitter<boolean>;
  223. /**
  224. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  225. */
  226. rtlEnabledChange: EventEmitter<boolean>;
  227. /**
  228. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  229. */
  230. tabIndexChange: EventEmitter<number>;
  231. /**
  232. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  233. */
  234. validationErrorChange: EventEmitter<any>;
  235. /**
  236. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  237. */
  238. validationMessageModeChange: EventEmitter<string>;
  239. /**
  240. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  241. */
  242. valueChange: EventEmitter<any>;
  243. /**
  244. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  245. */
  246. valueExprChange: EventEmitter<Function | string>;
  247. /**
  248. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  249. */
  250. visibleChange: EventEmitter<boolean>;
  251. /**
  252. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  253. */
  254. widthChange: EventEmitter<number | Function | string>;
  255. onBlur: EventEmitter<any>;
  256. change(_: any): void;
  257. touched: (_: any) => void;
  258. itemsChildren: QueryList<DxiItemComponent>;
  259. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  260. protected _createInstance(element: any, options: any): DxRadioGroup;
  261. writeValue(value: any): void;
  262. setDisabledState(isDisabled: boolean): void;
  263. registerOnChange(fn: (_: any) => void): void;
  264. registerOnTouched(fn: () => void): void;
  265. _createWidget(element: any): void;
  266. ngOnDestroy(): void;
  267. ngOnChanges(changes: SimpleChanges): void;
  268. setupChanges(prop: string, changes: SimpleChanges): void;
  269. ngDoCheck(): void;
  270. _setOption(name: string, value: any): void;
  271. }
  272. export declare class DxRadioGroupModule {
  273. }