Skip to content

@serenity-is/corelib / DateYearEditor

Class: DateYearEditor<P>

Extends

Type Parameters

P extends DateYearEditorOptions = DateYearEditorOptions

Constructors

new DateYearEditor()

new DateYearEditor<P>(props): DateYearEditor<P>

Parameters

props

EditorProps<P>

Returns

DateYearEditor<P>

Overrides

SelectEditor.constructor

Defined in

src/ui/editors/dateyeareditor.ts:8

Properties

protected cascadeLink: CascadedWidgetLink<Widget<any>>

Inherited from

SelectEditor.cascadeLink

Defined in

src/ui/editors/comboboxeditor.tsx:576


domNode

readonly domNode: HTMLInputElement

Inherited from

SelectEditor.domNode

Defined in

src/ui/editors/comboboxeditor.tsx:46


idPrefix

readonly idPrefix: string

Inherited from

SelectEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:16


lastCreateTerm

protected lastCreateTerm: string

Inherited from

SelectEditor.lastCreateTerm

Defined in

src/ui/editors/comboboxeditor.tsx:51


onInitNewEntity()

onInitNewEntity: (entity) => void

Parameters

entity

ComboboxItem<any>

Returns

void

Inherited from

SelectEditor.onInitNewEntity

Defined in

src/ui/editors/comboboxeditor.tsx:747


openDialogAsPanel

openDialogAsPanel: boolean

Inherited from

SelectEditor.openDialogAsPanel

Defined in

src/ui/editors/comboboxeditor.tsx:859


options

protected readonly options: WidgetProps<EditorProps<P>>

Inherited from

SelectEditor.options

Defined in

src/ui/widgets/widget.ts:14


uniqueName

readonly uniqueName: string

Inherited from

SelectEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:15


isComponent

readonly static isComponent: true = true

Inherited from

SelectEditor.isComponent

Defined in

src/ui/widgets/widget.ts:223


typeInfo

static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

SelectEditor.typeInfo

Defined in

src/ui/editors/editorwidget.ts:17

Accessors

cascadeField

Get Signature

get cascadeField(): string

Returns

string

Set Signature

set cascadeField(value): void

Parameters
value

string

Returns

void

Inherited from

SelectEditor.cascadeField

Defined in

src/ui/editors/comboboxeditor.tsx:620


cascadeFrom

Get Signature

get cascadeFrom(): string

Returns

string

Set Signature

set cascadeFrom(value): void

Parameters
value

string

Returns

void

Inherited from

SelectEditor.cascadeFrom

Defined in

src/ui/editors/comboboxeditor.tsx:601


cascadeValue

Get Signature

get cascadeValue(): any

Returns

any

Set Signature

set cascadeValue(value): void

Parameters
value

any

Returns

void

Inherited from

SelectEditor.cascadeValue

Defined in

src/ui/editors/comboboxeditor.tsx:636


element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

SelectEditor.element

Defined in

src/ui/widgets/widget.ts:63


filterField

Get Signature

get filterField(): string

Returns

string

Set Signature

set filterField(value): void

Parameters
value

string

Returns

void

Inherited from

SelectEditor.filterField

Defined in

src/ui/editors/comboboxeditor.tsx:656


filterValue

Get Signature

get filterValue(): any

Returns

any

Set Signature

set filterValue(value): void

Parameters
value

any

Returns

void

Inherited from

SelectEditor.filterValue

Defined in

src/ui/editors/comboboxeditor.tsx:672


itemById

Get Signature

get protected itemById(): object

Returns

object

Set Signature

set protected itemById(value): void

Parameters
value
Returns

void

Inherited from

SelectEditor.itemById

Defined in

src/ui/editors/comboboxeditor.tsx:274


items

Get Signature

get items(): ComboboxItem<TItem>[]

Returns

ComboboxItem<TItem>[]

Set Signature

set items(value): void

Parameters
value

ComboboxItem<TItem>[]

Returns

void

Inherited from

SelectEditor.items

Defined in

src/ui/editors/comboboxeditor.tsx:257


props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

SelectEditor.props

Defined in

src/ui/widgets/widget.ts:207


readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Set Signature

set readOnly(value): void

Parameters
value

boolean

Returns

void

Inherited from

SelectEditor.readOnly

Defined in

src/ui/editors/editorwidget.ts:23


selectedItem

Get Signature

get selectedItem(): TItem

Returns

TItem

Inherited from

SelectEditor.selectedItem

Defined in

src/ui/editors/comboboxeditor.tsx:497


selectedItems

Get Signature

get selectedItems(): TItem[]

Returns

TItem[]

Inherited from

SelectEditor.selectedItems

Defined in

src/ui/editors/comboboxeditor.tsx:507


text

Get Signature

get text(): string

Returns

string

Inherited from

SelectEditor.text

Defined in

src/ui/editors/comboboxeditor.tsx:546


value

Get Signature

get value(): string

Returns

string

Set Signature

set value(v): void

Parameters
v

string

Returns

void

Inherited from

SelectEditor.value

Defined in

src/ui/editors/comboboxeditor.tsx:478


values

Get Signature

get values(): string[]

Returns

string[]

Set Signature

set values(value): void

Parameters
value

string[]

Returns

void

Inherited from

SelectEditor.values

Defined in

src/ui/editors/comboboxeditor.tsx:526

Methods

abortPendingQuery()

protected abortPendingQuery(): void

Returns

void

Inherited from

SelectEditor.abortPendingQuery

Defined in

src/ui/editors/comboboxeditor.tsx:159


addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

SelectEditor.addCssClass

Defined in

src/ui/widgets/widget.ts:67


addInplaceCreate()

protected addInplaceCreate(addTitle, editTitle): void

Parameters

addTitle

string

editTitle

string

Returns

void

Inherited from

SelectEditor.addInplaceCreate

Defined in

src/ui/editors/comboboxeditor.tsx:313


addItem()

addItem(item): void

Parameters

item

ComboboxItem<ComboboxItem<any>>

Returns

void

Inherited from

SelectEditor.addItem

Defined in

src/ui/editors/comboboxeditor.tsx:296


addOption()

addOption(key, text, source?, disabled?): void

Parameters

key

string

text

string

source?

any

disabled?

boolean

Returns

void

Inherited from

SelectEditor.addOption

Defined in

src/ui/editors/comboboxeditor.tsx:304


addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters
rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

SelectEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters
uniqueName

string

rule

(input) => string

Returns

void

Inherited from

SelectEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100


afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

SelectEditor.afterRender

Defined in

src/ui/widgets/widget.ts:146


allowClear()

protected allowClear(): boolean

Returns

boolean

Inherited from

SelectEditor.allowClear

Defined in

src/ui/editors/comboboxeditor.tsx:150


asyncSearch()

protected asyncSearch(query): PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>

Parameters

query

ComboboxSearchQuery

Returns

PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>

Inherited from

SelectEditor.asyncSearch

Defined in

src/ui/editors/comboboxeditor.tsx:91


byId()

protected byId<TElement>(id): Fluent<TElement>

Type Parameters

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

SelectEditor.byId

Defined in

src/ui/widgets/widget.ts:106


cascadeItems()

protected cascadeItems(items): ComboboxItem<any>[]

Parameters

items

ComboboxItem<any>[]

Returns

ComboboxItem<any>[]

Inherited from

SelectEditor.cascadeItems

Defined in

src/ui/editors/comboboxeditor.tsx:688


change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

SelectEditor.change

Defined in

src/ui/widgets/widget.ts:118


changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

SelectEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:122


clearItems()

clearItems(): void

Returns

void

Inherited from

SelectEditor.clearItems

Defined in

src/ui/editors/comboboxeditor.tsx:288


createEditDialog()

protected createEditDialog(callback): void

Parameters

callback

(dlg) => void

Returns

void

Inherited from

SelectEditor.createEditDialog

Defined in

src/ui/editors/comboboxeditor.tsx:737


deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

SelectEditor.deferRender

Defined in

src/ui/widgets/widget.ts:71


destroy()

destroy(): void

Returns

void

Inherited from

SelectEditor.destroy

Defined in

src/ui/editors/comboboxeditor.tsx:81


