@serenity-is/corelib / CheckLookupEditor
Class: CheckLookupEditor<TItem, P>
Type parameters
Name | Type |
---|---|
TItem |
extends CheckTreeItem <TItem > = any |
P |
extends CheckLookupEditorOptions = CheckLookupEditorOptions |
Hierarchy
CheckTreeEditor
<CheckTreeItem
<TItem
>,P
>↳
CheckLookupEditor
Table of contents
Constructors
Properties
- allColumns
- cascadeLink
- domNode
- filterBar
- idPrefix
- initialSettings
- openDialogsAsPanel
- options
- propertyItemsData
- quickFiltersBar
- quickFiltersDiv
- restoringSettings
- slickContainer
- slickGrid
- titleDiv
- toolbar
- uniqueName
- view
- defaultColumnWidthDelta
- defaultColumnWidthScale
- defaultHeaderHeight
- defaultPersistanceStorage
- defaultRowHeight
- typeInfo
Accessors
Methods
- addBooleanFilter
- addCssClass
- addDateRangeFilter
- addDateTimeRangeFilter
- addFilterSeparator
- addQuickFilter
- addValidationRule
- afterInit
- allDescendantsSelected
- allItemsSelected
- anyDescendantsSelected
- bindToSlickEvents
- bindToViewEvents
- booleanQuickFilter
- canFilterColumn
- canShowColumn
- cascadeItems
- change
- changeSelect2
- createFilterBar
- createIncludeDeletedButton
- createPager
- createQuickFilters
- createQuickSearchInput
- createSlickContainer
- createSlickGrid
- createToolbar
- createToolbarExtensions
- createView
- dateRangeQuickFilter
- dateTimeRangeQuickFilter
- destroy
- determineText
- editItem
- editItemOfType
- enableFiltering
- ensureQuickFilterBar
- filterItems
- findQuickFilter
- getAddButtonCaption
- getButtons
- getCascadeFromValue
- getColumnWidthDelta
- getColumnWidthScale
- getColumns
- getColumnsKey
- getCssClass
- getCurrentSettings
- getCustomAttribute
- getDefaultSortBy
- getDelimited
- getDescendantsSelected
- getEditValue
- getElement
- getFieldElement
- getFilterStore
- getGrid
- getGridCanLoad
- getGridField
- getIdProperty
- getIncludeColumns
- getInitialCollapse
- getInitialTitle
- getIsActiveProperty
- getIsDeletedProperty
- getItemCssClass
- getItemMetadata
- getItemText
- getItemType
- getItems
- getLocalTextDbPrefix
- getLocalTextPrefix
- getLookupItems
- getLookupKey
- getPagerOptions
- getPersistanceKey
- getPersistanceStorage
- getPersistedSettings
- getPropertyItems
- getPropertyItemsData
- getPropertyItemsDataAsync
- getQuickFilters
- getQuickSearchFields
- getRowDefinition
- getSelectAllText
- getSlickOptions
- getTitle
- getTreeItems
- getView
- getViewOptions
- get_cascadeField
- get_cascadeFrom
- get_cascadeValue
- get_filterField
- get_filterValue
- get_readOnly
- gridPersistanceFlags
- init
- initialPopulate
- initializeFilterBar
- internalInit
- internalRefresh
- internalRenderContents
- invokeSubmitHandlers
- isThreeStateHierarchy
- itemAt
- itemLink
- itemSelectedChanged
- layout
- markupReady
- moveSelectedUp
- onClick
- onViewFilter
- onViewProcessData
- onViewSubmit
- persistSettings
- populateLock
- populateUnlock
- populateWhenVisible
- postProcessColumns
- propertyItemsReady
- propertyItemsToSlickColumns
- quickFilterChange
- refresh
- refreshIfNeeded
- render
- renderContents
- resizeCanvas
- restoreSettings
- restoreSettingsFrom
- rowCount
- setAllSubTreeSelected
- setCascadeFrom
- setCriteriaParameter
- setEditValue
- setEquality
- setIncludeColumnsParameter
- setInitialSortOrder
- setIsDisabled
- setItems
- setTitle
- set_cascadeField
- set_cascadeFrom
- set_cascadeValue
- set_filterField
- set_filterValue
- set_readOnly
- sortItems
- subDialogDataChange
- syncOrAsyncThen
- tryFindQuickFilter
- updateDisabledState
- updateFlags
- updateInterface
- updateItems
- updateSelectAll
- useAsync
- useIdPrefix
- useLayoutTimer
- usePager
- viewDataChanged
- wrapFormatterWithEditLink
- create
- createDefaultElement
- getWidgetName
- propertyItemToQuickFilter
Constructors
constructor
• new CheckLookupEditor<TItem
, P
>(props
): CheckLookupEditor
<TItem
, P
>
Type parameters
Name | Type |
---|---|
TItem |
extends CheckTreeItem <TItem > = any |
P |
extends CheckLookupEditorOptions = CheckLookupEditorOptions |
Parameters
Name | Type |
---|---|
props |
EditorProps <P > |
Returns
CheckLookupEditor
<TItem
, P
>
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:481
Properties
allColumns
• Protected
allColumns: Column
<any
>[]
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:75
cascadeLink
• Protected
cascadeLink: CascadedWidgetLink
<Widget
<any
>>
Defined in
src/ui/editors/checktreeeditor.ts:602
domNode
• Readonly
domNode: HTMLElement
Inherited from
Defined in
filterBar
• Protected
filterBar: FilterDisplayBar
<>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:71
idPrefix
• Readonly
idPrefix: string
Inherited from
Defined in
initialSettings
• Protected
initialSettings: PersistedGridSettings
Inherited from
CheckTreeEditor.initialSettings
Defined in
src/ui/datagrid/datagrid.ts:77
openDialogsAsPanel
• openDialogsAsPanel: boolean
Inherited from
CheckTreeEditor.openDialogsAsPanel
Defined in
src/ui/datagrid/datagrid.ts:81
options
• Protected
Readonly
options: WidgetProps
<P
>
Inherited from
Defined in
propertyItemsData
• Protected
propertyItemsData: PropertyItemsData
Inherited from
CheckTreeEditor.propertyItemsData
Defined in
src/ui/datagrid/datagrid.ts:76
quickFiltersBar
• Protected
quickFiltersBar: QuickFilterBar
<QuickFilterBarOptions
>
Inherited from
CheckTreeEditor.quickFiltersBar
Defined in
src/ui/datagrid/datagrid.ts:73
quickFiltersDiv
• Protected
quickFiltersDiv: Fluent
<HTMLElement
>
Inherited from
CheckTreeEditor.quickFiltersDiv
Defined in
src/ui/datagrid/datagrid.ts:72
restoringSettings
• Protected
restoringSettings: number
= 0
Inherited from
CheckTreeEditor.restoringSettings
Defined in
src/ui/datagrid/datagrid.ts:78
slickContainer
• Protected
slickContainer: Fluent
<HTMLElement
>
Inherited from
CheckTreeEditor.slickContainer
Defined in
src/ui/datagrid/datagrid.ts:74
slickGrid
• slickGrid: Grid
<any
>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:80
titleDiv
• Protected
titleDiv: Fluent
<HTMLElement
>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:69
toolbar
• Protected
toolbar: Toolbar
<ToolbarOptions
>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:70
uniqueName
• Protected
Readonly
uniqueName: string
Inherited from
Defined in
view
• view: RemoteView
<CheckTreeItem
<TItem
>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:79
defaultColumnWidthDelta
▪ Static
defaultColumnWidthDelta: number
Inherited from
CheckTreeEditor.defaultColumnWidthDelta
Defined in
src/ui/datagrid/datagrid.ts:87
defaultColumnWidthScale
▪ Static
defaultColumnWidthScale: number
Inherited from
CheckTreeEditor.defaultColumnWidthScale
Defined in
src/ui/datagrid/datagrid.ts:86
defaultHeaderHeight
▪ Static
defaultHeaderHeight: number
Inherited from
CheckTreeEditor.defaultHeaderHeight
Defined in
src/ui/datagrid/datagrid.ts:84
defaultPersistanceStorage
▪ Static
defaultPersistanceStorage: SettingStorage
Inherited from
CheckTreeEditor.defaultPersistanceStorage
Defined in
src/ui/datagrid/datagrid.ts:85
defaultRowHeight
▪ Static
defaultRowHeight: number
Inherited from
CheckTreeEditor.defaultRowHeight
Defined in
src/ui/datagrid/datagrid.ts:83
typeInfo
▪ Static
typeInfo: ClassTypeInfo
<"Serenity.Widget"
>
Inherited from
Defined in
Accessors
cascadeField
• get
cascadeField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:638
• set
cascadeField(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:646
cascadeFrom
• get
cascadeFrom(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:594
• set
cascadeFrom(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:630
cascadeValue
• get
cascadeValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:654
• set
cascadeValue(value
): void
Parameters
Name | Type |
---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:666
element
• get
element(): Fluent
<HTMLElement
>
Returns a Fluent(this.domNode) object
Returns
Fluent
<HTMLElement
>
Inherited from
CheckTreeEditor.element
Defined in
filterField
• get
filterField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:674
• set
filterField(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:682
filterValue
• get
filterValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:690
• set
filterValue(value
): void
Parameters
Name | Type |
---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:702
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Inherited from
CheckTreeEditor.props
Defined in
readOnly
• get
readOnly(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.readOnly
Defined in
src/ui/datagrid/datagrid.ts:976
• set
readOnly(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Inherited from
CheckTreeEditor.readOnly
Defined in
src/ui/datagrid/datagrid.ts:980
value
• get
value(): string
[]
Returns
string
[]
Inherited from
CheckTreeEditor.value
Defined in
src/ui/editors/checktreeeditor.ts:417
• set
value(v
): void
Parameters
Name | Type |
---|---|
v |
string [] |
Returns
void
Inherited from
CheckTreeEditor.value
Defined in
src/ui/editors/checktreeeditor.ts:456
Methods
addBooleanFilter
▸ addBooleanFilter(field
, title?
, yes?
, no?
): SelectEditor
<SelectEditorOptions
>
Parameters
Name | Type |
---|---|
field |
string |
title? |
string |
yes? |
string |
no? |
string |
Returns
SelectEditor
<SelectEditorOptions
>
Inherited from
CheckTreeEditor.addBooleanFilter
Defined in
src/ui/datagrid/datagrid.ts:1111
addCssClass
▸ addCssClass(): void
Returns
void
Inherited from
Defined in
addDateRangeFilter
▸ addDateRangeFilter(field
, title?
): DateEditor
<DateEditorOptions
>
Parameters
Name | Type |
---|---|
field |
string |
title? |
string |
Returns
Inherited from
CheckTreeEditor.addDateRangeFilter
Defined in
src/ui/datagrid/datagrid.ts:1095
addDateTimeRangeFilter
▸ addDateTimeRangeFilter(field
, title?
): DateTimeEditor
<DateTimeEditorOptions
>
Parameters
Name | Type |
---|---|
field |
string |
title? |
string |
Returns
DateTimeEditor
<DateTimeEditorOptions
>
Inherited from
CheckTreeEditor.addDateTimeRangeFilter
Defined in
src/ui/datagrid/datagrid.ts:1103
addFilterSeparator
▸ addFilterSeparator(): void
Returns
void
Inherited from
CheckTreeEditor.addFilterSeparator
Defined in
src/ui/datagrid/datagrid.ts:1075
addQuickFilter
▸ addQuickFilter<TWidget
, P
>(opt
): TWidget
Type parameters
Name | Type |
---|---|
TWidget |
extends Widget <any > |
P |
P |
Parameters
Name | Type |
---|---|
opt |
QuickFilter <TWidget , P > |
Returns
TWidget
Inherited from
CheckTreeEditor.addQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1091
addValidationRule
▸ addValidationRule(rule
, uniqueName?
): void
Parameters
Name | Type |
---|---|
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
uniqueName? |
string |
Returns
void
Inherited from
CheckTreeEditor.addValidationRule
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Inherited from
CheckTreeEditor.addValidationRule
Defined in
afterInit
▸ afterInit(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:154
allDescendantsSelected
▸ allDescendantsSelected(item
): boolean
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
Returns
boolean
Inherited from
CheckTreeEditor.allDescendantsSelected
Defined in
src/ui/editors/checktreeeditor.ts:285
allItemsSelected
▸ allItemsSelected(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.allItemsSelected
Defined in
src/ui/editors/checktreeeditor.ts:274
anyDescendantsSelected
▸ anyDescendantsSelected(item
): boolean
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
Returns
boolean
Inherited from
CheckTreeEditor.anyDescendantsSelected
Defined in
src/ui/editors/checktreeeditor.ts:305
bindToSlickEvents
▸ bindToSlickEvents(): void
Returns
void
Inherited from
CheckTreeEditor.bindToSlickEvents
Defined in
src/ui/datagrid/datagrid.ts:519
bindToViewEvents
▸ bindToViewEvents(): void
Returns
void
Inherited from
CheckTreeEditor.bindToViewEvents
Defined in
src/ui/datagrid/datagrid.ts:619
booleanQuickFilter
▸ booleanQuickFilter(field
, title?
, yes?
, no?
): QuickFilter
<SelectEditor
<SelectEditorOptions
>, SelectEditorOptions
>
Parameters
Name | Type |
---|---|
field |
string |
title? |
string |
yes? |
string |
no? |
string |
Returns
QuickFilter
<SelectEditor
<SelectEditorOptions
>, SelectEditorOptions
>
Inherited from
CheckTreeEditor.booleanQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1115
canFilterColumn
▸ canFilterColumn(column
): boolean
Parameters
Name | Type |
---|---|
column |
Column <any > |
Returns
boolean
Inherited from
CheckTreeEditor.canFilterColumn
Defined in
src/ui/datagrid/datagrid.ts:436
canShowColumn
▸ canShowColumn(column
): boolean
Parameters
Name | Type |
---|---|
column |
Column <any > |
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1150
cascadeItems
▸ cascadeItems(items
): TItem
[]
Parameters
Name | Type |
---|---|
items |
TItem [] |
Returns
TItem
[]
Defined in
src/ui/editors/checktreeeditor.ts:528
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
createFilterBar
▸ createFilterBar(): void
Returns
void
Inherited from
CheckTreeEditor.createFilterBar
Defined in
src/ui/datagrid/datagrid.ts:747
createIncludeDeletedButton
▸ createIncludeDeletedButton(): void
Returns
void
Inherited from
CheckTreeEditor.createIncludeDeletedButton
Defined in
src/ui/datagrid/datagrid.ts:303
createPager
▸ createPager(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:762
createQuickFilters
▸ createQuickFilters(filters?
): void
Parameters
Name | Type |
---|---|
filters? |
QuickFilter <Widget <any >, any >[] |
Returns
void
Inherited from
CheckTreeEditor.createQuickFilters
Defined in
src/ui/datagrid/datagrid.ts:202
createQuickSearchInput
▸ createQuickSearchInput(): void
Returns
void
Inherited from
CheckTreeEditor.createQuickSearchInput
Defined in
src/ui/datagrid/datagrid.ts:312
createSlickContainer
▸ createSlickContainer(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
CheckTreeEditor.createSlickContainer
Defined in
src/ui/datagrid/datagrid.ts:701
createSlickGrid
▸ createSlickGrid(): Grid
<any
>
Returns
Grid
<any
>
Inherited from
CheckTreeEditor.createSlickGrid
Defined in
src/ui/editors/checktreeeditor.ts:119
createToolbar
▸ createToolbar(buttons
): void
Parameters
Name | Type |
---|---|
buttons |
ToolButton [] |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:788
createToolbarExtensions
▸ createToolbarExtensions(): void
Returns
void
Overrides
CheckTreeEditor.createToolbarExtensions
Defined in
src/ui/editors/checktreeeditor.ts:512
createView
▸ createView(): RemoteView
<CheckTreeItem
<TItem
>>
Returns
RemoteView
<CheckTreeItem
<TItem
>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:705
dateRangeQuickFilter
▸ dateRangeQuickFilter(field
, title?
): QuickFilter
<DateEditor
<DateEditorOptions
>, DateTimeEditorOptions
>
Parameters
Name | Type |
---|---|
field |
string |
title? |
string |
Returns
QuickFilter
<DateEditor
<DateEditorOptions
>, DateTimeEditorOptions
>
Inherited from
CheckTreeEditor.dateRangeQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1099
dateTimeRangeQuickFilter
▸ dateTimeRangeQuickFilter(field
, title?
): QuickFilter
<DateTimeEditor
<DateTimeEditorOptions
>, DateTimeEditorOptions
>
Parameters
Name | Type |
---|---|
field |
string |
title? |
string |
Returns
QuickFilter
<DateTimeEditor
<DateTimeEditorOptions
>, DateTimeEditorOptions
>
Inherited from
CheckTreeEditor.dateTimeRangeQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1107
destroy
▸ destroy(): void
Returns
void
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:490
determineText
▸ determineText(getKey
): string
Parameters
Name | Type |
---|---|
getKey |
(prefix : string ) => string |
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1079
editItem
▸ editItem(entityOrId
): void
Parameters
Name | Type |
---|---|
entityOrId |
any |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:585
editItemOfType
▸ editItemOfType(itemType
, entityOrId
): void
Parameters
Name | Type |
---|---|
itemType |
string |
entityOrId |
any |
Returns
void
Inherited from
CheckTreeEditor.editItemOfType
Defined in
src/ui/datagrid/datagrid.ts:589
enableFiltering
▸ enableFiltering(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.enableFiltering
Defined in
src/ui/datagrid/datagrid.ts:739
ensureQuickFilterBar
▸ ensureQuickFilterBar(): QuickFilterBar
<QuickFilterBarOptions
>
Returns
QuickFilterBar
<QuickFilterBarOptions
>
Inherited from
CheckTreeEditor.ensureQuickFilterBar
Defined in
src/ui/datagrid/datagrid.ts:194
filterItems
▸ filterItems(items
): TItem
[]
Parameters
Name | Type |
---|---|
items |
TItem [] |
Returns
TItem
[]
Defined in
src/ui/editors/checktreeeditor.ts:550
findQuickFilter
▸ findQuickFilter<TWidget
>(type
, field
): TWidget
Type parameters
Name |
---|
TWidget |
Parameters
Name | Type |
---|---|
type |
(...args : any []) => TWidget |
field |
string |
Returns
TWidget
Inherited from
CheckTreeEditor.findQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:289
getAddButtonCaption
▸ getAddButtonCaption(): string
Returns
string
Inherited from
CheckTreeEditor.getAddButtonCaption
Defined in
src/ui/datagrid/datagrid.ts:577
getButtons
▸ getButtons(): ToolButton
[]
Returns
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:508
getCascadeFromValue
▸ getCascadeFromValue(parent
): any
Parameters
Name | Type |
---|---|
parent |
Widget <any > |
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:598
getColumnWidthDelta
▸ getColumnWidthDelta(): number
Returns
number
Inherited from
CheckTreeEditor.getColumnWidthDelta
Defined in
src/ui/datagrid/datagrid.ts:413
getColumnWidthScale
▸ getColumnWidthScale(): number
Returns
number
Inherited from
CheckTreeEditor.getColumnWidthScale
Defined in
src/ui/datagrid/datagrid.ts:417
getColumns
▸ getColumns(): Column
<any
>[]
Returns
Column
<any
>[]
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:320
getColumnsKey
▸ getColumnsKey(): string
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:844
getCssClass
▸ getCssClass(): string
Returns
string
Inherited from
Defined in
getCurrentSettings
▸ getCurrentSettings(flags?
): PersistedGridSettings
Parameters
Name | Type |
---|---|
flags? |
GridPersistanceFlags |
Returns
Inherited from
CheckTreeEditor.getCurrentSettings
Defined in
src/ui/datagrid/datagrid.ts:1363
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
CheckTreeEditor.getCustomAttribute
Defined in
getDefaultSortBy
▸ getDefaultSortBy(): any
[]
Returns
any
[]
Inherited from
CheckTreeEditor.getDefaultSortBy
Defined in
src/ui/datagrid/datagrid.ts:710
getDelimited
▸ getDelimited(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:301
getDescendantsSelected
▸ getDescendantsSelected(item
): boolean
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
Returns
boolean
Inherited from
CheckTreeEditor.getDescendantsSelected
Defined in
src/ui/editors/checktreeeditor.ts:253
getEditValue
▸ getEditValue(property
, target
): void
Parameters
Name | Type |
---|---|
property |
PropertyItem |
target |
any |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:70
getElement
▸ getElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1453
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
CheckTreeEditor.getFieldElement
Defined in
getFilterStore
▸ getFilterStore(): FilterStore
Returns
Inherited from
CheckTreeEditor.getFilterStore
Defined in
src/ui/datagrid/datagrid.ts:1465
getGrid
▸ getGrid(): Grid
<any
>
Returns
Grid
<any
>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1457
getGridCanLoad
▸ getGridCanLoad(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.getGridCanLoad
Defined in
src/ui/datagrid/datagrid.ts:935
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
Defined in
getIdProperty
▸ getIdProperty(): string
Returns
string
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:41
getIncludeColumns
▸ getIncludeColumns(include
): void
Parameters
Name | Type |
---|---|
include |
Object |
Returns
void
Inherited from
CheckTreeEditor.getIncludeColumns
Defined in
src/ui/datagrid/datagrid.ts:647
getInitialCollapse
▸ getInitialCollapse(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.getInitialCollapse
Defined in
src/ui/editors/checktreeeditor.ts:152
getInitialTitle
▸ getInitialTitle(): string
Returns
string
Inherited from
CheckTreeEditor.getInitialTitle
Defined in
src/ui/datagrid/datagrid.ts:187
getIsActiveProperty
▸ getIsActiveProperty(): string
Returns
string
Inherited from
CheckTreeEditor.getIsActiveProperty
Defined in
src/ui/datagrid/datagrid.ts:1048
getIsDeletedProperty
▸ getIsDeletedProperty(): string
Returns
string
Inherited from
CheckTreeEditor.getIsDeletedProperty
Defined in
src/ui/datagrid/datagrid.ts:1042
getItemCssClass
▸ getItemCssClass(item
, index
): string
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
index |
number |
Returns
string
Inherited from
CheckTreeEditor.getItemCssClass
Defined in
src/ui/datagrid/datagrid.ts:351
getItemMetadata
▸ getItemMetadata(item
, index
): any
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
index |
number |
Returns
any
Inherited from
CheckTreeEditor.getItemMetadata
Defined in
src/ui/datagrid/datagrid.ts:384
getItemText
▸ getItemText(ctx
): string
Parameters
Name | Type |
---|---|
ctx |
FormatterContext <any > |
Returns
string
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:351
getItemType
▸ getItemType(): string
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:826
getItems
▸ getItems(): CheckTreeItem
<TItem
>[]
Returns
CheckTreeItem
<TItem
>[]
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:511
getLocalTextDbPrefix
▸ getLocalTextDbPrefix(): string
Returns
string
Inherited from
CheckTreeEditor.getLocalTextDbPrefix
Defined in
src/ui/datagrid/datagrid.ts:1005
getLocalTextPrefix
▸ getLocalTextPrefix(): string
Returns
string
Inherited from
CheckTreeEditor.getLocalTextPrefix
Defined in
src/ui/datagrid/datagrid.ts:1017
getLookupItems
▸ getLookupItems(lookup
): TItem
[]
Parameters
Name | Type |
---|---|
lookup |
Lookup <TItem > |
Returns
TItem
[]
Defined in
src/ui/editors/checktreeeditor.ts:566
getLookupKey
▸ getLookupKey(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:504
getPagerOptions
▸ getPagerOptions(): PagerOptions
Returns
Inherited from
CheckTreeEditor.getPagerOptions
Defined in
src/ui/datagrid/datagrid.ts:754
getPersistanceKey
▸ getPersistanceKey(): string
Returns
string
Inherited from
CheckTreeEditor.getPersistanceKey
Defined in
src/ui/datagrid/datagrid.ts:1135
getPersistanceStorage
▸ getPersistanceStorage(): SettingStorage
Returns
Inherited from
CheckTreeEditor.getPersistanceStorage
Defined in
src/ui/datagrid/datagrid.ts:1131
getPersistedSettings
▸ getPersistedSettings(): PersistedGridSettings
| Promise
<PersistedGridSettings
>
Returns
PersistedGridSettings
| Promise
<PersistedGridSettings
>
Inherited from
CheckTreeEditor.getPersistedSettings
Defined in
src/ui/datagrid/datagrid.ts:1171
getPropertyItems
▸ getPropertyItems(): PropertyItem
[]
Returns
Inherited from
CheckTreeEditor.getPropertyItems
Defined in
src/ui/datagrid/datagrid.ts:848
getPropertyItemsData
▸ getPropertyItemsData(): PropertyItemsData
Returns
Inherited from
CheckTreeEditor.getPropertyItemsData
Defined in
src/ui/datagrid/datagrid.ts:852
getPropertyItemsDataAsync
▸ getPropertyItemsDataAsync(): Promise
<PropertyItemsData
>
Returns
Promise
<PropertyItemsData
>
Inherited from
CheckTreeEditor.getPropertyItemsDataAsync
Defined in
src/ui/datagrid/datagrid.ts:872
getQuickFilters
▸ getQuickFilters(): QuickFilter
<Widget
<any
>, any
>[]
Returns
QuickFilter
<Widget
<any
>, any
>[]
Inherited from
CheckTreeEditor.getQuickFilters
Defined in
src/ui/datagrid/datagrid.ts:225
getQuickSearchFields
▸ getQuickSearchFields(): QuickSearchField
[]
Returns
Inherited from
CheckTreeEditor.getQuickSearchFields
Defined in
src/ui/datagrid/datagrid.ts:308
getRowDefinition
▸ getRowDefinition(): IRowDefinition
Returns
Inherited from
CheckTreeEditor.getRowDefinition
Defined in
src/ui/datagrid/datagrid.ts:999
getSelectAllText
▸ getSelectAllText(): string
Returns
string
Overrides
CheckTreeEditor.getSelectAllText
Defined in
src/ui/editors/checktreeeditor.ts:521
getSlickOptions
▸ getSlickOptions(): GridOptions
<any
>
Returns
GridOptions
<any
>
Inherited from
CheckTreeEditor.getSlickOptions
Defined in
src/ui/editors/checktreeeditor.ts:355
getTitle
▸ getTitle(): string
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:796
getTreeItems
▸ getTreeItems(): CheckTreeItem
<TItem
>[]
Returns
CheckTreeItem
<TItem
>[]
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:570
getView
▸ getView(): RemoteView
<CheckTreeItem
<TItem
>>
Returns
RemoteView
<CheckTreeItem
<TItem
>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1461
getViewOptions
▸ getViewOptions(): RemoteViewOptions
Returns
Inherited from
CheckTreeEditor.getViewOptions
Defined in
src/ui/datagrid/datagrid.ts:766
get_cascadeField
▸ get_cascadeField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:634
get_cascadeFrom
▸ get_cascadeFrom(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:590
get_cascadeValue
▸ get_cascadeValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:650
get_filterField
▸ get_filterField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:670
get_filterValue
▸ get_filterValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:686
get_readOnly
▸ get_readOnly(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:395
gridPersistanceFlags
▸ gridPersistanceFlags(): GridPersistanceFlags
Returns
Inherited from
CheckTreeEditor.gridPersistanceFlags
Defined in
src/ui/datagrid/datagrid.ts:1146
init
▸ init(): this
Returns
this
Inherited from
Defined in
initialPopulate
▸ initialPopulate(): void
Returns
void
Inherited from
CheckTreeEditor.initialPopulate
Defined in
src/ui/datagrid/datagrid.ts:421
initializeFilterBar
▸ initializeFilterBar(): void
Returns
void
Inherited from
CheckTreeEditor.initializeFilterBar
Defined in
src/ui/datagrid/datagrid.ts:443
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRefresh
▸ internalRefresh(): void
Returns
void
Inherited from
CheckTreeEditor.internalRefresh
Defined in
src/ui/datagrid/datagrid.ts:959
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
CheckTreeEditor.internalRenderContents
Defined in
invokeSubmitHandlers
▸ invokeSubmitHandlers(): void
Returns
void
Inherited from
CheckTreeEditor.invokeSubmitHandlers
Defined in
src/ui/datagrid/datagrid.ts:1119
isThreeStateHierarchy
▸ isThreeStateHierarchy(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.isThreeStateHierarchy
Defined in
src/ui/editors/checktreeeditor.ts:115
itemAt
▸ itemAt(row
): CheckTreeItem
<TItem
>
Parameters
Name | Type |
---|---|
row |
number |
Returns
CheckTreeItem
<TItem
>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:503
itemLink
▸ itemLink(itemType?
, idField?
, text?
, cssClass?
, encode?
): Format
<CheckTreeItem
<TItem
>>
Parameters
Name | Type | Default value |
---|---|---|
itemType? |
string |
undefined |
idField? |
string |
undefined |
text? |
Format <CheckTreeItem <TItem >> |
undefined |
cssClass? |
(ctx : FormatterContext <any >) => string |
undefined |
encode |
boolean |
true |
Returns
Format
<CheckTreeItem
<TItem
>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:830
itemSelectedChanged
▸ itemSelectedChanged(item
): void
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
Returns
void
Inherited from
CheckTreeEditor.itemSelectedChanged
Defined in
src/ui/editors/checktreeeditor.ts:108
layout
▸ layout(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:165
markupReady
▸ markupReady(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:698
moveSelectedUp
▸ moveSelectedUp(): boolean
Returns
boolean
Overrides
CheckTreeEditor.moveSelectedUp
Defined in
src/ui/editors/checktreeeditor.ts:586
onClick
▸ onClick(e
, row
, cell
): void
Parameters
Name | Type |
---|---|
e |
Event |
row |
number |
cell |
number |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:167
onViewFilter
▸ onViewFilter(item
): boolean
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
Returns
boolean
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:580
onViewProcessData
▸ onViewProcessData(response
): ListResponse
<CheckTreeItem
<TItem
>>
Parameters
Name | Type |
---|---|
response |
ListResponse <CheckTreeItem <TItem >> |
Returns
ListResponse
<CheckTreeItem
<TItem
>>
Inherited from
CheckTreeEditor.onViewProcessData
Defined in
src/ui/editors/checktreeeditor.ts:156
onViewSubmit
▸ onViewSubmit(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:686
persistSettings
▸ persistSettings(flags?
): void
| Promise
<void
>
Parameters
Name | Type |
---|---|
flags? |
GridPersistanceFlags |
Returns
void
| Promise
<void
>
Inherited from
CheckTreeEditor.persistSettings
Defined in
src/ui/datagrid/datagrid.ts:1353
populateLock
▸ populateLock(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:927
populateUnlock
▸ populateUnlock(): void
Returns
void
Inherited from
CheckTreeEditor.populateUnlock
Defined in
src/ui/datagrid/datagrid.ts:931
populateWhenVisible
▸ populateWhenVisible(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.populateWhenVisible
Defined in
src/ui/datagrid/datagrid.ts:743
postProcessColumns
▸ postProcessColumns(columns
): Column
<any
>[]
Parameters
Name | Type |
---|---|
columns |
Column <any >[] |
Returns
Column
<any
>[]
Inherited from
CheckTreeEditor.postProcessColumns
Defined in
src/ui/datagrid/datagrid.ts:392
propertyItemsReady
▸ propertyItemsReady(itemsData
): void
Parameters
Name | Type |
---|---|
itemsData |
PropertyItemsData |
Returns
void
Inherited from
CheckTreeEditor.propertyItemsReady
Defined in
src/ui/datagrid/datagrid.ts:121
propertyItemsToSlickColumns
▸ propertyItemsToSlickColumns(propertyItems
): Column
<any
>[]
Parameters
Name | Type |
---|---|
propertyItems |
PropertyItem [] |
Returns
Column
<any
>[]
Inherited from
CheckTreeEditor.propertyItemsToSlickColumns
Defined in
src/ui/datagrid/datagrid.ts:900
quickFilterChange
▸ quickFilterChange(e
): void
Parameters
Name | Type |
---|---|
e |
Event |
Returns
void
Inherited from
CheckTreeEditor.quickFilterChange
Defined in
src/ui/datagrid/datagrid.ts:1125
refresh
▸ refresh(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:939
refreshIfNeeded
▸ refreshIfNeeded(): void
Returns
void
Inherited from
CheckTreeEditor.refreshIfNeeded
Defined in
src/ui/datagrid/datagrid.ts:952
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
CheckTreeEditor.renderContents
Defined in
resizeCanvas
▸ resizeCanvas(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1067
restoreSettings
▸ restoreSettings(settings?
, flags?
): void
| Promise
<void
>
Parameters
Name | Type |
---|---|
settings? |
PersistedGridSettings |
flags? |
GridPersistanceFlags |
Returns
void
| Promise
<void
>
Inherited from
CheckTreeEditor.restoreSettings
Defined in
src/ui/datagrid/datagrid.ts:1190
restoreSettingsFrom
▸ restoreSettingsFrom(settings
, flags?
): void
Parameters
Name | Type |
---|---|
settings |
PersistedGridSettings |
flags? |
GridPersistanceFlags |
Returns
void
Inherited from
CheckTreeEditor.restoreSettingsFrom
Defined in
src/ui/datagrid/datagrid.ts:1201
rowCount
▸ rowCount(): number
Returns
number
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:507
setAllSubTreeSelected
▸ setAllSubTreeSelected(item
, selected
): boolean
Parameters
Name | Type |
---|---|
item |
CheckTreeItem <TItem > |
selected |
boolean |
Returns
boolean
Inherited from
CheckTreeEditor.setAllSubTreeSelected
Defined in
src/ui/editors/checktreeeditor.ts:257
setCascadeFrom
▸ setCascadeFrom(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:604
setCriteriaParameter
▸ setCriteriaParameter(): void
Returns
void
Inherited from
CheckTreeEditor.setCriteriaParameter
Defined in
src/ui/datagrid/datagrid.ts:662
setEditValue
▸ setEditValue(source
, property
): void
Parameters
Name | Type |
---|---|
source |
any |
property |
PropertyItem |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:77
setEquality
▸ setEquality(field
, value
): void
Parameters
Name | Type |
---|---|
field |
string |
value |
any |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:672
setIncludeColumnsParameter
▸ setIncludeColumnsParameter(): void
Returns
void
Inherited from
CheckTreeEditor.setIncludeColumnsParameter
Defined in
src/ui/datagrid/datagrid.ts:676
setInitialSortOrder
▸ setInitialSortOrder(): void
Returns
void
Inherited from
CheckTreeEditor.setInitialSortOrder
Defined in
src/ui/datagrid/datagrid.ts:478
setIsDisabled
▸ setIsDisabled(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:963
setItems
▸ setItems(value
): void
Parameters
Name | Type |
---|---|
value |
CheckTreeItem <TItem >[] |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:515
setTitle
▸ setTitle(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:804
set_cascadeField
▸ set_cascadeField(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:642
set_cascadeFrom
▸ set_cascadeFrom(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:623
set_cascadeValue
▸ set_cascadeValue(value
): void
Parameters
Name | Type |
---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:658
set_filterField
▸ set_filterField(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:678
set_filterValue
▸ set_filterValue(value
): void
Parameters
Name | Type |
---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:694
set_readOnly
▸ set_readOnly(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:399
sortItems
▸ sortItems(): void
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:361
subDialogDataChange
▸ subDialogDataChange(): void
Returns
void
Inherited from
CheckTreeEditor.subDialogDataChange
Defined in
src/ui/datagrid/datagrid.ts:1071
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
CheckTreeEditor.syncOrAsyncThen
Defined in
tryFindQuickFilter
▸ tryFindQuickFilter<TWidget
>(type
, field
): TWidget
Type parameters
Name |
---|
TWidget |
Parameters
Name | Type |
---|---|
type |
(...args : any []) => TWidget |
field |
string |
Returns
TWidget
Inherited from
CheckTreeEditor.tryFindQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:296
updateDisabledState
▸ updateDisabledState(): void
Returns
void
Inherited from
CheckTreeEditor.updateDisabledState
Defined in
src/ui/datagrid/datagrid.ts:1063
updateFlags
▸ updateFlags(): void
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:216
updateInterface
▸ updateInterface(): void
Returns
void
Inherited from
CheckTreeEditor.updateInterface
Defined in
src/ui/datagrid/datagrid.ts:995
updateItems
▸ updateItems(): void
Returns
void
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:499
updateSelectAll
▸ updateSelectAll(): void
Returns
void
Inherited from
CheckTreeEditor.updateSelectAll
Defined in
src/ui/editors/checktreeeditor.ts:210
useAsync
▸ useAsync(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:157
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
useLayoutTimer
▸ useLayoutTimer(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.useLayoutTimer
Defined in
src/ui/datagrid/datagrid.ts:161
usePager
▸ usePager(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:735
viewDataChanged
▸ viewDataChanged(e
, rows
): void
Parameters
Name | Type |
---|---|
e |
any |
rows |
CheckTreeItem <TItem >[] |
Returns
void
Inherited from
CheckTreeEditor.viewDataChanged
Defined in
src/ui/datagrid/datagrid.ts:614
wrapFormatterWithEditLink
▸ wrapFormatterWithEditLink(column
, item
): void
Parameters
Name | Type |
---|---|
column |
Column <any > |
item |
PropertyItem |
Returns
void
Inherited from
CheckTreeEditor.wrapFormatterWithEditLink
Defined in
src/ui/datagrid/datagrid.ts:885
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(): HTMLDivElement
Returns
HTMLDivElement
Inherited from
CheckTreeEditor.createDefaultElement
Defined in
src/ui/editors/checktreeeditor.ts:30
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string
Inherited from
Defined in
propertyItemToQuickFilter
▸ propertyItemToQuickFilter(item
): any
Parameters
Name | Type |
---|---|
item |
PropertyItem |
Returns
any
Inherited from
CheckTreeEditor.propertyItemToQuickFilter