@serenity-is/corelib / CheckLookupEditor

Class: CheckLookupEditor<TItem, P>

Extends

• CheckTreeEditor<CheckTreeItem<TItem>, P>

Type Parameters

• TItem extends CheckTreeItem<TItem> = any

• P extends CheckLookupEditorOptions = CheckLookupEditorOptions

Constructors

new CheckLookupEditor()

new CheckLookupEditor<TItem, P>(props): CheckLookupEditor<TItem, P>

Parameters

props

EditorProps<P>

Returns

CheckLookupEditor<TItem, P>

Overrides

CheckTreeEditor.constructor

Defined in

src/ui/editors/checktreeeditor.ts:482

Properties

allColumns

protected allColumns: Column<any>[]

Inherited from

CheckTreeEditor.allColumns

Defined in

src/ui/datagrid/datagrid.tsx:75

---

cascadeLink

protected cascadeLink: CascadedWidgetLink<Widget<any>>

Defined in

src/ui/editors/checktreeeditor.ts:603

---

domNode

readonly domNode: HTMLElement

Inherited from

CheckTreeEditor.domNode

Defined in

src/ui/widgets/widget.ts:17

---

filterBar

protected filterBar: FilterDisplayBar<object>

Inherited from

CheckTreeEditor.filterBar

Defined in

src/ui/datagrid/datagrid.tsx:71

---

idPrefix

readonly idPrefix: string

Inherited from

CheckTreeEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

initialSettings

protected initialSettings: PersistedGridSettings

Inherited from

CheckTreeEditor.initialSettings

Defined in

src/ui/datagrid/datagrid.tsx:77

---

openDialogsAsPanel

openDialogsAsPanel: boolean

Inherited from

CheckTreeEditor.openDialogsAsPanel

Defined in

src/ui/datagrid/datagrid.tsx:81

---

options

protected readonly options: WidgetProps<P>

Inherited from

CheckTreeEditor.options

Defined in

src/ui/widgets/widget.ts:14

---

propertyItemsData

protected propertyItemsData: PropertyItemsData

Inherited from

CheckTreeEditor.propertyItemsData

Defined in

src/ui/datagrid/datagrid.tsx:76

---

quickFiltersBar

protected quickFiltersBar: QuickFilterBar<QuickFilterBarOptions>

Inherited from

CheckTreeEditor.quickFiltersBar

Defined in

src/ui/datagrid/datagrid.tsx:73

---

quickFiltersDiv

protected quickFiltersDiv: Fluent<HTMLElement>

Inherited from

CheckTreeEditor.quickFiltersDiv

Defined in

src/ui/datagrid/datagrid.tsx:72

---

restoringSettings

protected restoringSettings: number

Inherited from

CheckTreeEditor.restoringSettings

Defined in

src/ui/datagrid/datagrid.tsx:78

---

slickContainer

protected slickContainer: Fluent<HTMLElement>

Inherited from

CheckTreeEditor.slickContainer

Defined in

src/ui/datagrid/datagrid.tsx:74

---

slickGrid

slickGrid: Grid<any>

Inherited from

CheckTreeEditor.slickGrid

Defined in

src/ui/datagrid/datagrid.tsx:80

---

titleDiv

protected titleDiv: Fluent<HTMLElement>

Inherited from

CheckTreeEditor.titleDiv

Defined in

src/ui/datagrid/datagrid.tsx:69

---

toolbar

protected toolbar: Toolbar<ToolbarOptions>

Inherited from

CheckTreeEditor.toolbar

Defined in

src/ui/datagrid/datagrid.tsx:70

---

uniqueName

readonly uniqueName: string

Inherited from

CheckTreeEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

view

view: RemoteView<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.view

Defined in

src/ui/datagrid/datagrid.tsx:79

---

defaultColumnWidthDelta

static defaultColumnWidthDelta: number

Inherited from

CheckTreeEditor.defaultColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.tsx:87

---

defaultColumnWidthScale

static defaultColumnWidthScale: number

Inherited from

CheckTreeEditor.defaultColumnWidthScale

Defined in

src/ui/datagrid/datagrid.tsx:86

---

defaultHeaderHeight

static defaultHeaderHeight: number

Inherited from

CheckTreeEditor.defaultHeaderHeight

Defined in

src/ui/datagrid/datagrid.tsx:84

---

defaultPersistanceStorage

static defaultPersistanceStorage: SettingStorage

Inherited from

CheckTreeEditor.defaultPersistanceStorage

Defined in

src/ui/datagrid/datagrid.tsx:85

---

defaultRowHeight

static defaultRowHeight: number

Inherited from

CheckTreeEditor.defaultRowHeight

Defined in

src/ui/datagrid/datagrid.tsx:83

---

isComponent

readonly static isComponent: true = true

Inherited from

CheckTreeEditor.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

CheckTreeEditor.typeInfo