editDialogDataChange()

protected editDialogDataChange(): void

Returns

void

Inherited from

SelectEditor.editDialogDataChange

Defined in

src/ui/editors/comboboxeditor.tsx:772


emptyItemText()

protected emptyItemText(): string

Returns

string

Inherited from

SelectEditor.emptyItemText

Defined in

src/ui/editors/selecteditor.ts:18


filterItems()

protected filterItems(items): ComboboxItem<any>[]

Parameters

items

ComboboxItem<any>[]

Returns

ComboboxItem<any>[]

Inherited from

SelectEditor.filterItems

Defined in

src/ui/editors/comboboxeditor.tsx:710


findById()

protected findById<TElement>(id): TElement

Type Parameters

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

SelectEditor.findById

Defined in

src/ui/widgets/widget.ts:110


get_cascadeField()

protected get_cascadeField(): string

Returns

string

Inherited from

SelectEditor.get_cascadeField

Defined in

src/ui/editors/comboboxeditor.tsx:616


get_cascadeFrom()

protected get_cascadeFrom(): string

Returns

string

Inherited from

SelectEditor.get_cascadeFrom

Defined in

src/ui/editors/comboboxeditor.tsx:597


get_cascadeValue()

protected get_cascadeValue(): any

Returns

any

Inherited from

SelectEditor.get_cascadeValue

Defined in

src/ui/editors/comboboxeditor.tsx:632


get_delimited()

get_delimited(): boolean

Returns

boolean

Inherited from

SelectEditor.get_delimited

Defined in

src/ui/editors/comboboxeditor.tsx:253


get_filterField()

protected get_filterField(): string

Returns

string

Inherited from

SelectEditor.get_filterField

Defined in

src/ui/editors/comboboxeditor.tsx:652


get_filterValue()

protected get_filterValue(): any

Returns

any

Inherited from

SelectEditor.get_filterValue

Defined in

src/ui/editors/comboboxeditor.tsx:668


get_itemByKey()

protected get_itemByKey(): object

Returns

object

Inherited from

SelectEditor.get_itemByKey

Defined in

src/ui/editors/comboboxeditor.tsx:448


get_items()

protected get_items(): ComboboxItem<ComboboxItem<any>>[]

Returns

ComboboxItem<ComboboxItem<any>>[]

Inherited from

SelectEditor.get_items

Defined in

src/ui/editors/comboboxeditor.tsx:444


get_readOnly()

get_readOnly(): boolean

Returns

boolean

Inherited from

SelectEditor.get_readOnly

Defined in

src/ui/editors/comboboxeditor.tsx:550


get_text()

protected get_text(): string

Returns

string

Inherited from

SelectEditor.get_text

Defined in

src/ui/editors/comboboxeditor.tsx:538


get_value()

get_value(): string

Returns

string

Inherited from

SelectEditor.get_value

Defined in

src/ui/editors/comboboxeditor.tsx:474


get_values()

protected get_values(): string[]

Returns

string[]

Inherited from

SelectEditor.get_values

Defined in

src/ui/editors/comboboxeditor.tsx:522


getCascadeFromValue()

protected getCascadeFromValue(parent): any

Parameters

parent

Widget<any>

Returns

any

Inherited from

SelectEditor.getCascadeFromValue

Defined in

src/ui/editors/comboboxeditor.tsx:572


getComboboxContainer()

protected getComboboxContainer(): HTMLElement

Returns

HTMLElement

Inherited from

SelectEditor.getComboboxContainer

Defined in

src/ui/editors/comboboxeditor.tsx:440


getComboboxOptions()

protected getComboboxOptions(): ComboboxOptions<any>

Returns

ComboboxOptions<any>

Inherited from

SelectEditor.getComboboxOptions

Defined in

src/ui/editors/comboboxeditor.tsx:163


getCreateSearchChoice()

getCreateSearchChoice(getName): (s) => object

Parameters

getName

(z) => string

Returns

Function

Parameters
s

string

Returns

object

id

id: string

text

text: string

Inherited from

SelectEditor.getCreateSearchChoice

Defined in

