@serenity-is/corelib / EnumEditor
Class: EnumEditor<P>
Defined in: src/ui/editors/enumeditor.ts:12
Extends
Type Parameters
P
P extends EnumEditorOptions = EnumEditorOptions
Constructors
Constructor
new EnumEditor<
P>(props):EnumEditor<P>
Defined in: src/ui/editors/enumeditor.ts:15
Parameters
props
EditorProps<P>
Returns
EnumEditor<P>
Overrides
Properties
cascadeLink
protectedcascadeLink:CascadedWidgetLink<Widget<any>>
Defined in: src/ui/editors/comboboxeditor.tsx:574
Inherited from
domNode
readonlydomNode:HTMLInputElement
Defined in: src/ui/editors/comboboxeditor.tsx:44
Inherited from
idPrefix
readonlyidPrefix:string
Defined in: src/ui/widgets/widget.ts:13
Inherited from
lastCreateTerm
protectedlastCreateTerm:string
Defined in: src/ui/editors/comboboxeditor.tsx:49
Inherited from
onInitNewEntity()
onInitNewEntity: (
entity) =>void
Defined in: src/ui/editors/comboboxeditor.tsx:745
Parameters
entity
Returns
void
Inherited from
ComboboxEditor.onInitNewEntity
openDialogAsPanel
openDialogAsPanel:
boolean
Defined in: src/ui/editors/comboboxeditor.tsx:857
Inherited from
ComboboxEditor.openDialogAsPanel
options
protectedreadonlyoptions:WidgetProps<EditorProps<P>>
Defined in: src/ui/widgets/widget.ts:11
Inherited from
uniqueName
readonlyuniqueName:string
Defined in: src/ui/widgets/widget.ts:12
Inherited from
[typeInfo]
static[typeInfo]:EditorTypeInfo<"Serenity.">
Defined in: src/ui/editors/enumeditor.ts:13
Overrides
isComponent
readonlystaticisComponent:true=true
Defined in: src/ui/widgets/widget.ts:219
Inherited from
Accessors
cascadeField
Get Signature
get cascadeField():
string
Defined in: src/ui/editors/comboboxeditor.tsx:618
Returns
string
Set Signature
set cascadeField(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:626
Parameters
value
string
Returns
void
Inherited from
cascadeFrom
Get Signature
get cascadeFrom():
string
Defined in: src/ui/editors/comboboxeditor.tsx:599
Returns
string
Set Signature
set cascadeFrom(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:610
Parameters
value
string
Returns
void
Inherited from
cascadeValue
Get Signature
get cascadeValue():
any
Defined in: src/ui/editors/comboboxeditor.tsx:634
Returns
any
Set Signature
set cascadeValue(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:646
Parameters
value
any
Returns
void
Inherited from
element
Get Signature
get element():
Fluent
Defined in: src/ui/widgets/widget.ts:59
Returns a Fluent(this.domNode) object
Returns
Inherited from
filterField
Get Signature
get filterField():
string
Defined in: src/ui/editors/comboboxeditor.tsx:654
Returns
string
Set Signature
set filterField(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:662
Parameters
value
string
Returns
void
Inherited from
filterValue
Get Signature
get filterValue():
any
Defined in: src/ui/editors/comboboxeditor.tsx:670
Returns
any
Set Signature
set filterValue(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:682
Parameters
value
any
Returns
void
Inherited from
itemById
Get Signature
get
protecteditemById():object
Defined in: src/ui/editors/comboboxeditor.tsx:272
Returns
object
Set Signature
set
protecteditemById(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:279
Parameters
value
Returns
void
Inherited from
items
Get Signature
get items():
ComboboxItem<TItem>[]
Defined in: src/ui/editors/comboboxeditor.tsx:255
Returns
ComboboxItem<TItem>[]
Set Signature
set items(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:262
Parameters
value
ComboboxItem<TItem>[]
Returns
void
Inherited from
props
Get Signature
get props():
WidgetProps<P>
Defined in: src/ui/widgets/widget.ts:203
Returns
WidgetProps<P>
Inherited from
readOnly
Get Signature
get readOnly():
boolean
Defined in: src/ui/editors/editorwidget.ts:20
Returns
boolean
Set Signature
set readOnly(
value):void
Defined in: src/ui/editors/editorwidget.ts:25
Parameters
value
boolean
Returns
void
Inherited from
selectedItem
Get Signature
get selectedItem():
TItem
Defined in: src/ui/editors/comboboxeditor.tsx:495
Returns
TItem
Inherited from
selectedItems
Get Signature
get selectedItems():
TItem[]
Defined in: src/ui/editors/comboboxeditor.tsx:505
Returns
TItem[]
Inherited from
text
Get Signature
get text():
string
Defined in: src/ui/editors/comboboxeditor.tsx:544
Returns
string
Inherited from
value
Get Signature
get value():
string
Defined in: src/ui/editors/comboboxeditor.tsx:476
Returns
string
Set Signature
set value(
v):void
Defined in: src/ui/editors/comboboxeditor.tsx:491
Parameters
v
string
Returns
void
Inherited from
values
Get Signature
get values():
string[]
Defined in: src/ui/editors/comboboxeditor.tsx:524
Returns
string[]
Set Signature
set values(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:532
Parameters
value
string[]
Returns
void
Inherited from
Methods
abortPendingQuery()
protectedabortPendingQuery():void
Defined in: src/ui/editors/comboboxeditor.tsx:157
Returns
void
Inherited from
ComboboxEditor.abortPendingQuery
addCssClass()
protectedaddCssClass():void
Defined in: src/ui/widgets/widget.ts:63
Returns
void
Inherited from
addInplaceCreate()
protectedaddInplaceCreate(addTitle,editTitle):void
Defined in: src/ui/editors/comboboxeditor.tsx:311
Parameters
addTitle
string
editTitle
string
Returns
void
Inherited from
ComboboxEditor.addInplaceCreate
addItem()
addItem(
item):void
Defined in: src/ui/editors/comboboxeditor.tsx:294
Parameters
item
ComboboxItem<ComboboxItem<any>>
Returns
void
Inherited from
addOption()
addOption(
key,text,source?,disabled?):void
Defined in: src/ui/editors/comboboxeditor.tsx:302
Parameters
key
string
text
string
source?
any
disabled?
boolean
Returns
void
Inherited from
addValidationRule()
Call Signature
addValidationRule(
rule,uniqueName?):void
Defined in: src/ui/widgets/widget.ts:95
Parameters
rule
(input) => string
uniqueName?
string
Returns
void
Inherited from
ComboboxEditor.addValidationRule
Call Signature
addValidationRule(
uniqueName,rule):void
Defined in: src/ui/widgets/widget.ts:96
Parameters
uniqueName
string
rule
(input) => string
Returns
void
Inherited from
ComboboxEditor.addValidationRule
afterRender()
protectedafterRender(callback):void
Defined in: src/ui/widgets/widget.ts:142
Parameters
callback
() => void
Returns
void
Inherited from
allowClear()
protectedallowClear():boolean
Defined in: src/ui/editors/enumeditor.ts:48
Returns
boolean
Overrides
asyncSearch()
protectedasyncSearch(query):PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>
Defined in: src/ui/editors/comboboxeditor.tsx:89
Parameters
query
Returns
PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>
Inherited from
byId()
protectedbyId<TElement>(id):Fluent<TElement>
Defined in: src/ui/widgets/widget.ts:102
Type Parameters
TElement
TElement extends HTMLElement = HTMLElement
Parameters
id
string
Returns
Fluent<TElement>
Inherited from
cascadeItems()
protectedcascadeItems(items):ComboboxItem<any>[]
Defined in: src/ui/editors/comboboxeditor.tsx:686
Parameters
items
ComboboxItem<any>[]
Returns
ComboboxItem<any>[]
Inherited from
change()
change(
handler):void
Defined in: src/ui/widgets/widget.ts:114
Parameters
handler
(e) => void
Returns
void
Inherited from
changeSelect2()
changeSelect2(
handler):void
Defined in: src/ui/widgets/widget.ts:118
Parameters
handler
(e) => void
Returns
void
Inherited from
clearItems()
clearItems():
void
Defined in: src/ui/editors/comboboxeditor.tsx:286
Returns
void
Inherited from
createEditDialog()
protectedcreateEditDialog(callback):void
Defined in: src/ui/editors/comboboxeditor.tsx:735
Parameters
callback
(dlg) => void
Returns
void
Inherited from
ComboboxEditor.createEditDialog
deferRender()
protecteddeferRender():boolean
Defined in: src/ui/widgets/widget.ts:67
Returns
boolean
Inherited from
destroy()
destroy():
void
Defined in: src/ui/editors/comboboxeditor.tsx:79
Returns
void
Inherited from
editDialogDataChange()
protectededitDialogDataChange():void
Defined in: src/ui/editors/comboboxeditor.tsx:770
Returns
void
Inherited from
ComboboxEditor.editDialogDataChange
emptyItemText()
protectedemptyItemText():string
Defined in: src/ui/editors/comboboxeditor.tsx:100
Returns
string
Inherited from
filterItems()
protectedfilterItems(items):ComboboxItem<any>[]
Defined in: src/ui/editors/comboboxeditor.tsx:708
Parameters
items
ComboboxItem<any>[]
Returns
ComboboxItem<any>[]
Inherited from
findById()
protectedfindById<TElement>(id):TElement
Defined in: src/ui/widgets/widget.ts:106
Type Parameters
TElement
TElement extends HTMLElement = HTMLElement
Parameters
id
string
Returns
TElement
Inherited from
get_cascadeField()
protectedget_cascadeField():string
Defined in: src/ui/editors/comboboxeditor.tsx:614
Returns
string
Inherited from
ComboboxEditor.get_cascadeField
get_cascadeFrom()
protectedget_cascadeFrom():string
Defined in: src/ui/editors/comboboxeditor.tsx:595
Returns
string
Inherited from
ComboboxEditor.get_cascadeFrom
get_cascadeValue()
protectedget_cascadeValue():any
Defined in: src/ui/editors/comboboxeditor.tsx:630
Returns
any
Inherited from
ComboboxEditor.get_cascadeValue
get_delimited()
get_delimited():
boolean
Defined in: src/ui/editors/comboboxeditor.tsx:251
Returns
boolean
Inherited from
get_filterField()
protectedget_filterField():string
Defined in: src/ui/editors/comboboxeditor.tsx:650
Returns
string
Inherited from
ComboboxEditor.get_filterField
get_filterValue()
protectedget_filterValue():any
Defined in: src/ui/editors/comboboxeditor.tsx:666
Returns
any
Inherited from
ComboboxEditor.get_filterValue
get_itemByKey()
protectedget_itemByKey():object
Defined in: src/ui/editors/comboboxeditor.tsx:446
Returns
object
Inherited from
get_items()
protectedget_items():ComboboxItem<ComboboxItem<any>>[]
Defined in: src/ui/editors/comboboxeditor.tsx:442
Returns
ComboboxItem<ComboboxItem<any>>[]
Inherited from
get_readOnly()
get_readOnly():
boolean
Defined in: src/ui/editors/comboboxeditor.tsx:548
Returns
boolean
Inherited from
get_text()
protectedget_text():string
Defined in: src/ui/editors/comboboxeditor.tsx:536
Returns
string
Inherited from
get_value()
get_value():
string
Defined in: src/ui/editors/comboboxeditor.tsx:472
Returns
string
Inherited from
get_values()
protectedget_values():string[]
Defined in: src/ui/editors/comboboxeditor.tsx:520
Returns
string[]
Inherited from
getCascadeFromValue()
protectedgetCascadeFromValue(parent):any
Defined in: src/ui/editors/comboboxeditor.tsx:570
Parameters
parent
Widget<any>
Returns
any
Inherited from
ComboboxEditor.getCascadeFromValue
getComboboxContainer()
protectedgetComboboxContainer():HTMLElement
Defined in: src/ui/editors/comboboxeditor.tsx:438
Returns
HTMLElement
Inherited from
ComboboxEditor.getComboboxContainer
getComboboxOptions()
protectedgetComboboxOptions():ComboboxOptions
Defined in: src/ui/editors/comboboxeditor.tsx:161
Returns
Inherited from
ComboboxEditor.getComboboxOptions
getCreateSearchChoice()
getCreateSearchChoice(
getName): (s) =>object
Defined in: src/ui/editors/comboboxeditor.tsx:373
Parameters
getName
(z) => string
Returns
(
s):object
Parameters
s
string
Returns
object
id
id:
string
text
text:
string
Inherited from
ComboboxEditor.getCreateSearchChoice
getCssClass()
protectedgetCssClass():string
Defined in: src/ui/widgets/widget.ts:71
Returns
string
Inherited from
getCustomAttribute()
protectedgetCustomAttribute<TAttr>(attrType,inherit):TAttr
Defined in: src/ui/widgets/widget.ts:138
Type Parameters
TAttr
TAttr extends CustomAttribute
Parameters
attrType
(...args) => TAttr
inherit
boolean = true
Returns
TAttr
Inherited from
ComboboxEditor.getCustomAttribute
getDialogTypeKey()
protectedgetDialogTypeKey():string
Defined in: src/ui/editors/comboboxeditor.tsx:727
Returns
string
Inherited from
ComboboxEditor.getDialogTypeKey
getEditValue()
getEditValue(
property,target):void
Defined in: src/ui/editors/comboboxeditor.tsx:429
Parameters
property
target
any
Returns
void
Inherited from
getGridField()
getGridField():
Fluent
Defined in: src/ui/widgets/widget.ts:110
Returns
Inherited from
getIdField()
protectedgetIdField():any
Defined in: src/ui/editors/comboboxeditor.tsx:109
Returns
any
Inherited from
getPageSize()
protectedgetPageSize():number
Defined in: src/ui/editors/comboboxeditor.tsx:105
Returns
number
Inherited from
getTextField()
protectedgetTextField():any
Defined in: src/ui/editors/comboboxeditor.tsx:120
Returns
any
Inherited from
getTypeDelay()
protectedgetTypeDelay():any
Defined in: src/ui/editors/comboboxeditor.tsx:96
Returns
any
Inherited from
hasAsyncSource()
protectedhasAsyncSource():boolean
Defined in: src/ui/editors/comboboxeditor.tsx:85
Returns
boolean
Inherited from
init()
init():
this
Defined in: src/ui/widgets/widget.ts:153
Returns
this
Inherited from
initNewEntity()
protectedinitNewEntity(entity):void
Defined in: src/ui/editors/comboboxeditor.tsx:747
Parameters
entity
Returns
void
Inherited from
inplaceCreateClick()
protectedinplaceCreateClick(e):void
Defined in: src/ui/editors/comboboxeditor.tsx:782
Parameters
e
Event
Returns
void
Inherited from
ComboboxEditor.inplaceCreateClick
internalRenderContents()
internalRenderContents():
void
Defined in: src/ui/widgets/widget.ts:173
Returns
void
Inherited from
ComboboxEditor.internalRenderContents
isAutoComplete()
protectedisAutoComplete():boolean
Defined in: src/ui/editors/comboboxeditor.tsx:369
Returns
boolean
Inherited from
isMultiple()
protectedisMultiple():boolean
Defined in: src/ui/editors/comboboxeditor.tsx:153
Returns
boolean
Inherited from
itemDisabled()
protecteditemDisabled(item):boolean
Defined in: src/ui/editors/comboboxeditor.tsx:131
Parameters
item
Returns
boolean
Inherited from
itemId()
protecteditemId(item):string
Defined in: src/ui/editors/comboboxeditor.tsx:113
Parameters
item
Returns
string
Inherited from
itemText()
protecteditemText(item):string
Defined in: src/ui/editors/comboboxeditor.tsx:124
Parameters
item
Returns
string
Inherited from
legacyTemplateRender()
protectedlegacyTemplateRender():boolean
Defined in: src/ui/widgets/widget.ts:190
Returns
boolean
Inherited from
ComboboxEditor.legacyTemplateRender
mapItem()
protectedmapItem(item):ComboboxItem
Defined in: src/ui/editors/comboboxeditor.tsx:135
Parameters
item
Returns
Inherited from
mapItems()
protectedmapItems(items):ComboboxItem<any>[]
Defined in: src/ui/editors/comboboxeditor.tsx:144
Parameters
items
ComboboxItem<any>[]
Returns
ComboboxItem<any>[]
Inherited from
openDropdown()
openDropdown():
void
Defined in: src/ui/editors/comboboxeditor.tsx:853
Returns
void
Inherited from
render()
render():
any
Defined in: src/ui/widgets/widget.ts:163
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
renderContents()
protectedrenderContents():any
Defined in: src/ui/widgets/widget.ts:184
Returns
any
Inherited from
set_cascadeField()
protectedset_cascadeField(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:622
Parameters
value
string
Returns
void
Inherited from
ComboboxEditor.set_cascadeField
set_cascadeFrom()
protectedset_cascadeFrom(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:603
Parameters
value
string
Returns
void
Inherited from
ComboboxEditor.set_cascadeFrom
set_cascadeValue()
protectedset_cascadeValue(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:638
Parameters
value
any
Returns
void
Inherited from
ComboboxEditor.set_cascadeValue
set_filterField()
protectedset_filterField(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:658
Parameters
value
string
Returns
void
Inherited from
ComboboxEditor.set_filterField
set_filterValue()
protectedset_filterValue(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:674
Parameters
value
any
Returns
void
Inherited from
ComboboxEditor.set_filterValue
set_readOnly()
set_readOnly(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:563
Parameters
value
boolean
Returns
void
Inherited from
set_value()
set_value(
value):void
Defined in: src/ui/editors/comboboxeditor.tsx:480
Parameters
value
string
Returns
void
Inherited from
set_values()
protectedset_values(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:528
Parameters
value
string[]
Returns
void
Inherited from
setCascadeFrom()
protectedsetCascadeFrom(value):void
Defined in: src/ui/editors/comboboxeditor.tsx:576
Parameters
value
string
Returns
void
Inherited from
setEditDialogReadOnly()
protectedsetEditDialogReadOnly(dialog):void
Defined in: src/ui/editors/comboboxeditor.tsx:761
Parameters
dialog
any
Returns
void
Inherited from
ComboboxEditor.setEditDialogReadOnly
setEditValue()
setEditValue(
source,property):void
Defined in: src/ui/editors/comboboxeditor.tsx:419
Parameters
source
any
property
Returns
void
Inherited from
setTermOnNewEntity()
protectedsetTermOnNewEntity(entity,term,dialog):void
Defined in: src/ui/editors/comboboxeditor.tsx:773
Parameters
entity
term
string
dialog
any
Returns
void
Inherited from
ComboboxEditor.setTermOnNewEntity
syncOrAsyncThen()
protectedsyncOrAsyncThen<T>(syncMethod,asyncMethod,then):void
Defined in: src/ui/widgets/widget.ts:207
Type Parameters
T
T
Parameters
syncMethod
() => T
asyncMethod
() => PromiseLike<T>
then
(v) => void
Returns
void
Inherited from
ComboboxEditor.syncOrAsyncThen
updateItems()
protectedupdateItems():void|PromiseLike<void>
Defined in: src/ui/editors/enumeditor.ts:21
Returns
void | PromiseLike<void>
Overrides
useIdPrefix()
protecteduseIdPrefix():IdPrefixType
Defined in: src/ui/widgets/widget.ts:214
Returns
Inherited from
useInplaceAdd()
protecteduseInplaceAdd():boolean
Defined in: src/ui/editors/comboboxeditor.tsx:362
Returns
boolean
Inherited from
create()
staticcreate<TWidget,P>(params):TWidget
Defined in: src/ui/widgets/widget.ts:126
Type Parameters
TWidget
TWidget extends Widget<P>
P
P
Parameters
params
CreateWidgetParams<TWidget, P>
Returns
TWidget
Inherited from
createDefaultElement()
staticcreateDefaultElement():HTMLInputElement
Defined in: src/ui/editors/comboboxeditor.tsx:43
Returns
HTMLInputElement
Inherited from
ComboboxEditor.createDefaultElement
filterByText()
staticfilterByText<TItem>(items,getText,term):TItem[]
Defined in: src/ui/editors/comboboxeditor.tsx:450
Type Parameters
TItem
TItem
Parameters
items
TItem[]
getText
(item) => string
term
string
Returns
TItem[]
Inherited from
getWidgetName()
staticgetWidgetName(type):string
Defined in: src/ui/widgets/widget.ts:91
Parameters
type
Function
Returns
string
Inherited from
registerClass()
protectedstaticregisterClass<TypeName>(typeName,intfAndAttr?):ClassTypeInfo<TypeName>
Defined in: src/ui/widgets/widget.ts:221
Type Parameters
TypeName
TypeName
Parameters
typeName
StringLiteral<TypeName>
intfAndAttr?
(InterfaceType | AttributeSpecifier)[]
Returns
ClassTypeInfo<TypeName>
Inherited from
registerEditor()
protectedstaticregisterEditor<TypeName>(typeName,intfAndAttr?):EditorTypeInfo<TypeName>
Defined in: src/ui/widgets/widget.ts:230
Type Parameters
TypeName
TypeName
Parameters
typeName
StringLiteral<TypeName>
intfAndAttr?
(InterfaceType | AttributeSpecifier)[]
Returns
EditorTypeInfo<TypeName>