@serenity-is/corelib / DateYearEditor
Class: DateYearEditor<P>
Type parameters
| Name | Type |
|---|---|
P |
extends DateYearEditorOptions = DateYearEditorOptions |
Hierarchy
SelectEditor<P>↳
DateYearEditor
Table of contents
Constructors
Properties
- cascadeLink
- domNode
- idPrefix
- lastCreateTerm
- onInitNewEntity
- openDialogAsPanel
- options
- uniqueName
- typeInfo
Accessors
- cascadeField
- cascadeFrom
- cascadeValue
- element
- filterField
- filterValue
- itemById
- items
- props
- readOnly
- selectedItem
- selectedItems
- text
- value
- values
Methods
- abortPendingQuery
- addCssClass
- addInplaceCreate
- addItem
- addOption
- addValidationRule
- allowClear
- asyncSearch
- cascadeItems
- change
- changeSelect2
- clearItems
- createEditDialog
- destroy
- editDialogDataChange
- emptyItemText
- filterItems
- getCascadeFromValue
- getComboboxContainer
- getComboboxOptions
- getCreateSearchChoice
- getCssClass
- getCustomAttribute
- getDialogTypeKey
- getEditValue
- getFieldElement
- getGridField
- getIdField
- getItems
- getPageSize
- getTextField
- getTypeDelay
- get_cascadeField
- get_cascadeFrom
- get_cascadeValue
- get_delimited
- get_filterField
- get_filterValue
- get_itemByKey
- get_items
- get_readOnly
- get_text
- get_value
- get_values
- hasAsyncSource
- init
- initNewEntity
- inplaceCreateClick
- internalInit
- internalRenderContents
- isAutoComplete
- isMultiple
- itemDisabled
- itemId
- itemText
- mapItem
- mapItems
- openDropdown
- render
- renderContents
- setCascadeFrom
- setEditDialogReadOnly
- setEditValue
- setTermOnNewEntity
- set_cascadeField
- set_cascadeFrom
- set_cascadeValue
- set_filterField
- set_filterValue
- set_readOnly
- set_value
- set_values
- syncOrAsyncThen
- updateItems
- useIdPrefix
- useInplaceAdd
- create
- createDefaultElement
- filterByText
- getWidgetName
Constructors
constructor
• new DateYearEditor<P>(props): DateYearEditor<P>
Type parameters
| Name | Type |
|---|---|
P |
extends DateYearEditorOptions = DateYearEditorOptions |
Parameters
| Name | Type |
|---|---|
props |
EditorProps<P> |
Returns
Overrides
Defined in
src/ui/editors/dateyeareditor.ts:8
Properties
cascadeLink
• Protected cascadeLink: CascadedWidgetLink<Widget<any>>
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:572
domNode
• Readonly domNode: HTMLInputElement
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:44
idPrefix
• Readonly idPrefix: string
Inherited from
Defined in
lastCreateTerm
• Protected lastCreateTerm: string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:49
onInitNewEntity
• onInitNewEntity: (entity: ComboboxItem<any>) => void
Type declaration
▸ (entity): void
Parameters
| Name | Type |
|---|---|
entity |
ComboboxItem<any> |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:740
openDialogAsPanel
• openDialogAsPanel: boolean
Inherited from
SelectEditor.openDialogAsPanel
Defined in
src/ui/editors/comboboxeditor.ts:846
options
• Protected Readonly options: WidgetProps<P>
Inherited from
Defined in
uniqueName
• Protected Readonly uniqueName: string
Inherited from
Defined in
typeInfo
▪ Static typeInfo: ClassTypeInfo<"Serenity.Widget">
Inherited from
Defined in
Accessors
cascadeField
• get cascadeField(): string
Returns
string
Inherited from
SelectEditor.cascadeField
Defined in
src/ui/editors/comboboxeditor.ts:616
• set cascadeField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
SelectEditor.cascadeField
Defined in
src/ui/editors/comboboxeditor.ts:624
cascadeFrom
• get cascadeFrom(): string
Returns
string
Inherited from
SelectEditor.cascadeFrom
Defined in
src/ui/editors/comboboxeditor.ts:597
• set cascadeFrom(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
SelectEditor.cascadeFrom
Defined in
src/ui/editors/comboboxeditor.ts:608
cascadeValue
• get cascadeValue(): any
Returns
any
Inherited from
SelectEditor.cascadeValue
Defined in
src/ui/editors/comboboxeditor.ts:632
• set cascadeValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Inherited from
SelectEditor.cascadeValue
Defined in
src/ui/editors/comboboxeditor.ts:644
element
• get element(): Fluent<HTMLElement>
Returns a Fluent(this.domNode) object
Returns
Fluent<HTMLElement>
Inherited from
SelectEditor.element
Defined in
filterField
• get filterField(): string
Returns
string
Inherited from
SelectEditor.filterField
Defined in
src/ui/editors/comboboxeditor.ts:652
• set filterField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
SelectEditor.filterField
Defined in
src/ui/editors/comboboxeditor.ts:660
filterValue
• get filterValue(): any
Returns
any
Inherited from
SelectEditor.filterValue
Defined in
src/ui/editors/comboboxeditor.ts:668
• set filterValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Inherited from
SelectEditor.filterValue
Defined in
src/ui/editors/comboboxeditor.ts:680
itemById
• get itemById(): Object
Returns
Object
Inherited from
SelectEditor.itemById
Defined in
src/ui/editors/comboboxeditor.ts:259
• set itemById(value): void
Parameters
| Name | Type |
|---|---|
value |
Object |
Returns
void
Inherited from
SelectEditor.itemById
Defined in
src/ui/editors/comboboxeditor.ts:266
items
• get items(): ComboboxItem<TItem>[]
Returns
ComboboxItem<TItem>[]
Inherited from
SelectEditor.items
Defined in
src/ui/editors/comboboxeditor.ts:242
• set items(value): void
Parameters
| Name | Type |
|---|---|
value |
ComboboxItem<TItem>[] |
Returns
void
Inherited from
SelectEditor.items
Defined in
src/ui/editors/comboboxeditor.ts:249
props
• get props(): WidgetProps<P>
Returns
WidgetProps<P>
Inherited from
SelectEditor.props
Defined in
readOnly
• get readOnly(): boolean
Returns
boolean
Inherited from
SelectEditor.readOnly
Defined in
src/ui/editors/comboboxeditor.ts:542
• set readOnly(value): void
Parameters
| Name | Type |
|---|---|
value |
boolean |
Returns
void
Inherited from
SelectEditor.readOnly
Defined in
src/ui/editors/comboboxeditor.ts:564
selectedItem
• get selectedItem(): TItem
Returns
TItem
Inherited from
SelectEditor.selectedItem
Defined in
src/ui/editors/comboboxeditor.ts:485
selectedItems
• get selectedItems(): TItem[]
Returns
TItem[]
Inherited from
SelectEditor.selectedItems
Defined in
src/ui/editors/comboboxeditor.ts:495
text
• get text(): string
Returns
string
Inherited from
SelectEditor.text
Defined in
src/ui/editors/comboboxeditor.ts:534
value
• get value(): string
Returns
string
Inherited from
SelectEditor.value
Defined in
src/ui/editors/comboboxeditor.ts:466
• set value(v): void
Parameters
| Name | Type |
|---|---|
v |
string |
Returns
void
Inherited from
SelectEditor.value
Defined in
src/ui/editors/comboboxeditor.ts:481
values
• get values(): string[]
Returns
string[]
Inherited from
SelectEditor.values
Defined in
src/ui/editors/comboboxeditor.ts:514
• set values(value): void
Parameters
| Name | Type |
|---|---|
value |
string[] |
Returns
void
Inherited from
SelectEditor.values
Defined in
src/ui/editors/comboboxeditor.ts:522
Methods
abortPendingQuery
▸ abortPendingQuery(): void
Returns
void
Inherited from
SelectEditor.abortPendingQuery
Defined in
src/ui/editors/comboboxeditor.ts:157
addCssClass
▸ addCssClass(): void
Returns
void
Inherited from
Defined in
addInplaceCreate
▸ addInplaceCreate(addTitle, editTitle): void
Parameters
| Name | Type |
|---|---|
addTitle |
string |
editTitle |
string |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:298
addItem
▸ addItem(item): void
Parameters
| Name | Type |
|---|---|
item |
ComboboxItem<ComboboxItem<any>> |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:281
addOption
▸ addOption(key, text, source?, disabled?): void
Parameters
| Name | Type |
|---|---|
key |
string |
text |
string |
source? |
any |
disabled? |
boolean |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:289
addValidationRule
▸ addValidationRule(rule, uniqueName?): void
Parameters
| Name | Type |
|---|---|
rule |
(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string |
uniqueName? |
string |
Returns
void
Inherited from
SelectEditor.addValidationRule
Defined in
▸ addValidationRule(uniqueName, rule): void
Parameters
| Name | Type |
|---|---|
uniqueName |
string |
rule |
(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string |
Returns
void
Inherited from
SelectEditor.addValidationRule
Defined in
allowClear
▸ allowClear(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:148
asyncSearch
▸ asyncSearch(query): PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>
Parameters
| Name | Type |
|---|---|
query |
ComboboxSearchQuery |
Returns
PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:89
cascadeItems
▸ cascadeItems(items): ComboboxItem<any>[]
Parameters
| Name | Type |
|---|---|
items |
ComboboxItem<any>[] |
Returns
ComboboxItem<any>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:684
change
▸ change(handler): void
Parameters
| Name | Type |
|---|---|
handler |
(e: Event) => void |
Returns
void
Inherited from
Defined in
changeSelect2
▸ changeSelect2(handler): void
Parameters
| Name | Type |
|---|---|
handler |
(e: Event) => void |
Returns
void
Inherited from
Defined in
clearItems
▸ clearItems(): void
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:273
createEditDialog
▸ createEditDialog(callback): void
Parameters
| Name | Type |
|---|---|
callback |
(dlg: IEditDialog) => void |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:733
destroy
▸ destroy(): void
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:79
editDialogDataChange
▸ editDialogDataChange(): void
Returns
void
Inherited from
SelectEditor.editDialogDataChange
Defined in
src/ui/editors/comboboxeditor.ts:765
emptyItemText
▸ emptyItemText(): string
Returns
string
Inherited from
Defined in
src/ui/editors/selecteditor.ts:18
filterItems
▸ filterItems(items): ComboboxItem<any>[]
Parameters
| Name | Type |
|---|---|
items |
ComboboxItem<any>[] |
Returns
ComboboxItem<any>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:706
getCascadeFromValue
▸ getCascadeFromValue(parent): any
Parameters
| Name | Type |
|---|---|
parent |
Widget<any> |
Returns
any
Inherited from
SelectEditor.getCascadeFromValue
Defined in
src/ui/editors/comboboxeditor.ts:568
getComboboxContainer
▸ getComboboxContainer(): HTMLElement
Returns
HTMLElement
Inherited from
SelectEditor.getComboboxContainer
Defined in
src/ui/editors/comboboxeditor.ts:428
getComboboxOptions
▸ getComboboxOptions(): ComboboxOptions<any>
Returns
ComboboxOptions<any>
Inherited from
SelectEditor.getComboboxOptions
Defined in
src/ui/editors/comboboxeditor.ts:161
getCreateSearchChoice
▸ getCreateSearchChoice(getName): (s: string) => { id: string ; text: string }
Parameters
| Name | Type |
|---|---|
getName |
(z: any) => string |
Returns
fn
▸ (s): Object
Parameters
| Name | Type |
|---|---|
s |
string |
Returns
Object
| Name | Type |
|---|---|
id |
string |
text |
string |
Inherited from
SelectEditor.getCreateSearchChoice
Defined in
src/ui/editors/comboboxeditor.ts:363
getCssClass
▸ getCssClass(): string
Returns
string
Inherited from
Defined in
getCustomAttribute
▸ getCustomAttribute<TAttr>(attrType, inherit?): TAttr
Type parameters
| Name |
|---|
TAttr |
Parameters
| Name | Type | Default value |
|---|---|---|
attrType |
(...args: any[]) => TAttr |
undefined |
inherit |
boolean |
true |
Returns
TAttr
Inherited from
SelectEditor.getCustomAttribute
Defined in
getDialogTypeKey
▸ getDialogTypeKey(): string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:725
getEditValue
▸ getEditValue(property, target): void
Parameters
| Name | Type |
|---|---|
property |
PropertyItem |
target |
any |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:419
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
getGridField
▸ getGridField(): Fluent<HTMLElement>
Returns
Fluent<HTMLElement>
Inherited from
Defined in
getIdField
▸ getIdField(): any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:109
getItems
▸ getItems(): any[]
Returns
any[]
Overrides
Defined in
src/ui/editors/dateyeareditor.ts:14
getPageSize
▸ getPageSize(): number
Returns
number
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:105
getTextField
▸ getTextField(): any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:120
getTypeDelay
▸ getTypeDelay(): any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:96
get_cascadeField
▸ get_cascadeField(): string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:612
get_cascadeFrom
▸ get_cascadeFrom(): string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:593
get_cascadeValue
▸ get_cascadeValue(): any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:628
get_delimited
▸ get_delimited(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:238
get_filterField
▸ get_filterField(): string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:648
get_filterValue
▸ get_filterValue(): any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:664
get_itemByKey
▸ get_itemByKey(): Object
Returns
Object
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:436
get_items
▸ get_items(): ComboboxItem<ComboboxItem<any>>[]
Returns
ComboboxItem<ComboboxItem<any>>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:432
get_readOnly
▸ get_readOnly(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:538
get_text
▸ get_text(): string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:526
get_value
▸ get_value(): string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:462
get_values
▸ get_values(): string[]
Returns
string[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:510
hasAsyncSource
▸ hasAsyncSource(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:85
init
▸ init(): this
Returns
this
Inherited from
Defined in
initNewEntity
▸ initNewEntity(entity): void
Parameters
| Name | Type |
|---|---|
entity |
ComboboxItem<any> |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:742
inplaceCreateClick
▸ inplaceCreateClick(e): void
Parameters
| Name | Type |
|---|---|
e |
Event |
Returns
void
Inherited from
SelectEditor.inplaceCreateClick
Defined in
src/ui/editors/comboboxeditor.ts:771
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
SelectEditor.internalRenderContents
Defined in
isAutoComplete
▸ isAutoComplete(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:359
isMultiple
▸ isMultiple(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:153
itemDisabled
▸ itemDisabled(item): boolean
Parameters
| Name | Type |
|---|---|
item |
ComboboxItem<any> |
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:131
itemId
▸ itemId(item): string
Parameters
| Name | Type |
|---|---|
item |
ComboboxItem<any> |
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:113
itemText
▸ itemText(item): string
Parameters
| Name | Type |
|---|---|
item |
ComboboxItem<any> |
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:124
mapItem
▸ mapItem(item): ComboboxItem<any>
Parameters
| Name | Type |
|---|---|
item |
ComboboxItem<any> |
Returns
ComboboxItem<any>
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:135
mapItems
▸ mapItems(items): ComboboxItem<any>[]
Parameters
| Name | Type |
|---|---|
items |
ComboboxItem<any>[] |
Returns
ComboboxItem<any>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:144
openDropdown
▸ openDropdown(): void
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:842
render
▸ render(): any
Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.
Returns
any
Inherited from
Defined in
renderContents
▸ renderContents(): any
Returns
any
Inherited from
Defined in
setCascadeFrom
▸ setCascadeFrom(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:574
setEditDialogReadOnly
▸ setEditDialogReadOnly(dialog): void
Parameters
| Name | Type |
|---|---|
dialog |
any |
Returns
void
Inherited from
SelectEditor.setEditDialogReadOnly
Defined in
src/ui/editors/comboboxeditor.ts:756
setEditValue
▸ setEditValue(source, property): void
Parameters
| Name | Type |
|---|---|
source |
any |
property |
PropertyItem |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:409
setTermOnNewEntity
▸ setTermOnNewEntity(entity, term): void
Parameters
| Name | Type |
|---|---|
entity |
ComboboxItem<any> |
term |
string |
Returns
void
Inherited from
SelectEditor.setTermOnNewEntity
Defined in
src/ui/editors/comboboxeditor.ts:768
set_cascadeField
▸ set_cascadeField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:620
set_cascadeFrom
▸ set_cascadeFrom(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:601
set_cascadeValue
▸ set_cascadeValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:636
set_filterField
▸ set_filterField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:656
set_filterValue
▸ set_filterValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:672
set_readOnly
▸ set_readOnly(value): void
Parameters
| Name | Type |
|---|---|
value |
boolean |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:557
set_value
▸ set_value(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:470
set_values
▸ set_values(value): void
Parameters
| Name | Type |
|---|---|
value |
string[] |
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:518
syncOrAsyncThen
▸ syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
syncMethod |
() => T |
asyncMethod |
() => PromiseLike<T> |
then |
(v: T) => void |
Returns
void
Inherited from
Defined in
updateItems
▸ updateItems(): void
Returns
void
Inherited from
Defined in
src/ui/editors/selecteditor.ts:25
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
useInplaceAdd
▸ useInplaceAdd(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:352
create
▸ create<TWidget, P>(params): TWidget
Type parameters
| Name | Type |
|---|---|
TWidget |
extends Widget<P> |
P |
P |
Parameters
| Name | Type |
|---|---|
params |
CreateWidgetParams<TWidget, P> |
Returns
TWidget
Inherited from
Defined in
createDefaultElement
▸ createDefaultElement(): HTMLInputElement
Returns
HTMLInputElement
Inherited from
SelectEditor.createDefaultElement
Defined in
src/ui/editors/comboboxeditor.ts:43
filterByText
▸ filterByText<TItem>(items, getText, term): TItem[]
Type parameters
| Name |
|---|
TItem |
Parameters
| Name | Type |
|---|---|
items |
TItem[] |
getText |
(item: TItem) => string |
term |
string |
Returns
TItem[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.ts:440
getWidgetName
▸ getWidgetName(type): string
Parameters
| Name | Type |
|---|---|
type |
Function |
Returns
string