@serenity-is/corelib / DateYearEditor
Class: DateYearEditor<P>
Extends
SelectEditor<P>
Type Parameters
• P extends DateYearEditorOptions = DateYearEditorOptions
Constructors
new DateYearEditor()
new DateYearEditor<
P>(props):DateYearEditor<P>
Parameters
props
EditorProps<P>
Returns
Overrides
Defined in
src/ui/editors/dateyeareditor.ts:8
Properties
cascadeLink
protectedcascadeLink:CascadedWidgetLink<Widget<any>>
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:576
domNode
readonlydomNode:HTMLInputElement
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:46
idPrefix
readonlyidPrefix:string
Inherited from
Defined in
lastCreateTerm
protectedlastCreateTerm:string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:51
onInitNewEntity()
onInitNewEntity: (
entity) =>void
Parameters
entity
ComboboxItem<any>
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:747
openDialogAsPanel
openDialogAsPanel:
boolean
Inherited from
SelectEditor.openDialogAsPanel
Defined in
src/ui/editors/comboboxeditor.tsx:859
options
protectedreadonlyoptions:WidgetProps<EditorProps<P>>
Inherited from
Defined in
uniqueName
readonlyuniqueName:string
Inherited from
Defined in
isComponent
readonlystaticisComponent:true=true
Inherited from
Defined in
typeInfo
statictypeInfo:ClassTypeInfo<"Serenity.EditorWidget">
Inherited from
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
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
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
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
Defined in
filterField
Get Signature
get filterField():
string
Returns
string
Set Signature
set filterField(
value):void
Parameters
value
string
Returns
void
Inherited from
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
Defined in
src/ui/editors/comboboxeditor.tsx:672
itemById
Get Signature
get
protecteditemById():object
Returns
object
Set Signature
set
protecteditemById(value):void
Parameters
value
Returns
void
Inherited from
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
Defined in
src/ui/editors/comboboxeditor.tsx:257
props
Get Signature
get props():
WidgetProps<P>
Returns
WidgetProps<P>
Inherited from
Defined in
readOnly
Get Signature
get readOnly():
boolean
Returns
boolean
Set Signature
set readOnly(
value):void
Parameters
value
boolean
Returns
void
Inherited from
Defined in
src/ui/editors/editorwidget.ts:23
selectedItem
Get Signature
get selectedItem():
TItem
Returns
TItem
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:497
selectedItems
Get Signature
get selectedItems():
TItem[]
Returns
TItem[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:507
text
Get Signature
get text():
string
Returns
string
Inherited from
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
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
Defined in
src/ui/editors/comboboxeditor.tsx:526
Methods
abortPendingQuery()
protectedabortPendingQuery():void
Returns
void
Inherited from
SelectEditor.abortPendingQuery
Defined in
src/ui/editors/comboboxeditor.tsx:159
addCssClass()
protectedaddCssClass():void
Returns
void
Inherited from
Defined in
addInplaceCreate()
protectedaddInplaceCreate(addTitle,editTitle):void
Parameters
addTitle
string
editTitle
string
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:313
addItem()
addItem(
item):void
Parameters
item
ComboboxItem<ComboboxItem<any>>
Returns
void
Inherited from
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
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
Call Signature
addValidationRule(
uniqueName,rule):void
Parameters
uniqueName
string
rule
(input) => string
Returns
void
Inherited from
SelectEditor.addValidationRule
Defined in
afterRender()
protectedafterRender(callback):void
Parameters
callback
() => void
Returns
void
Inherited from
Defined in
allowClear()
protectedallowClear():boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:150
asyncSearch()
protectedasyncSearch(query):PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>
Parameters
query
Returns
PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:91
byId()
protectedbyId<TElement>(id):Fluent<TElement>
Type Parameters
• TElement extends HTMLElement = HTMLElement
Parameters
id
string
Returns
Fluent<TElement>
Inherited from
Defined in
cascadeItems()
protectedcascadeItems(items):ComboboxItem<any>[]
Parameters
items
ComboboxItem<any>[]
Returns
ComboboxItem<any>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:688
change()
change(
handler):void
Parameters
handler
(e) => void
Returns
void
Inherited from
Defined in
changeSelect2()
changeSelect2(
handler):void
Parameters
handler
(e) => void
Returns
void
Inherited from
Defined in
clearItems()
clearItems():
void
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:288
createEditDialog()
protectedcreateEditDialog(callback):void
Parameters
callback
(dlg) => void
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:737
deferRender()
protecteddeferRender():boolean
Returns
boolean
Inherited from
Defined in
destroy()
destroy():
void
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:81
editDialogDataChange()
protectededitDialogDataChange():void
Returns
void
Inherited from
SelectEditor.editDialogDataChange
Defined in
src/ui/editors/comboboxeditor.tsx:772
emptyItemText()
protectedemptyItemText():string
Returns
string
Inherited from
Defined in
src/ui/editors/selecteditor.ts:18
filterItems()
protectedfilterItems(items):ComboboxItem<any>[]
Parameters
items
ComboboxItem<any>[]
Returns
ComboboxItem<any>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:710
findById()
protectedfindById<TElement>(id):TElement
Type Parameters
• TElement extends HTMLElement = HTMLElement
Parameters
id
string
Returns
TElement
Inherited from
Defined in
get_cascadeField()
protectedget_cascadeField():string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:616
get_cascadeFrom()
protectedget_cascadeFrom():string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:597
get_cascadeValue()
protectedget_cascadeValue():any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:632
get_delimited()
get_delimited():
boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:253
get_filterField()
protectedget_filterField():string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:652
get_filterValue()
protectedget_filterValue():any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:668
get_itemByKey()
protectedget_itemByKey():object
Returns
object
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:448
get_items()
protectedget_items():ComboboxItem<ComboboxItem<any>>[]
Returns
ComboboxItem<ComboboxItem<any>>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:444
get_readOnly()
get_readOnly():
boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:550
get_text()
protectedget_text():string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:538
get_value()
get_value():
string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:474
get_values()
protectedget_values():string[]
Returns
string[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:522
getCascadeFromValue()
protectedgetCascadeFromValue(parent):any
Parameters
parent
Widget<any>
Returns
any
Inherited from
SelectEditor.getCascadeFromValue
Defined in
src/ui/editors/comboboxeditor.tsx:572
getComboboxContainer()
protectedgetComboboxContainer():HTMLElement
Returns
HTMLElement
Inherited from
SelectEditor.getComboboxContainer
Defined in
src/ui/editors/comboboxeditor.tsx:440
getComboboxOptions()
protectedgetComboboxOptions():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()
protectedgetCssClass():string
Returns
string
Inherited from
Defined in
getCustomAttribute()
protectedgetCustomAttribute<TAttr>(attrType,inherit):TAttr
Type Parameters
• TAttr
Parameters
attrType
(...args) => TAttr
inherit
boolean = true
Returns
TAttr
Inherited from
SelectEditor.getCustomAttribute
Defined in
getDialogTypeKey()
protectedgetDialogTypeKey():string
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:729
getEditValue()
getEditValue(
property,target):void
Parameters
property
target
any
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:431
getGridField()
getGridField():
Fluent<HTMLElement>
Returns
Fluent<HTMLElement>
Inherited from
Defined in
getIdField()
protectedgetIdField():any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:111
getItems()
getItems():
any[]
Returns
any[]
Overrides
Defined in
src/ui/editors/dateyeareditor.ts:14
getPageSize()
protectedgetPageSize():number
Returns
number
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:107
getTextField()
protectedgetTextField():any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:122
getTypeDelay()
protectedgetTypeDelay():any
Returns
any
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:98
hasAsyncSource()
protectedhasAsyncSource():boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:87
init()
init():
this
Returns
this
Inherited from
Defined in
initNewEntity()
protectedinitNewEntity(entity):void
Parameters
entity
ComboboxItem<any>
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:749
inplaceCreateClick()
protectedinplaceCreateClick(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
isAutoComplete()
protectedisAutoComplete():boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:371
isMultiple()
protectedisMultiple():boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:155
itemDisabled()
protecteditemDisabled(item):boolean
Parameters
item
ComboboxItem<any>
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:133
itemId()
protecteditemId(item):string
Parameters
item
ComboboxItem<any>
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:115
itemText()
protecteditemText(item):string
Parameters
item
ComboboxItem<any>
Returns
string
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:126
legacyTemplateRender()
protectedlegacyTemplateRender():boolean
Returns
boolean
Inherited from
SelectEditor.legacyTemplateRender
Defined in
mapItem()
protectedmapItem(item):ComboboxItem<any>
Parameters
item
ComboboxItem<any>
Returns
ComboboxItem<any>
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:137
mapItems()
protectedmapItems(items):ComboboxItem<any>[]
Parameters
items
ComboboxItem<any>[]
Returns
ComboboxItem<any>[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:146
openDropdown()
openDropdown():
void
Returns
void
Inherited from
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
Defined in
renderContents()
protectedrenderContents():any
Returns
any
Inherited from
Defined in
set_cascadeField()
protectedset_cascadeField(value):void
Parameters
value
string
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:624
set_cascadeFrom()
protectedset_cascadeFrom(value):void
Parameters
value
string
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:605
set_cascadeValue()
protectedset_cascadeValue(value):void
Parameters
value
any
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:640
set_filterField()
protectedset_filterField(value):void
Parameters
value
string
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:660
set_filterValue()
protectedset_filterValue(value):void
Parameters
value
any
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:676
set_readOnly()
set_readOnly(
value):void
Parameters
value
boolean
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:565
set_value()
set_value(
value):void
Parameters
value
string
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:482
set_values()
protectedset_values(value):void
Parameters
value
string[]
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:530
setCascadeFrom()
protectedsetCascadeFrom(value):void
Parameters
value
string
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:578
setEditDialogReadOnly()
protectedsetEditDialogReadOnly(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
Returns
void
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:421
setTermOnNewEntity()
protectedsetTermOnNewEntity(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()
protectedsyncOrAsyncThen<T>(syncMethod,asyncMethod,then):void
Type Parameters
• T
Parameters
syncMethod
() => T
asyncMethod
() => PromiseLike<T>
then
(v) => void
Returns
void
Inherited from
Defined in
updateItems()
updateItems():
void
Returns
void
Inherited from
Defined in
src/ui/editors/selecteditor.ts:25
useIdPrefix()
protecteduseIdPrefix():IdPrefixType
Returns
Inherited from
Defined in
useInplaceAdd()
protecteduseInplaceAdd():boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:364
create()
staticcreate<TWidget,P>(params):TWidget
Type Parameters
• TWidget extends Widget<P>
• P
Parameters
params
CreateWidgetParams<TWidget, P>
Returns
TWidget
Inherited from
Defined in
createDefaultElement()
staticcreateDefaultElement():HTMLInputElement
Returns
HTMLInputElement
Inherited from
SelectEditor.createDefaultElement
Defined in
src/ui/editors/comboboxeditor.tsx:45
filterByText()
staticfilterByText<TItem>(items,getText,term):TItem[]
Type Parameters
• TItem
Parameters
items
TItem[]
getText
(item) => string
term
string
Returns
TItem[]
Inherited from
Defined in
src/ui/editors/comboboxeditor.tsx:452
getWidgetName()
staticgetWidgetName(type):string
Parameters
type
Function
Returns
string