Defined in

src/ui/widgets/widget.ts:11

Accessors

cascadeField

Get Signature

get cascadeField(): string

Returns

string

Set Signature

set cascadeField(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:639

---

cascadeFrom

Get Signature

get cascadeFrom(): string

Returns

string

Set Signature

set cascadeFrom(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:595

---

cascadeValue

Get Signature

get cascadeValue(): any

Returns

any

Set Signature

set cascadeValue(value): void

Parameters

value

any

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:655

---

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

CheckTreeEditor.element

Defined in

src/ui/widgets/widget.ts:63

---

filterField

Get Signature

get filterField(): string

Returns

string

Set Signature

set filterField(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:675

---

filterValue

Get Signature

get filterValue(): any

Returns

any

Set Signature

set filterValue(value): void

Parameters

value

any

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:691

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

CheckTreeEditor.props

Defined in

src/ui/widgets/widget.ts:207

---

readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Set Signature

set readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

CheckTreeEditor.readOnly

Defined in

src/ui/datagrid/datagrid.tsx:980

---

value

Get Signature

get value(): string[]

Returns

string[]

Set Signature

set value(v): void

Parameters

v

string[]

Returns

void

Inherited from

CheckTreeEditor.value

Defined in

src/ui/editors/checktreeeditor.ts:418

Methods

addBooleanFilter()

protected addBooleanFilter(field, title?, yes?, no?): SelectEditor<SelectEditorOptions>

Parameters

field

string

title?

string

yes?

string

no?

string

Returns

SelectEditor<SelectEditorOptions>

Inherited from

CheckTreeEditor.addBooleanFilter

Defined in

src/ui/datagrid/datagrid.tsx:1115

---

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

CheckTreeEditor.addCssClass

Defined in

src/ui/widgets/widget.ts:67

---

addDateRangeFilter()

protected addDateRangeFilter(field, title?): DateEditor<DateEditorOptions>

Parameters

field

string

title?

string

Returns

DateEditor<DateEditorOptions>

Inherited from

CheckTreeEditor.addDateRangeFilter

Defined in

src/ui/datagrid/datagrid.tsx:1099

---

addDateTimeRangeFilter()

protected addDateTimeRangeFilter(field, title?): DateTimeEditor<DateTimeEditorOptions>

Parameters

field

string

title?

string

Returns

DateTimeEditor<DateTimeEditorOptions>

Inherited from

CheckTreeEditor.addDateTimeRangeFilter

Defined in

src/ui/datagrid/datagrid.tsx:1107

---

addFilterSeparator()

protected addFilterSeparator(): void

Returns

void

Inherited from

CheckTreeEditor.addFilterSeparator

Defined in

src/ui/datagrid/datagrid.tsx:1079

---

addQuickFilter()

protected addQuickFilter<TWidget, P>(opt): TWidget

Type Parameters

• TWidget extends Widget<any>

• P

Parameters

opt

QuickFilter<TWidget, P>

Returns

TWidget

Inherited from

CheckTreeEditor.addQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1095

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

CheckTreeEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

CheckTreeEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterInit()

protected afterInit(): void

Returns

void

Inherited from

CheckTreeEditor.afterInit

Defined in

src/ui/datagrid/datagrid.tsx:155

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

CheckTreeEditor.afterRender

Defined in

src/ui/widgets/widget.ts:146

---

allDescendantsSelected()

protected allDescendantsSelected(item): boolean

Parameters

item

CheckTreeItem<TItem>

Returns

boolean

Inherited from

CheckTreeEditor.allDescendantsSelected

Defined in

src/ui/editors/checktreeeditor.ts:286

---

allItemsSelected()

protected allItemsSelected(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.allItemsSelected

Defined in

src/ui/editors/checktreeeditor.ts:275

---

anyDescendantsSelected()

protected anyDescendantsSelected(item): boolean

Parameters

item

CheckTreeItem<TItem>

Returns

boolean

Inherited from

CheckTreeEditor.anyDescendantsSelected

Defined in

src/ui/editors/checktreeeditor.ts:306

---

bindToSlickEvents()

protected bindToSlickEvents(): void

Returns

void

Inherited from

CheckTreeEditor.bindToSlickEvents

Defined in

src/ui/datagrid/datagrid.tsx:525

---

bindToViewEvents()

protected bindToViewEvents(): void

Returns

void

Inherited from

CheckTreeEditor.bindToViewEvents

Defined in

src/ui/datagrid/datagrid.tsx:625

---

booleanQuickFilter()

protected booleanQuickFilter(field, title?, yes?, no?): QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Parameters

field

string

title?

string

yes?

string

no?

string

Returns

QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Inherited from

CheckTreeEditor.booleanQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1119

---

byId()

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

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

CheckTreeEditor.byId

Defined in

src/ui/widgets/widget.ts:106

---

canFilterColumn()

protected canFilterColumn(column): boolean

Parameters

column

Column<any>

Returns

boolean

Inherited from

CheckTreeEditor.canFilterColumn

Defined in

src/ui/datagrid/datagrid.tsx:438

---

canShowColumn()

protected canShowColumn(column): boolean

Parameters

column

Column<any>

Returns

boolean

Inherited from

CheckTreeEditor.canShowColumn

Defined in

src/ui/datagrid/datagrid.tsx:1154

---

cascadeItems()

protected cascadeItems(items): TItem[]

Parameters

items

TItem[]

Returns

TItem[]

Defined in

src/ui/editors/checktreeeditor.ts:529

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

CheckTreeEditor.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

CheckTreeEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

createFilterBar()

protected createFilterBar(): void

Returns

void

Inherited from

CheckTreeEditor.createFilterBar

Defined in

src/ui/datagrid/datagrid.tsx:753

---

createIncludeDeletedButton()

protected createIncludeDeletedButton(): void

Returns

void

Inherited from

CheckTreeEditor.createIncludeDeletedButton

Defined in

src/ui/datagrid/datagrid.tsx:305

---

createPager()

protected createPager(): void

Returns

void

Inherited from

CheckTreeEditor.createPager

Defined in

src/ui/datagrid/datagrid.tsx:768

---

createQuickFilters()

protected createQuickFilters(filters?): void

Parameters

filters?

QuickFilter<Widget<any>, any>[]

Returns

void

Inherited from

CheckTreeEditor.createQuickFilters

Defined in

src/ui/datagrid/datagrid.tsx:203

---

createQuickSearchInput()

protected createQuickSearchInput(): void

Returns

void

Inherited from

CheckTreeEditor.createQuickSearchInput

Defined in

src/ui/datagrid/datagrid.tsx:314

---

createSlickContainer()

protected createSlickContainer(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

CheckTreeEditor.createSlickContainer

Defined in

src/ui/datagrid/datagrid.tsx:707

---

createSlickGrid()

protected createSlickGrid(): Grid<any>

Returns

Grid<any>

Inherited from

CheckTreeEditor.createSlickGrid

Defined in

src/ui/editors/checktreeeditor.ts:120

---

createToolbar()

protected createToolbar(buttons): void

Parameters

buttons

ToolButton[]

Returns

void

Inherited from

CheckTreeEditor.createToolbar

Defined in

src/ui/datagrid/datagrid.tsx:794

---

createToolbarExtensions()

protected createToolbarExtensions(): void

Returns

void

Overrides

CheckTreeEditor.createToolbarExtensions

Defined in

src/ui/editors/checktreeeditor.ts:513

---

createView()

protected createView(): RemoteView<CheckTreeItem<TItem>>

Returns

RemoteView<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.createView

Defined in

src/ui/datagrid/datagrid.tsx:711

---

dateRangeQuickFilter()

protected dateRangeQuickFilter(field, title?): QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Parameters

field

string

title?

string

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Inherited from

CheckTreeEditor.dateRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1103

---

dateTimeRangeQuickFilter()

protected dateTimeRangeQuickFilter(field, title?): QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Parameters

field

string

title?

string

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Inherited from

CheckTreeEditor.dateTimeRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1111

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Overrides

CheckTreeEditor.destroy

Defined in

src/ui/editors/checktreeeditor.ts:491

---

determineText()

protected determineText(getKey): string

Parameters

getKey

(prefix) => string

Returns

string

Inherited from

CheckTreeEditor.determineText

Defined in

src/ui/datagrid/datagrid.tsx:1083

---

editItem()

protected editItem(entityOrId): void

Parameters

entityOrId

any

Returns

void

Inherited from

CheckTreeEditor.editItem

Defined in

src/ui/datagrid/datagrid.tsx:591

---

editItemOfType()

protected editItemOfType(itemType, entityOrId): void

Parameters

itemType

string

entityOrId

any

Returns

void

Inherited from

CheckTreeEditor.editItemOfType

Defined in

src/ui/datagrid/datagrid.tsx:595

---

enableFiltering()

protected enableFiltering(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.enableFiltering

Defined in

src/ui/datagrid/datagrid.tsx:745

---

ensureQuickFilterBar()

protected ensureQuickFilterBar(): QuickFilterBar<QuickFilterBarOptions>

Returns

QuickFilterBar<QuickFilterBarOptions>

Inherited from

CheckTreeEditor.ensureQuickFilterBar

Defined in

src/ui/datagrid/datagrid.tsx:195

---

filterItems()

protected filterItems(items): TItem[]

Parameters

items

TItem[]

Returns

TItem[]

Defined in

src/ui/editors/checktreeeditor.ts:551

---

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

CheckTreeEditor.findById

Defined in

src/ui/widgets/widget.ts:110

---

findQuickFilter()

protected findQuickFilter<TWidget>(type, field): TWidget

Type Parameters

• TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

CheckTreeEditor.findQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:289

---

get_cascadeField()

protected get_cascadeField(): string

Returns

string

Defined in

src/ui/editors/checktreeeditor.ts:635

---

get_cascadeFrom()

protected get_cascadeFrom(): string

Returns

string

Defined in

src/ui/editors/checktreeeditor.ts:591

---

get_cascadeValue()

protected get_cascadeValue(): any

Returns

any

Defined in

src/ui/editors/checktreeeditor.ts:651

---

get_filterField()

protected get_filterField(): string

Returns

string

Defined in

src/ui/editors/checktreeeditor.ts:671

---

get_filterValue()

protected get_filterValue(): any

Returns

any

Defined in

src/ui/editors/checktreeeditor.ts:687

---

get_readOnly()

get_readOnly(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.get_readOnly

Defined in

src/ui/editors/checktreeeditor.ts:396

---

getAddButtonCaption()

protected getAddButtonCaption(): string

Returns

string

Inherited from

CheckTreeEditor.getAddButtonCaption

Defined in

src/ui/datagrid/datagrid.tsx:583

---

getButtons()

protected getButtons(): ToolButton[]

Returns

ToolButton[]

Overrides

CheckTreeEditor.getButtons

Defined in

src/ui/editors/checktreeeditor.ts:509

---

getCascadeFromValue()

protected getCascadeFromValue(parent): any

Parameters

parent

Widget<any>

Returns

any

Defined in

src/ui/editors/checktreeeditor.ts:599

---

getColumns()

protected getColumns(): Column<any>[]

Returns

Column<any>[]

Inherited from

CheckTreeEditor.getColumns

Defined in

src/ui/editors/checktreeeditor.ts:321

---

getColumnsKey()

protected getColumnsKey(): string

Returns

string

Inherited from

CheckTreeEditor.getColumnsKey

Defined in

src/ui/datagrid/datagrid.tsx:848

---

getColumnWidthDelta()

protected getColumnWidthDelta(): number

Returns

number

Inherited from

CheckTreeEditor.getColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.tsx:415

---

getColumnWidthScale()

protected getColumnWidthScale(): number

Returns

number

Inherited from

CheckTreeEditor.getColumnWidthScale

Defined in

src/ui/datagrid/datagrid.tsx:419

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

CheckTreeEditor.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCurrentSettings()

protected getCurrentSettings(flags?): PersistedGridSettings

Parameters

flags?

GridPersistanceFlags

Returns

PersistedGridSettings

Inherited from

CheckTreeEditor.getCurrentSettings

Defined in

src/ui/datagrid/datagrid.tsx:1367

---

getCustomAttribute()

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

Type Parameters

• TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

CheckTreeEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getDefaultSortBy()

protected getDefaultSortBy(): any[]

Returns

any[]

Inherited from

CheckTreeEditor.getDefaultSortBy

Defined in

src/ui/datagrid/datagrid.tsx:716

---

getDelimited()

protected getDelimited(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.getDelimited

Defined in

src/ui/editors/checktreeeditor.ts:302

---

getDescendantsSelected()

protected getDescendantsSelected(item): boolean

Parameters

item

CheckTreeItem<TItem>

Returns

boolean

Inherited from

CheckTreeEditor.getDescendantsSelected

Defined in

src/ui/editors/checktreeeditor.ts:254

---

getEditValue()

getEditValue(property, target): void

Parameters

property

PropertyItem

target

any

Returns

void

Inherited from

CheckTreeEditor.getEditValue

Defined in

src/ui/editors/checktreeeditor.ts:71

---

getElement()

getElement(): HTMLElement

Returns

HTMLElement

Inherited from

CheckTreeEditor.getElement

Defined in

src/ui/datagrid/datagrid.tsx:1457

---

getFilterStore()

getFilterStore(): FilterStore

Returns

FilterStore

Inherited from

CheckTreeEditor.getFilterStore

Defined in

src/ui/datagrid/datagrid.tsx:1469

---

getGrid()

getGrid(): Grid<any>

Returns

Grid<any>

Inherited from

CheckTreeEditor.getGrid

Defined in

src/ui/datagrid/datagrid.tsx:1461

---

getGridCanLoad()

protected getGridCanLoad(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.getGridCanLoad

Defined in

src/ui/datagrid/datagrid.tsx:939

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

CheckTreeEditor.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

getIdProperty()

protected getIdProperty(): string

Returns

string

Inherited from

CheckTreeEditor.getIdProperty

Defined in

src/ui/editors/checktreeeditor.ts:42

---

getIncludeColumns()

protected getIncludeColumns(include): void

Parameters

include

Returns

void

Inherited from

CheckTreeEditor.getIncludeColumns

Defined in

src/ui/datagrid/datagrid.tsx:653

---

getInitialCollapse()

protected getInitialCollapse(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.getInitialCollapse

Defined in

src/ui/editors/checktreeeditor.ts:153

---

getInitialTitle()

protected getInitialTitle(): string

Returns

string

Inherited from

CheckTreeEditor.getInitialTitle

Defined in

src/ui/datagrid/datagrid.tsx:188

---

getIsActiveProperty()

protected getIsActiveProperty(): string

Returns

string

Inherited from

CheckTreeEditor.getIsActiveProperty

Defined in

src/ui/datagrid/datagrid.tsx:1052

---

getIsDeletedProperty()

protected getIsDeletedProperty(): string

Returns

string

Inherited from

CheckTreeEditor.getIsDeletedProperty

Defined in

src/ui/datagrid/datagrid.tsx:1046

---

getItemCssClass()

protected getItemCssClass(item, index): string

Parameters

item

CheckTreeItem<TItem>

index

number

Returns

string

Inherited from

CheckTreeEditor.getItemCssClass

Defined in

src/ui/datagrid/datagrid.tsx:353

---

getItemMetadata()

protected getItemMetadata(item, index): any

Parameters

item

CheckTreeItem<TItem>

index

number

Returns

any

Inherited from

CheckTreeEditor.getItemMetadata

Defined in

src/ui/datagrid/datagrid.tsx:386

---

getItems()

getItems(): CheckTreeItem<TItem>[]

Returns

CheckTreeItem<TItem>[]

Inherited from

CheckTreeEditor.getItems

Defined in

src/ui/datagrid/datagrid.tsx:517

---

getItemText()

protected getItemText(ctx): string

Parameters

ctx

FormatterContext<any>

Returns

string

Inherited from

CheckTreeEditor.getItemText

Defined in

src/ui/editors/checktreeeditor.ts:352

---

getItemType()

protected getItemType(): string

Returns

string

Inherited from

CheckTreeEditor.getItemType

Defined in

src/ui/datagrid/datagrid.tsx:830

---

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

Returns

string

Inherited from

CheckTreeEditor.getLocalTextDbPrefix

Defined in

src/ui/datagrid/datagrid.tsx:1009

---

getLocalTextPrefix()

protected getLocalTextPrefix(): string

Returns

string

Inherited from

CheckTreeEditor.getLocalTextPrefix

Defined in

src/ui/datagrid/datagrid.tsx:1021

---

getLookupItems()

protected getLookupItems(lookup): TItem[]

Parameters

lookup

Lookup<TItem>

Returns

TItem[]

Defined in

src/ui/editors/checktreeeditor.ts:567

---

getLookupKey()

protected getLookupKey(): string

Returns

string

Defined in

src/ui/editors/checktreeeditor.ts:505

---

getPagerOptions()

protected getPagerOptions(): PagerOptions

Returns

PagerOptions

Inherited from

CheckTreeEditor.getPagerOptions

Defined in

src/ui/datagrid/datagrid.tsx:760

---

getPersistanceKey()

protected getPersistanceKey(): string

Returns

string

Inherited from

CheckTreeEditor.getPersistanceKey

Defined in

src/ui/datagrid/datagrid.tsx:1139

---

getPersistanceStorage()

protected getPersistanceStorage(): SettingStorage

Returns

SettingStorage

Inherited from

CheckTreeEditor.getPersistanceStorage

Defined in

src/ui/datagrid/datagrid.tsx:1135

---

getPersistedSettings()

protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

CheckTreeEditor.getPersistedSettings

Defined in

src/ui/datagrid/datagrid.tsx:1175

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Inherited from

CheckTreeEditor.getPropertyItems

Defined in

src/ui/datagrid/datagrid.tsx:852

---

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Inherited from

CheckTreeEditor.getPropertyItemsData

Defined in

src/ui/datagrid/datagrid.tsx:856

---

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Inherited from

CheckTreeEditor.getPropertyItemsDataAsync

Defined in

src/ui/datagrid/datagrid.tsx:876

---

getQuickFilters()

protected getQuickFilters(): QuickFilter<Widget<any>, any>[]

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

CheckTreeEditor.getQuickFilters

Defined in

src/ui/datagrid/datagrid.tsx:225

---

getQuickSearchFields()

protected getQuickSearchFields(): QuickSearchField[]

Returns

QuickSearchField[]

Inherited from

CheckTreeEditor.getQuickSearchFields

Defined in

src/ui/datagrid/datagrid.tsx:310

---

getRowDefinition()

protected getRowDefinition(): IRowDefinition

Returns

IRowDefinition

Inherited from

CheckTreeEditor.getRowDefinition

Defined in

src/ui/datagrid/datagrid.tsx:1003

---

getSelectAllText()

protected getSelectAllText(): string

Returns

string

Overrides

CheckTreeEditor.getSelectAllText

Defined in

src/ui/editors/checktreeeditor.ts:522

---

getSlickOptions()

protected getSlickOptions(): GridOptions<any>

Returns

GridOptions<any>

Inherited from

CheckTreeEditor.getSlickOptions

Defined in

src/ui/editors/checktreeeditor.ts:356

---

getTitle()

getTitle(): string

Returns

string

Inherited from

CheckTreeEditor.getTitle

Defined in

src/ui/datagrid/datagrid.tsx:802

---

getTreeItems()

protected getTreeItems(): CheckTreeItem<TItem>[]

Returns

CheckTreeItem<TItem>[]

Overrides

CheckTreeEditor.getTreeItems

Defined in

src/ui/editors/checktreeeditor.ts:571

---

getView()

getView(): RemoteView<CheckTreeItem<TItem>>

Returns

RemoteView<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.getView

Defined in

src/ui/datagrid/datagrid.tsx:1465

---

getViewOptions()

protected getViewOptions(): RemoteViewOptions

Returns

RemoteViewOptions

Inherited from

CheckTreeEditor.getViewOptions

Defined in

src/ui/datagrid/datagrid.tsx:772

---

gridPersistanceFlags()

protected gridPersistanceFlags(): GridPersistanceFlags

Returns

GridPersistanceFlags

Inherited from

CheckTreeEditor.gridPersistanceFlags

Defined in

src/ui/datagrid/datagrid.tsx:1150

---

init()

init(): this

Returns

this

Inherited from

CheckTreeEditor.init

Defined in

src/ui/widgets/widget.ts:157

---

initializeFilterBar()

protected initializeFilterBar(): void

Returns

void

Inherited from

CheckTreeEditor.initializeFilterBar

Defined in

src/ui/datagrid/datagrid.tsx:445

---

initialPopulate()

protected initialPopulate(): void

Returns

void

Inherited from

CheckTreeEditor.initialPopulate

Defined in

src/ui/datagrid/datagrid.tsx:423

---

internalRefresh()

protected internalRefresh(): void

Returns

void

Inherited from

CheckTreeEditor.internalRefresh

Defined in

src/ui/datagrid/datagrid.tsx:963

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

CheckTreeEditor.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

invokeSubmitHandlers()

protected invokeSubmitHandlers(): void

Returns

void

Inherited from

CheckTreeEditor.invokeSubmitHandlers

Defined in

src/ui/datagrid/datagrid.tsx:1123

---

isThreeStateHierarchy()

protected isThreeStateHierarchy(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.isThreeStateHierarchy

Defined in

src/ui/editors/checktreeeditor.ts:116

---

itemAt()

itemAt(row): CheckTreeItem<TItem>

Parameters

row

number

Returns

CheckTreeItem<TItem>

Inherited from

CheckTreeEditor.itemAt

Defined in

src/ui/datagrid/datagrid.tsx:505

---

itemId()

itemId(item): any

Parameters

item

CheckTreeItem<TItem>

Returns

any

Inherited from

CheckTreeEditor.itemId

Defined in

src/ui/datagrid/datagrid.tsx:509

---

itemLink()

protected itemLink(itemType?, idField?, text?, cssClass?, encode?): Format<CheckTreeItem<TItem>>

Parameters

itemType?

string

idField?

string

text?

Format<CheckTreeItem<TItem>>

cssClass?

(ctx) => string

encode?

boolean = true

Returns

Format<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.itemLink

Defined in

src/ui/datagrid/datagrid.tsx:834

---

itemSelectedChanged()

protected itemSelectedChanged(item): void

Parameters

item

CheckTreeItem<TItem>

Returns

void

Inherited from

CheckTreeEditor.itemSelectedChanged

Defined in

src/ui/editors/checktreeeditor.ts:109

---

layout()

protected layout(): void

Returns

void

Inherited from

CheckTreeEditor.layout

Defined in

src/ui/datagrid/datagrid.tsx:166

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

---

markupReady()

protected markupReady(): void

Returns

void

Inherited from

CheckTreeEditor.markupReady

Defined in

src/ui/datagrid/datagrid.tsx:704

---

moveSelectedUp()

protected moveSelectedUp(): boolean

Returns

boolean

Overrides

CheckTreeEditor.moveSelectedUp

Defined in

src/ui/editors/checktreeeditor.ts:587

---

onClick()

protected onClick(e, row, cell): void

Parameters

e

Event

row

number

cell

number

Returns

void

Inherited from

CheckTreeEditor.onClick

Defined in

src/ui/editors/checktreeeditor.ts:168

---

onViewFilter()

protected onViewFilter(item): boolean

Parameters

item

CheckTreeItem<TItem>

Returns

boolean

Overrides

CheckTreeEditor.onViewFilter

Defined in

src/ui/editors/checktreeeditor.ts:581

---

onViewProcessData()

protected onViewProcessData(response): ListResponse<CheckTreeItem<TItem>>

Parameters

response

ListResponse<CheckTreeItem<TItem>>

Returns

ListResponse<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.onViewProcessData

Defined in

src/ui/editors/checktreeeditor.ts:157

---

onViewSubmit()

protected onViewSubmit(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.onViewSubmit

Defined in

src/ui/datagrid/datagrid.tsx:692

---

persistSettings()

protected persistSettings(flags?): void | Promise<void>

Parameters

flags?

GridPersistanceFlags

Returns

void | Promise<void>

Inherited from

CheckTreeEditor.persistSettings

Defined in

src/ui/datagrid/datagrid.tsx:1357

---

populateLock()

protected populateLock(): void

Returns

void

Inherited from

CheckTreeEditor.populateLock

Defined in

src/ui/datagrid/datagrid.tsx:931

---

populateUnlock()

protected populateUnlock(): void

Returns

void

Inherited from

CheckTreeEditor.populateUnlock

Defined in

src/ui/datagrid/datagrid.tsx:935

---

populateWhenVisible()

protected populateWhenVisible(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.populateWhenVisible

Defined in

src/ui/datagrid/datagrid.tsx:749

---

postProcessColumns()

protected postProcessColumns(columns): Column<any>[]

Parameters

columns

Column<any>[]

Returns

Column<any>[]

Inherited from

CheckTreeEditor.postProcessColumns

Defined in

src/ui/datagrid/datagrid.tsx:394

---

propertyItemsReady()

protected propertyItemsReady(itemsData): void

Parameters

itemsData

PropertyItemsData

Returns

void

Inherited from

CheckTreeEditor.propertyItemsReady

Defined in

src/ui/datagrid/datagrid.tsx:122

---

propertyItemsToSlickColumns()

protected propertyItemsToSlickColumns(propertyItems): Column<any>[]

Parameters

propertyItems

PropertyItem[]

Returns

Column<any>[]

Inherited from

CheckTreeEditor.propertyItemsToSlickColumns

Defined in

src/ui/datagrid/datagrid.tsx:904

---

quickFilterChange()

protected quickFilterChange(e): void

Parameters

e

Event

Returns

void

Inherited from

CheckTreeEditor.quickFilterChange

Defined in

src/ui/datagrid/datagrid.tsx:1129

---

refresh()

refresh(): void

Returns

void

Inherited from

CheckTreeEditor.refresh

Defined in

src/ui/datagrid/datagrid.tsx:943

---

refreshIfNeeded()

protected refreshIfNeeded(): void

Returns

void

Inherited from

CheckTreeEditor.refreshIfNeeded

Defined in

src/ui/datagrid/datagrid.tsx:956

---

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

CheckTreeEditor.render

Defined in

src/ui/widgets/widget.ts:167

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

CheckTreeEditor.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

resizeCanvas()

protected resizeCanvas(): void

Returns

void

Inherited from

CheckTreeEditor.resizeCanvas

Defined in

src/ui/datagrid/datagrid.tsx:1071

---

restoreSettings()

protected restoreSettings(settings?, flags?): void | Promise<void>

Parameters

settings?

PersistedGridSettings

flags?

GridPersistanceFlags

Returns

void | Promise<void>

Inherited from

CheckTreeEditor.restoreSettings

Defined in

src/ui/datagrid/datagrid.tsx:1194

---

restoreSettingsFrom()

protected restoreSettingsFrom(settings, flags?): void

Parameters

settings

PersistedGridSettings

flags?

GridPersistanceFlags

Returns

void

Inherited from

CheckTreeEditor.restoreSettingsFrom

Defined in

src/ui/datagrid/datagrid.tsx:1205

---

rowCount()

rowCount(): number

Returns

number

Inherited from

CheckTreeEditor.rowCount

Defined in

src/ui/datagrid/datagrid.tsx:513

---

set_cascadeField()

protected set_cascadeField(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:643

---

set_cascadeFrom()

protected set_cascadeFrom(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:624

---

set_cascadeValue()

protected set_cascadeValue(value): void

Parameters

value

any

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:659

---

set_filterField()

protected set_filterField(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:679

---

set_filterValue()

protected set_filterValue(value): void

Parameters

value

any

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:695

---

set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

CheckTreeEditor.set_readOnly

Defined in

src/ui/editors/checktreeeditor.ts:400

---

setAllSubTreeSelected()

protected setAllSubTreeSelected(item, selected): boolean

Parameters

item

CheckTreeItem<TItem>

selected

boolean

Returns

boolean

Inherited from

CheckTreeEditor.setAllSubTreeSelected

Defined in

src/ui/editors/checktreeeditor.ts:258

---

setCascadeFrom()

protected setCascadeFrom(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/checktreeeditor.ts:605

---

setCriteriaParameter()

protected setCriteriaParameter(): void

Returns

void

Inherited from

CheckTreeEditor.setCriteriaParameter

Defined in

src/ui/datagrid/datagrid.tsx:668

---

setEditValue()

setEditValue(source, property): void

Parameters

source

any

property

PropertyItem

Returns

void

Inherited from

CheckTreeEditor.setEditValue

Defined in

src/ui/editors/checktreeeditor.ts:78

---

setEquality()

protected setEquality(field, value): void

Parameters

field

string

value

any

Returns

void

Inherited from

CheckTreeEditor.setEquality

Defined in

src/ui/datagrid/datagrid.tsx:678

---

setIncludeColumnsParameter()

protected setIncludeColumnsParameter(): void

Returns

void

Inherited from

CheckTreeEditor.setIncludeColumnsParameter

Defined in

src/ui/datagrid/datagrid.tsx:682

---

setInitialSortOrder()

protected setInitialSortOrder(): void

Returns

void

Inherited from

CheckTreeEditor.setInitialSortOrder

Defined in

src/ui/datagrid/datagrid.tsx:480

---

setIsDisabled()

setIsDisabled(value): void

Parameters

value

boolean

Returns

void

Inherited from

CheckTreeEditor.setIsDisabled

Defined in

src/ui/datagrid/datagrid.tsx:967

---

setItems()

setItems(value): void

Parameters

value

CheckTreeItem<TItem>[]

Returns

void

Inherited from

CheckTreeEditor.setItems

Defined in

src/ui/datagrid/datagrid.tsx:521

---

setTitle()

setTitle(value): void

Parameters

value

string

Returns

void

Inherited from

CheckTreeEditor.setTitle

Defined in

src/ui/datagrid/datagrid.tsx:810

---

sortItems()

protected sortItems(): void

Returns

void

Inherited from

CheckTreeEditor.sortItems

Defined in

src/ui/editors/checktreeeditor.ts:362

---

subDialogDataChange()

protected subDialogDataChange(): void

Returns

void

Inherited from

CheckTreeEditor.subDialogDataChange

Defined in

src/ui/datagrid/datagrid.tsx:1075

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

CheckTreeEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

tryFindQuickFilter()

protected tryFindQuickFilter<TWidget>(type, field): TWidget

Type Parameters

• TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

CheckTreeEditor.tryFindQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:297

---

updateDisabledState()

protected updateDisabledState(): void

Returns

void

Inherited from

CheckTreeEditor.updateDisabledState

Defined in

src/ui/datagrid/datagrid.tsx:1067

---

updateFlags()

protected updateFlags(): void

Returns

void

Inherited from

CheckTreeEditor.updateFlags

Defined in

src/ui/editors/checktreeeditor.ts:217

---

updateInterface()

updateInterface(): void

Returns

void

Inherited from

CheckTreeEditor.updateInterface

Defined in

src/ui/datagrid/datagrid.tsx:999

---

updateItems()

protected updateItems(): void

Returns

void

Overrides

CheckTreeEditor.updateItems

Defined in

src/ui/editors/checktreeeditor.ts:500

---

updateSelectAll()

protected updateSelectAll(): void

Returns

void

Inherited from

CheckTreeEditor.updateSelectAll

Defined in

src/ui/editors/checktreeeditor.ts:211

---

useAsync()

protected useAsync(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.useAsync

Defined in

src/ui/datagrid/datagrid.tsx:158

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

CheckTreeEditor.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218

---

useLayoutTimer()

protected useLayoutTimer(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.useLayoutTimer

Defined in

src/ui/datagrid/datagrid.tsx:162

---

usePager()

protected usePager(): boolean

Returns

boolean

Inherited from

CheckTreeEditor.usePager

Defined in

src/ui/datagrid/datagrid.tsx:741

---

viewDataChanged()

protected viewDataChanged(e, rows): void

Parameters

e

any

rows

CheckTreeItem<TItem>[]

Returns

void

Inherited from

CheckTreeEditor.viewDataChanged

Defined in

src/ui/datagrid/datagrid.tsx:620

---

wrapFormatterWithEditLink()

protected wrapFormatterWithEditLink(column, item): void

Parameters

column

Column<any>

item

PropertyItem

Returns

void

Inherited from

CheckTreeEditor.wrapFormatterWithEditLink

Defined in

src/ui/datagrid/datagrid.tsx:889

---

create()

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

Type Parameters

• TWidget extends Widget<P>

• P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

CheckTreeEditor.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLDivElement

Returns

HTMLDivElement

Inherited from

CheckTreeEditor.createDefaultElement

Defined in

src/ui/editors/checktreeeditor.ts:31

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

CheckTreeEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95

---

propertyItemToQuickFilter()

static propertyItemToQuickFilter(item): any

Parameters

item

PropertyItem

Returns

any

Inherited from

CheckTreeEditor.propertyItemToQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:235