@serenity-is/corelib / CheckLookupEditor
Class: CheckLookupEditor<TItem>
Type parameters
| Name | Type |
|---|---|
TItem |
any |
Hierarchy
CheckTreeEditor<CheckTreeItem<TItem>,CheckLookupEditorOptions>↳
CheckLookupEditor
Table of contents
Constructors
Properties
- allColumns
- cascadeLink
- element
- enableUpdateItems
- filterBar
- idPrefix
- initialSettings
- openDialogsAsPanel
- options
- propertyItemsData
- quickFiltersBar
- quickFiltersDiv
- restoringSettings
- searchText
- slickContainer
- slickGrid
- titleDiv
- toolbar
- uniqueName
- view
- widgetName
- defaultColumnWidthDelta
- defaultColumnWidthScale
- defaultHeaderHeight
- defaultPersistanceStorage
- defaultRowHeight
Accessors
Methods
- addBooleanFilter
- addCssClass
- addDateRangeFilter
- addDateTimeRangeFilter
- addFilterSeparator
- addQuickFilter
- addValidationRule
- afterInit
- allDescendantsSelected
- allItemsSelected
- anyDescendantsSelected
- attrs
- 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
- getDefaultSortBy
- getDelimited
- getDescendantsSelected
- getEditValue
- getElement
- 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
- initAsync
- initSync
- initialPopulate
- initialize
- initializeFilterBar
- internalInit
- internalRefresh
- invokeSubmitHandlers
- isThreeStateHierarchy
- itemAt
- itemLink
- itemSelectedChanged
- layout
- markupReady
- moveSelectedUp
- onClick
- onViewFilter
- onViewProcessData
- onViewSubmit
- persistSettings
- populateLock
- populateUnlock
- populateWhenVisible
- postProcessColumns
- propertyItemsToSlickColumns
- quickFilterChange
- refresh
- refreshIfNeeded
- 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
- tryFindQuickFilter
- updateDisabledState
- updateFlags
- updateInterface
- updateItems
- updateSelectAll
- useAsync
- useLayoutTimer
- usePager
- viewDataChanged
- create
- elementFor
- getWidgetName
- propertyItemToQuickFilter
Constructors
constructor
• new CheckLookupEditor<TItem>(div, options)
Type parameters
| Name | Type |
|---|---|
TItem |
any |
Parameters
| Name | Type |
|---|---|
div |
JQuery |
options |
CheckLookupEditorOptions |
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:478
Properties
allColumns
• Protected allColumns: Column<any>[]
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:103
cascadeLink
• Protected cascadeLink: CascadedWidgetLink<Widget<any>>
Defined in
src/ui/editors/checktreeeditor.ts:592
element
• element: JQuery
Inherited from
Defined in
enableUpdateItems
• Private enableUpdateItems: boolean
Defined in
src/ui/editors/checktreeeditor.ts:476
filterBar
• Protected filterBar: FilterDisplayBar
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:99
idPrefix
• Readonly idPrefix: string
Inherited from
Defined in
initialSettings
• Protected initialSettings: PersistedGridSettings
Inherited from
CheckTreeEditor.initialSettings
Defined in
src/ui/datagrid/datagrid.ts:105
openDialogsAsPanel
• openDialogsAsPanel: boolean
Inherited from
CheckTreeEditor.openDialogsAsPanel
Defined in
src/ui/datagrid/datagrid.ts:109
options
• Protected options: CheckLookupEditorOptions
Inherited from
Defined in
propertyItemsData
• Protected propertyItemsData: PropertyItemsData
Inherited from
CheckTreeEditor.propertyItemsData
Defined in
src/ui/datagrid/datagrid.ts:104
quickFiltersBar
• Protected quickFiltersBar: QuickFilterBar
Inherited from
CheckTreeEditor.quickFiltersBar
Defined in
src/ui/datagrid/datagrid.ts:101
quickFiltersDiv
• Protected quickFiltersDiv: JQuery
Inherited from
CheckTreeEditor.quickFiltersDiv
Defined in
src/ui/datagrid/datagrid.ts:100
restoringSettings
• Protected restoringSettings: number = 0
Inherited from
CheckTreeEditor.restoringSettings
Defined in
src/ui/datagrid/datagrid.ts:106
searchText
• Private searchText: string
Defined in
src/ui/editors/checktreeeditor.ts:475
slickContainer
• Protected slickContainer: JQuery
Inherited from
CheckTreeEditor.slickContainer
Defined in
src/ui/datagrid/datagrid.ts:102
slickGrid
• slickGrid: Grid<any>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:108
titleDiv
• Protected titleDiv: JQuery
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:97
toolbar
• Protected toolbar: Toolbar
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:98
uniqueName
• Protected uniqueName: string
Inherited from
Defined in
view
• view: RemoteView<CheckTreeItem<TItem>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:107
widgetName
• Protected widgetName: string
Inherited from
Defined in
defaultColumnWidthDelta
▪ Static defaultColumnWidthDelta: number
Inherited from
CheckTreeEditor.defaultColumnWidthDelta
Defined in
src/ui/datagrid/datagrid.ts:115
defaultColumnWidthScale
▪ Static defaultColumnWidthScale: number
Inherited from
CheckTreeEditor.defaultColumnWidthScale
Defined in
src/ui/datagrid/datagrid.ts:114
defaultHeaderHeight
▪ Static defaultHeaderHeight: number
Inherited from
CheckTreeEditor.defaultHeaderHeight
Defined in
src/ui/datagrid/datagrid.ts:112
defaultPersistanceStorage
▪ Static defaultPersistanceStorage: SettingStorage
Inherited from
CheckTreeEditor.defaultPersistanceStorage
Defined in
src/ui/datagrid/datagrid.ts:113
defaultRowHeight
▪ Static defaultRowHeight: number
Inherited from
CheckTreeEditor.defaultRowHeight
Defined in
src/ui/datagrid/datagrid.ts:111
Accessors
cascadeField
• get cascadeField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:628
• set cascadeField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:636
cascadeFrom
• get cascadeFrom(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:584
• set cascadeFrom(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:620
cascadeValue
• get cascadeValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:644
• set cascadeValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:656
filterField
• get filterField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:664
• set filterField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:672
filterValue
• get filterValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:680
• set filterValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:692
readOnly
• get readOnly(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.readOnly
Defined in
src/ui/datagrid/datagrid.ts:1027
• set readOnly(value): void
Parameters
| Name | Type |
|---|---|
value |
boolean |
Returns
void
Inherited from
CheckTreeEditor.readOnly
Defined in
src/ui/datagrid/datagrid.ts:1031
value
• get value(): string[]
Returns
string[]
Inherited from
CheckTreeEditor.value
Defined in
src/ui/editors/checktreeeditor.ts:415
• set value(v): void
Parameters
| Name | Type |
|---|---|
v |
string[] |
Returns
void
Inherited from
CheckTreeEditor.value
Defined in
src/ui/editors/checktreeeditor.ts:454
Methods
addBooleanFilter
▸ Protected addBooleanFilter(field, title?, yes?, no?): SelectEditor
Parameters
| Name | Type |
|---|---|
field |
string |
title? |
string |
yes? |
string |
no? |
string |
Returns
Inherited from
CheckTreeEditor.addBooleanFilter
Defined in
src/ui/datagrid/datagrid.ts:1165
addCssClass
▸ Protected addCssClass(): void
Returns
void
Inherited from
Defined in
addDateRangeFilter
▸ Protected addDateRangeFilter(field, title?): DateEditor
Parameters
| Name | Type |
|---|---|
field |
string |
title? |
string |
Returns
Inherited from
CheckTreeEditor.addDateRangeFilter
Defined in
src/ui/datagrid/datagrid.ts:1149
addDateTimeRangeFilter
▸ Protected addDateTimeRangeFilter(field, title?): DateTimeEditor
Parameters
| Name | Type |
|---|---|
field |
string |
title? |
string |
Returns
Inherited from
CheckTreeEditor.addDateTimeRangeFilter
Defined in
src/ui/datagrid/datagrid.ts:1157
addFilterSeparator
▸ Protected addFilterSeparator(): void
Returns
void
Inherited from
CheckTreeEditor.addFilterSeparator
Defined in
src/ui/datagrid/datagrid.ts:1129
addQuickFilter
▸ Protected addQuickFilter<TWidget, TOptions>(opt): TWidget
Type parameters
| Name | Type |
|---|---|
TWidget |
extends Widget<any, TWidget> |
TOptions |
TOptions |
Parameters
| Name | Type |
|---|---|
opt |
QuickFilter<TWidget, TOptions> |
Returns
TWidget
Inherited from
CheckTreeEditor.addQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1145
addValidationRule
▸ addValidationRule(eventClass, rule): JQuery
Parameters
| Name | Type |
|---|---|
eventClass |
string |
rule |
(p1: JQuery) => string |
Returns
JQuery
Inherited from
CheckTreeEditor.addValidationRule
Defined in
afterInit
▸ Protected afterInit(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:194
allDescendantsSelected
▸ Protected allDescendantsSelected(item): boolean
Parameters
| Name | Type |
|---|---|
item |
CheckTreeItem<TItem> |
Returns
boolean
Inherited from
CheckTreeEditor.allDescendantsSelected
Defined in
src/ui/editors/checktreeeditor.ts:283
allItemsSelected
▸ Protected allItemsSelected(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.allItemsSelected
Defined in
src/ui/editors/checktreeeditor.ts:272
anyDescendantsSelected
▸ Protected anyDescendantsSelected(item): boolean
Parameters
| Name | Type |
|---|---|
item |
CheckTreeItem<TItem> |
Returns
boolean
Inherited from
CheckTreeEditor.anyDescendantsSelected
Defined in
src/ui/editors/checktreeeditor.ts:303
attrs
▸ Protected attrs<TAttr>(attrType): TAttr[]
Type parameters
| Name |
|---|
TAttr |
Parameters
| Name | Type |
|---|---|
attrType |
(...args: any[]) => TAttr |
Returns
TAttr[]
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:205
bindToSlickEvents
▸ Protected bindToSlickEvents(): void
Returns
void
Inherited from
CheckTreeEditor.bindToSlickEvents
Defined in
src/ui/datagrid/datagrid.ts:569
bindToViewEvents
▸ Protected bindToViewEvents(): void
Returns
void
Inherited from
CheckTreeEditor.bindToViewEvents
Defined in
src/ui/datagrid/datagrid.ts:669
booleanQuickFilter
▸ Protected booleanQuickFilter(field, title?, yes?, no?): QuickFilter<SelectEditor, SelectEditorOptions>
Parameters
| Name | Type |
|---|---|
field |
string |
title? |
string |
yes? |
string |
no? |
string |
Returns
QuickFilter<SelectEditor, SelectEditorOptions>
Inherited from
CheckTreeEditor.booleanQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1169
canFilterColumn
▸ Protected canFilterColumn(column): boolean
Parameters
| Name | Type |
|---|---|
column |
Column<any> |
Returns
boolean
Inherited from
CheckTreeEditor.canFilterColumn
Defined in
src/ui/datagrid/datagrid.ts:486
canShowColumn
▸ Protected canShowColumn(column): boolean
Parameters
| Name | Type |
|---|---|
column |
Column<any> |
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1204
cascadeItems
▸ Protected cascadeItems(items): TItem[]
Parameters
| Name | Type |
|---|---|
items |
TItem[] |
Returns
TItem[]
Defined in
src/ui/editors/checktreeeditor.ts:517
change
▸ change(handler): void
Parameters
| Name | Type |
|---|---|
handler |
(e: JQueryEventObject) => void |
Returns
void
Inherited from
Defined in
▸ change(handler): void
Parameters
| Name | Type |
|---|---|
handler |
(e: JQueryEventObject) => void |
Returns
void
Inherited from
Defined in
changeSelect2
▸ changeSelect2(handler): void
Parameters
| Name | Type |
|---|---|
handler |
(e: JQueryEventObject) => void |
Returns
void
Inherited from
Defined in
▸ changeSelect2(handler): void
Parameters
| Name | Type |
|---|---|
handler |
(e: JQueryEventObject) => void |
Returns
void
Inherited from
Defined in
createFilterBar
▸ Protected createFilterBar(): void
Returns
void
Inherited from
CheckTreeEditor.createFilterBar
Defined in
src/ui/datagrid/datagrid.ts:798
createIncludeDeletedButton
▸ Protected createIncludeDeletedButton(): void
Returns
void
Inherited from
CheckTreeEditor.createIncludeDeletedButton
Defined in
src/ui/datagrid/datagrid.ts:350
createPager
▸ Protected createPager(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:812
createQuickFilters
▸ Protected createQuickFilters(filters?): void
Parameters
| Name | Type |
|---|---|
filters? |
QuickFilter<Widget<any>, any>[] |
Returns
void
Inherited from
CheckTreeEditor.createQuickFilters
Defined in
src/ui/datagrid/datagrid.ts:246
createQuickSearchInput
▸ Protected createQuickSearchInput(): void
Returns
void
Inherited from
CheckTreeEditor.createQuickSearchInput
Defined in
src/ui/datagrid/datagrid.ts:361
createSlickContainer
▸ Protected createSlickContainer(): JQuery
Returns
JQuery
Inherited from
CheckTreeEditor.createSlickContainer
Defined in
src/ui/datagrid/datagrid.ts:751
createSlickGrid
▸ Protected createSlickGrid(): Grid<any>
Returns
Grid<any>
Inherited from
CheckTreeEditor.createSlickGrid
Defined in
src/ui/editors/checktreeeditor.ts:116
createToolbar
▸ Protected createToolbar(buttons): void
Parameters
| Name | Type |
|---|---|
buttons |
ToolButton[] |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:839
createToolbarExtensions
▸ Protected createToolbarExtensions(): void
Returns
void
Overrides
CheckTreeEditor.createToolbarExtensions
Defined in
src/ui/editors/checktreeeditor.ts:501
createView
▸ Protected createView(): RemoteView<CheckTreeItem<TItem>>
Returns
RemoteView<CheckTreeItem<TItem>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:755
dateRangeQuickFilter
▸ Protected dateRangeQuickFilter(field, title?): QuickFilter<DateEditor, DateTimeEditorOptions>
Parameters
| Name | Type |
|---|---|
field |
string |
title? |
string |
Returns
QuickFilter<DateEditor, DateTimeEditorOptions>
Inherited from
CheckTreeEditor.dateRangeQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1153
dateTimeRangeQuickFilter
▸ Protected dateTimeRangeQuickFilter(field, title?): QuickFilter<DateTimeEditor, DateTimeEditorOptions>
Parameters
| Name | Type |
|---|---|
field |
string |
title? |
string |
Returns
QuickFilter<DateTimeEditor, DateTimeEditorOptions>
Inherited from
CheckTreeEditor.dateTimeRangeQuickFilter
Defined in
src/ui/datagrid/datagrid.ts:1161
destroy
▸ destroy(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:366
determineText
▸ Protected determineText(getKey): string
Parameters
| Name | Type |
|---|---|
getKey |
(prefix: string) => string |
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1133
editItem
▸ Protected editItem(entityOrId): void
Parameters
| Name | Type |
|---|---|
entityOrId |
any |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:635
editItemOfType
▸ Protected editItemOfType(itemType, entityOrId): void
Parameters
| Name | Type |
|---|---|
itemType |
string |
entityOrId |
any |
Returns
void
Inherited from
CheckTreeEditor.editItemOfType
Defined in
src/ui/datagrid/datagrid.ts:639
enableFiltering
▸ Protected enableFiltering(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.enableFiltering
Defined in
src/ui/datagrid/datagrid.ts:789
ensureQuickFilterBar
▸ Protected ensureQuickFilterBar(): QuickFilterBar
Returns
Inherited from
CheckTreeEditor.ensureQuickFilterBar
Defined in
src/ui/datagrid/datagrid.ts:238
filterItems
▸ Protected filterItems(items): TItem[]
Parameters
| Name | Type |
|---|---|
items |
TItem[] |
Returns
TItem[]
Defined in
src/ui/editors/checktreeeditor.ts:539
findQuickFilter
▸ Protected 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:332
getAddButtonCaption
▸ Protected getAddButtonCaption(): string
Returns
string
Inherited from
CheckTreeEditor.getAddButtonCaption
Defined in
src/ui/datagrid/datagrid.ts:627
getButtons
▸ Protected getButtons(): ToolButton[]
Returns
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:497
getCascadeFromValue
▸ Protected getCascadeFromValue(parent): any
Parameters
| Name | Type |
|---|---|
parent |
Widget<any> |
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:588
getColumnWidthDelta
▸ Protected getColumnWidthDelta(): number
Returns
number
Inherited from
CheckTreeEditor.getColumnWidthDelta
Defined in
src/ui/datagrid/datagrid.ts:463
getColumnWidthScale
▸ Protected getColumnWidthScale(): number
Returns
number
Inherited from
CheckTreeEditor.getColumnWidthScale
Defined in
src/ui/datagrid/datagrid.ts:467
getColumns
▸ Protected getColumns(): Column<any>[]
Returns
Column<any>[]
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:318
getColumnsKey
▸ Protected getColumnsKey(): string
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:890
getCssClass
▸ Protected getCssClass(): string
Returns
string
Inherited from
Defined in
getCurrentSettings
▸ Protected getCurrentSettings(flags?): PersistedGridSettings
Parameters
| Name | Type |
|---|---|
flags? |
GridPersistanceFlags |
Returns
Inherited from
CheckTreeEditor.getCurrentSettings
Defined in
src/ui/datagrid/datagrid.ts:1417
getDefaultSortBy
▸ Protected getDefaultSortBy(): any[]
Returns
any[]
Inherited from
CheckTreeEditor.getDefaultSortBy
Defined in
src/ui/datagrid/datagrid.ts:760
getDelimited
▸ Protected getDelimited(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:299
getDescendantsSelected
▸ Protected getDescendantsSelected(item): boolean
Parameters
| Name | Type |
|---|---|
item |
CheckTreeItem<TItem> |
Returns
boolean
Inherited from
CheckTreeEditor.getDescendantsSelected
Defined in
src/ui/editors/checktreeeditor.ts:251
getEditValue
▸ getEditValue(property, target): void
Parameters
| Name | Type |
|---|---|
property |
PropertyItem |
target |
any |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:67
getElement
▸ getElement(): JQuery
Returns
JQuery
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1507
getFilterStore
▸ getFilterStore(): FilterStore
Returns
Inherited from
CheckTreeEditor.getFilterStore
Defined in
src/ui/datagrid/datagrid.ts:1519
getGrid
▸ getGrid(): Grid<any>
Returns
Grid<any>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1511
getGridCanLoad
▸ Protected getGridCanLoad(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.getGridCanLoad
Defined in
src/ui/datagrid/datagrid.ts:986
getGridField
▸ getGridField(): JQuery
Returns
JQuery
Inherited from
Defined in
getIdProperty
▸ Protected getIdProperty(): string
Returns
string
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:38
getIncludeColumns
▸ Protected getIncludeColumns(include): void
Parameters
| Name | Type |
|---|---|
include |
Object |
Returns
void
Inherited from
CheckTreeEditor.getIncludeColumns
Defined in
src/ui/datagrid/datagrid.ts:697
getInitialCollapse
▸ Protected getInitialCollapse(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.getInitialCollapse
Defined in
src/ui/editors/checktreeeditor.ts:150
getInitialTitle
▸ Protected getInitialTitle(): string
Returns
string
Inherited from
CheckTreeEditor.getInitialTitle
Defined in
src/ui/datagrid/datagrid.ts:231
getIsActiveProperty
▸ Protected getIsActiveProperty(): string
Returns
string
Inherited from
CheckTreeEditor.getIsActiveProperty
Defined in
src/ui/datagrid/datagrid.ts:1102
getIsDeletedProperty
▸ Protected getIsDeletedProperty(): string
Returns
string
Inherited from
CheckTreeEditor.getIsDeletedProperty
Defined in
src/ui/datagrid/datagrid.ts:1096
getItemCssClass
▸ Protected 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:400
getItemMetadata
▸ Protected 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:434
getItemText
▸ Protected getItemText(ctx): string
Parameters
| Name | Type |
|---|---|
ctx |
FormatterContext<any> |
Returns
string
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:349
getItemType
▸ Protected getItemType(): string
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:872
getItems
▸ getItems(): CheckTreeItem<TItem>[]
Returns
CheckTreeItem<TItem>[]
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:561
getLocalTextDbPrefix
▸ Protected getLocalTextDbPrefix(): string
Returns
string
Inherited from
CheckTreeEditor.getLocalTextDbPrefix
Defined in
src/ui/datagrid/datagrid.ts:1056
getLocalTextPrefix
▸ Protected getLocalTextPrefix(): string
Returns
string
Inherited from
CheckTreeEditor.getLocalTextPrefix
Defined in
src/ui/datagrid/datagrid.ts:1068
getLookupItems
▸ Protected getLookupItems(lookup): TItem[]
Parameters
| Name | Type |
|---|---|
lookup |
Lookup<TItem> |
Returns
TItem[]
Defined in
src/ui/editors/checktreeeditor.ts:555
getLookupKey
▸ Protected getLookupKey(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:493
getPagerOptions
▸ Protected getPagerOptions(): PagerOptions
Returns
Inherited from
CheckTreeEditor.getPagerOptions
Defined in
src/ui/datagrid/datagrid.ts:804
getPersistanceKey
▸ Protected getPersistanceKey(): string
Returns
string
Inherited from
CheckTreeEditor.getPersistanceKey
Defined in
src/ui/datagrid/datagrid.ts:1189
getPersistanceStorage
▸ Protected getPersistanceStorage(): SettingStorage
Returns
Inherited from
CheckTreeEditor.getPersistanceStorage
Defined in
src/ui/datagrid/datagrid.ts:1185
getPersistedSettings
▸ Protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>
Returns
PersistedGridSettings | Promise<PersistedGridSettings>
Inherited from
CheckTreeEditor.getPersistedSettings
Defined in
src/ui/datagrid/datagrid.ts:1225
getPropertyItems
▸ Protected getPropertyItems(): PropertyItem[]
Returns
Inherited from
CheckTreeEditor.getPropertyItems
Defined in
src/ui/datagrid/datagrid.ts:899
getPropertyItemsData
▸ Protected getPropertyItemsData(): PropertyItemsData
Returns
Inherited from
CheckTreeEditor.getPropertyItemsData
Defined in
src/ui/datagrid/datagrid.ts:903
getPropertyItemsDataAsync
▸ Protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>
Returns
Promise<PropertyItemsData>
Inherited from
CheckTreeEditor.getPropertyItemsDataAsync
Defined in
src/ui/datagrid/datagrid.ts:923
getQuickFilters
▸ Protected getQuickFilters(): QuickFilter<Widget<any>, any>[]
Returns
QuickFilter<Widget<any>, any>[]
Inherited from
CheckTreeEditor.getQuickFilters
Defined in
src/ui/datagrid/datagrid.ts:268
getQuickSearchFields
▸ Protected getQuickSearchFields(): QuickSearchField[]
Returns
Inherited from
CheckTreeEditor.getQuickSearchFields
Defined in
src/ui/datagrid/datagrid.ts:357
getRowDefinition
▸ Protected getRowDefinition(): IRowDefinition
Returns
Inherited from
CheckTreeEditor.getRowDefinition
Defined in
src/ui/datagrid/datagrid.ts:1050
getSelectAllText
▸ Protected getSelectAllText(): string
Returns
string
Overrides
CheckTreeEditor.getSelectAllText
Defined in
src/ui/editors/checktreeeditor.ts:510
getSlickOptions
▸ Protected getSlickOptions(): GridOptions<any>
Returns
GridOptions<any>
Inherited from
CheckTreeEditor.getSlickOptions
Defined in
src/ui/editors/checktreeeditor.ts:353
getTitle
▸ getTitle(): string
Returns
string
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:844
getTreeItems
▸ Protected getTreeItems(): CheckTreeItem<TItem>[]
Returns
CheckTreeItem<TItem>[]
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:559
getView
▸ getView(): RemoteView<CheckTreeItem<TItem>>
Returns
RemoteView<CheckTreeItem<TItem>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1515
getViewOptions
▸ Protected getViewOptions(): RemoteViewOptions
Returns
Inherited from
CheckTreeEditor.getViewOptions
Defined in
src/ui/datagrid/datagrid.ts:817
get_cascadeField
▸ Protected get_cascadeField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:624
get_cascadeFrom
▸ Protected get_cascadeFrom(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:580
get_cascadeValue
▸ Protected get_cascadeValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:640
get_filterField
▸ Protected get_filterField(): string
Returns
string
Defined in
src/ui/editors/checktreeeditor.ts:660
get_filterValue
▸ Protected get_filterValue(): any
Returns
any
Defined in
src/ui/editors/checktreeeditor.ts:676
get_readOnly
▸ get_readOnly(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:393
gridPersistanceFlags
▸ Protected gridPersistanceFlags(): GridPersistanceFlags
Returns
Inherited from
CheckTreeEditor.gridPersistanceFlags
Defined in
src/ui/datagrid/datagrid.ts:1200
init
▸ init(action?): CheckLookupEditor<TItem>
Parameters
| Name | Type |
|---|---|
action? |
(widget: any) => void |
Returns
CheckLookupEditor<TItem>
Inherited from
Defined in
initAsync
▸ Protected initAsync(): Promise<void>
Returns
Promise<void>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:188
initSync
▸ Protected initSync(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:182
initialPopulate
▸ Protected initialPopulate(): void
Returns
void
Inherited from
CheckTreeEditor.initialPopulate
Defined in
src/ui/datagrid/datagrid.ts:471
initialize
▸ initialize(): void
Returns
void
Inherited from
Defined in
initializeFilterBar
▸ Protected initializeFilterBar(): void
Returns
void
Inherited from
CheckTreeEditor.initializeFilterBar
Defined in
src/ui/datagrid/datagrid.ts:493
internalInit
▸ Protected internalInit(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:150
internalRefresh
▸ Protected internalRefresh(): void
Returns
void
Inherited from
CheckTreeEditor.internalRefresh
Defined in
src/ui/datagrid/datagrid.ts:1010
invokeSubmitHandlers
▸ Protected invokeSubmitHandlers(): void
Returns
void
Inherited from
CheckTreeEditor.invokeSubmitHandlers
Defined in
src/ui/datagrid/datagrid.ts:1173
isThreeStateHierarchy
▸ Protected isThreeStateHierarchy(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.isThreeStateHierarchy
Defined in
src/ui/editors/checktreeeditor.ts:112
itemAt
▸ itemAt(row): CheckTreeItem<TItem>
Parameters
| Name | Type |
|---|---|
row |
number |
Returns
CheckTreeItem<TItem>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:553
itemLink
▸ Protected itemLink(itemType?, idField?, text?, cssClass?, encode?): Format<CheckTreeItem<TItem>>
Parameters
| Name | Type | Default value |
|---|---|---|
itemType? |
string |
undefined |
idField? |
string |
undefined |
text? |
(ctx: FormatterContext<any>) => string |
undefined |
cssClass? |
(ctx: FormatterContext<any>) => string |
undefined |
encode |
boolean |
true |
Returns
Format<CheckTreeItem<TItem>>
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:876
itemSelectedChanged
▸ Protected itemSelectedChanged(item): void
Parameters
| Name | Type |
|---|---|
item |
CheckTreeItem<TItem> |
Returns
void
Inherited from
CheckTreeEditor.itemSelectedChanged
Defined in
src/ui/editors/checktreeeditor.ts:105
layout
▸ Protected layout(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:209
markupReady
▸ Protected markupReady(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:748
moveSelectedUp
▸ Protected moveSelectedUp(): boolean
Returns
boolean
Overrides
CheckTreeEditor.moveSelectedUp
Defined in
src/ui/editors/checktreeeditor.ts:576
onClick
▸ Protected onClick(e, row, cell): void
Parameters
| Name | Type |
|---|---|
e |
JQueryEventObject |
row |
number |
cell |
number |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:165
onViewFilter
▸ Protected onViewFilter(item): boolean
Parameters
| Name | Type |
|---|---|
item |
CheckTreeItem<TItem> |
Returns
boolean
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:569
onViewProcessData
▸ Protected 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:154
onViewSubmit
▸ Protected onViewSubmit(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:736
persistSettings
▸ Protected 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:1407
populateLock
▸ Protected populateLock(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:978
populateUnlock
▸ Protected populateUnlock(): void
Returns
void
Inherited from
CheckTreeEditor.populateUnlock
Defined in
src/ui/datagrid/datagrid.ts:982
populateWhenVisible
▸ Protected populateWhenVisible(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.populateWhenVisible
Defined in
src/ui/datagrid/datagrid.ts:794
postProcessColumns
▸ Protected postProcessColumns(columns): Column<any>[]
Parameters
| Name | Type |
|---|---|
columns |
Column<any>[] |
Returns
Column<any>[]
Inherited from
CheckTreeEditor.postProcessColumns
Defined in
src/ui/datagrid/datagrid.ts:442
propertyItemsToSlickColumns
▸ Protected propertyItemsToSlickColumns(propertyItems): Column<any>[]
Parameters
| Name | Type |
|---|---|
propertyItems |
PropertyItem[] |
Returns
Column<any>[]
Inherited from
CheckTreeEditor.propertyItemsToSlickColumns
Defined in
src/ui/datagrid/datagrid.ts:936
quickFilterChange
▸ Protected quickFilterChange(e): void
Parameters
| Name | Type |
|---|---|
e |
JQueryEventObject |
Returns
void
Inherited from
CheckTreeEditor.quickFilterChange
Defined in
src/ui/datagrid/datagrid.ts:1179
refresh
▸ refresh(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:990
refreshIfNeeded
▸ Protected refreshIfNeeded(): void
Returns
void
Inherited from
CheckTreeEditor.refreshIfNeeded
Defined in
src/ui/datagrid/datagrid.ts:1003
renderContents
▸ Protected renderContents(): void
Returns
void
Inherited from
CheckTreeEditor.renderContents
Defined in
resizeCanvas
▸ Protected resizeCanvas(): void
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1121
restoreSettings
▸ Protected 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:1244
restoreSettingsFrom
▸ Protected restoreSettingsFrom(settings, flags?): void
Parameters
| Name | Type |
|---|---|
settings |
PersistedGridSettings |
flags? |
GridPersistanceFlags |
Returns
void
Inherited from
CheckTreeEditor.restoreSettingsFrom
Defined in
src/ui/datagrid/datagrid.ts:1255
rowCount
▸ rowCount(): number
Returns
number
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:557
setAllSubTreeSelected
▸ Protected 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:255
setCascadeFrom
▸ Protected setCascadeFrom(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:594
setCriteriaParameter
▸ Protected setCriteriaParameter(): void
Returns
void
Inherited from
CheckTreeEditor.setCriteriaParameter
Defined in
src/ui/datagrid/datagrid.ts:712
setEditValue
▸ setEditValue(source, property): void
Parameters
| Name | Type |
|---|---|
source |
any |
property |
PropertyItem |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:74
setEquality
▸ Protected setEquality(field, value): void
Parameters
| Name | Type |
|---|---|
field |
string |
value |
any |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:722
setIncludeColumnsParameter
▸ Protected setIncludeColumnsParameter(): void
Returns
void
Inherited from
CheckTreeEditor.setIncludeColumnsParameter
Defined in
src/ui/datagrid/datagrid.ts:726
setInitialSortOrder
▸ Protected setInitialSortOrder(): void
Returns
void
Inherited from
CheckTreeEditor.setInitialSortOrder
Defined in
src/ui/datagrid/datagrid.ts:528
setIsDisabled
▸ setIsDisabled(value): void
Parameters
| Name | Type |
|---|---|
value |
boolean |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:1014
setItems
▸ setItems(value): void
Parameters
| Name | Type |
|---|---|
value |
CheckTreeItem<TItem>[] |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:565
setTitle
▸ setTitle(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:852
set_cascadeField
▸ Protected set_cascadeField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:632
set_cascadeFrom
▸ Protected set_cascadeFrom(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:613
set_cascadeValue
▸ Protected set_cascadeValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:648
set_filterField
▸ Protected set_filterField(value): void
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:668
set_filterValue
▸ Protected set_filterValue(value): void
Parameters
| Name | Type |
|---|---|
value |
any |
Returns
void
Defined in
src/ui/editors/checktreeeditor.ts:684
set_readOnly
▸ set_readOnly(value): void
Parameters
| Name | Type |
|---|---|
value |
boolean |
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:397
sortItems
▸ Protected sortItems(): void
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:359
subDialogDataChange
▸ Protected subDialogDataChange(): void
Returns
void
Inherited from
CheckTreeEditor.subDialogDataChange
Defined in
src/ui/datagrid/datagrid.ts:1125
tryFindQuickFilter
▸ Protected 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:339
updateDisabledState
▸ Protected updateDisabledState(): void
Returns
void
Inherited from
CheckTreeEditor.updateDisabledState
Defined in
src/ui/datagrid/datagrid.ts:1117
updateFlags
▸ Protected updateFlags(): void
Returns
void
Inherited from
Defined in
src/ui/editors/checktreeeditor.ts:214
updateInterface
▸ updateInterface(): void
Returns
void
Inherited from
CheckTreeEditor.updateInterface
Defined in
src/ui/datagrid/datagrid.ts:1046
updateItems
▸ Protected updateItems(): void
Returns
void
Overrides
Defined in
src/ui/editors/checktreeeditor.ts:488
updateSelectAll
▸ Protected updateSelectAll(): void
Returns
void
Inherited from
CheckTreeEditor.updateSelectAll
Defined in
src/ui/editors/checktreeeditor.ts:208
useAsync
▸ Protected useAsync(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:197
useLayoutTimer
▸ Protected useLayoutTimer(): boolean
Returns
boolean
Inherited from
CheckTreeEditor.useLayoutTimer
Defined in
src/ui/datagrid/datagrid.ts:201
usePager
▸ Protected usePager(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/datagrid/datagrid.ts:785
viewDataChanged
▸ Protected 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:664
create
▸ Static create<TWidget, TOpt>(params): TWidget
Type parameters
| Name | Type |
|---|---|
TWidget |
extends Widget<TOpt, TWidget> |
TOpt |
TOpt |
Parameters
| Name | Type |
|---|---|
params |
CreateWidgetParams<TWidget, TOpt> |
Returns
TWidget
Inherited from
Defined in
elementFor
▸ Static elementFor<TWidget>(editorType): JQuery
Type parameters
| Name |
|---|
TWidget |
Parameters
| Name | Type |
|---|---|
editorType |
(...args: any[]) => TWidget |
Returns
JQuery
Inherited from
Defined in
getWidgetName
▸ Static getWidgetName(type): string
Parameters
| Name | Type |
|---|---|
type |
Function |
Returns
string
Inherited from
Defined in
propertyItemToQuickFilter
▸ Static propertyItemToQuickFilter(item): any
Parameters
| Name | Type |
|---|---|
item |
PropertyItem |
Returns
any
Inherited from
CheckTreeEditor.propertyItemToQuickFilter