src/ui/editors/comboboxeditor.tsx:375


getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

SelectEditor.getCssClass

Defined in

src/ui/widgets/widget.ts:75


getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Type Parameters

TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

SelectEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142


getDialogTypeKey()

protected getDialogTypeKey(): string

Returns

string

Inherited from

SelectEditor.getDialogTypeKey

Defined in

src/ui/editors/comboboxeditor.tsx:729


getEditValue()

getEditValue(property, target): void

Parameters

property

PropertyItem

target

any

Returns

void

Inherited from

SelectEditor.getEditValue

Defined in

src/ui/editors/comboboxeditor.tsx:431


getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

SelectEditor.getGridField

Defined in

src/ui/widgets/widget.ts:114


getIdField()

protected getIdField(): any

Returns

any

Inherited from

SelectEditor.getIdField

Defined in

src/ui/editors/comboboxeditor.tsx:111


getItems()

getItems(): any[]

Returns

any[]

Overrides

SelectEditor.getItems

Defined in

src/ui/editors/dateyeareditor.ts:14


getPageSize()

protected getPageSize(): number

Returns

number

Inherited from

SelectEditor.getPageSize

Defined in

src/ui/editors/comboboxeditor.tsx:107


getTextField()

protected getTextField(): any

Returns

any

Inherited from

SelectEditor.getTextField

Defined in

src/ui/editors/comboboxeditor.tsx:122


getTypeDelay()

protected getTypeDelay(): any

Returns

any

Inherited from

SelectEditor.getTypeDelay

Defined in

src/ui/editors/comboboxeditor.tsx:98


hasAsyncSource()

protected hasAsyncSource(): boolean

Returns

boolean

Inherited from

SelectEditor.hasAsyncSource

Defined in

src/ui/editors/comboboxeditor.tsx:87


init()

init(): this

Returns

this

Inherited from

SelectEditor.init

Defined in

src/ui/widgets/widget.ts:157


initNewEntity()

protected initNewEntity(entity): void

Parameters

entity

ComboboxItem<any>

Returns

void

Inherited from

SelectEditor.initNewEntity

Defined in

src/ui/editors/comboboxeditor.tsx:749


inplaceCreateClick()

protected inplaceCreateClick(e): void

Parameters

e

Event

Returns

void

Inherited from

SelectEditor.inplaceCreateClick

Defined in

src/ui/editors/comboboxeditor.tsx:784


internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

SelectEditor.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177


isAutoComplete()

protected isAutoComplete(): boolean

Returns

boolean

Inherited from

SelectEditor.isAutoComplete

Defined in

src/ui/editors/comboboxeditor.tsx:371


isMultiple()

protected isMultiple(): boolean

Returns

boolean

Inherited from

SelectEditor.isMultiple

Defined in

src/ui/editors/comboboxeditor.tsx:155


itemDisabled()

protected itemDisabled(item): boolean

Parameters

item

ComboboxItem<any>

Returns

boolean

Inherited from

SelectEditor.itemDisabled

Defined in

src/ui/editors/comboboxeditor.tsx:133


itemId()

protected itemId(item): string

Parameters

item

ComboboxItem<any>

Returns

string

Inherited from

SelectEditor.itemId

Defined in

src/ui/editors/comboboxeditor.tsx:115


itemText()

protected itemText(item): string

Parameters

item

ComboboxItem<any>

Returns

string

Inherited from

SelectEditor.itemText

Defined in

src/ui/editors/comboboxeditor.tsx:126


legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

SelectEditor.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194


mapItem()

protected mapItem(item): ComboboxItem<any>

Parameters

item

ComboboxItem<any>

Returns

ComboboxItem<any>

Inherited from

SelectEditor.mapItem

Defined in

src/ui/editors/comboboxeditor.tsx:137


mapItems()

protected mapItems(items): ComboboxItem<any>[]

Parameters

items

ComboboxItem<any>[]

Returns

ComboboxItem<any>[]

Inherited from

SelectEditor.mapItems

Defined in

src/ui/editors/comboboxeditor.tsx:146


openDropdown()

openDropdown(): void

Returns

void

Inherited from

SelectEditor.openDropdown

Defined in

src/ui/editors/comboboxeditor.tsx:855


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

SelectEditor.render

Defined in

src/ui/widgets/widget.ts:167


renderContents()

protected renderContents(): any

Returns

any

Inherited from

SelectEditor.renderContents

Defined in

src/ui/widgets/widget.ts:188


set_cascadeField()

protected set_cascadeField(value): void

Parameters

value

string

Returns

void

Inherited from

SelectEditor.set_cascadeField

Defined in

src/ui/editors/comboboxeditor.tsx:624


set_cascadeFrom()

protected set_cascadeFrom(value): void

Parameters

value

string

Returns

void

Inherited from

SelectEditor.set_cascadeFrom

Defined in

src/ui/editors/comboboxeditor.tsx:605


set_cascadeValue()

protected set_cascadeValue(value): void

Parameters

value

any

Returns

void

Inherited from

SelectEditor.set_cascadeValue

Defined in

src/ui/editors/comboboxeditor.tsx:640


set_filterField()

protected set_filterField(value): void

Parameters

value

string

Returns

void

Inherited from

SelectEditor.set_filterField

Defined in

src/ui/editors/comboboxeditor.tsx:660


set_filterValue()

protected set_filterValue(value): void

Parameters

value

any

Returns

void

Inherited from

SelectEditor.set_filterValue

Defined in

src/ui/editors/comboboxeditor.tsx:676


set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

SelectEditor.set_readOnly

Defined in

src/ui/editors/comboboxeditor.tsx:565


set_value()

set_value(value): void

Parameters

value

string

Returns

void

Inherited from

SelectEditor.set_value

Defined in

src/ui/editors/comboboxeditor.tsx:482


set_values()

protected set_values(value): void

Parameters

value

string[]

Returns

void

Inherited from

SelectEditor.set_values

Defined in

src/ui/editors/comboboxeditor.tsx:530


setCascadeFrom()

protected setCascadeFrom(value): void

Parameters

value

string

Returns

void

Inherited from

SelectEditor.setCascadeFrom

Defined in

src/ui/editors/comboboxeditor.tsx:578


setEditDialogReadOnly()

protected setEditDialogReadOnly(dialog): void

Parameters

dialog

any

Returns

void

Inherited from

SelectEditor.setEditDialogReadOnly

Defined in

src/ui/editors/comboboxeditor.tsx:763


setEditValue()

setEditValue(source, property): void

Parameters

source

any

property

PropertyItem

Returns

void

Inherited from

SelectEditor.setEditValue

Defined in

src/ui/editors/comboboxeditor.tsx:421


setTermOnNewEntity()

protected setTermOnNewEntity(entity, term, dialog): void

Parameters

entity

ComboboxItem<any>

term

string

dialog

any

Returns

void

Inherited from

SelectEditor.setTermOnNewEntity

Defined in

src/ui/editors/comboboxeditor.tsx:775


syncOrAsyncThen()

protected syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Type Parameters

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

SelectEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211


updateItems()

updateItems(): void

Returns

void

Inherited from

SelectEditor.updateItems

Defined in

src/ui/editors/selecteditor.ts:25


useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

SelectEditor.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218


useInplaceAdd()

protected useInplaceAdd(): boolean

Returns

boolean

Inherited from

SelectEditor.useInplaceAdd

Defined in

src/ui/editors/comboboxeditor.tsx:364


create()

static create<TWidget, P>(params): TWidget

Type Parameters

TWidget extends Widget<P>

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

SelectEditor.create

Defined in

src/ui/widgets/widget.ts:130


createDefaultElement()

static createDefaultElement(): HTMLInputElement

Returns

HTMLInputElement

Inherited from

SelectEditor.createDefaultElement

Defined in

src/ui/editors/comboboxeditor.tsx:45


filterByText()

static filterByText<TItem>(items, getText, term): TItem[]

Type Parameters

TItem

Parameters

items

TItem[]

getText

(item) => string

term

string

Returns

TItem[]

Inherited from

SelectEditor.filterByText

Defined in

src/ui/editors/comboboxeditor.tsx:452


getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

SelectEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95