@serenity-is/corelib / CheckLookupEditor

Class: CheckLookupEditor<TItem, P>

Defined in: src/ui/editors/checktreeeditor.ts:478

Extends

• CheckTreeEditor<CheckTreeItem<TItem>, P>

Type Parameters

TItem

TItem extends CheckTreeItem<TItem> = any

P

P extends CheckLookupEditorOptions = CheckLookupEditorOptions

Constructors

Constructor

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

Defined in: src/ui/editors/checktreeeditor.ts:485

Parameters

props

EditorProps<P>

Returns

CheckLookupEditor<TItem, P>

Overrides

CheckTreeEditor.constructor

Properties

cascadeLink

protected cascadeLink: CascadedWidgetLink<Widget<any>>

Defined in: src/ui/editors/checktreeeditor.ts:606

---

domNode

readonly domNode: HTMLElement

Defined in: src/ui/widgets/widget.ts:14

Inherited from

CheckTreeEditor.domNode

---

filterBar

protected filterBar: FilterDisplayBar

Defined in: src/ui/datagrid/datagrid.tsx:47

Inherited from

CheckTreeEditor.filterBar

---

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

CheckTreeEditor.idPrefix

---

onAfterInit

readonly onAfterInit: PubSub<DataGridEvent>

Defined in: src/ui/datagrid/datagrid.tsx:68

Inherited from

CheckTreeEditor.onAfterInit

---

onCanSubmit

readonly onCanSubmit: PubSub<DataGridSubmitEvent>

Defined in: src/ui/datagrid/datagrid.tsx:69

Inherited from

CheckTreeEditor.onCanSubmit

---

onDataChanged

readonly onDataChanged: PubSub<DataGridEvent>

Defined in: src/ui/datagrid/datagrid.tsx:70

Inherited from

CheckTreeEditor.onDataChanged

---

onFiltering

readonly onFiltering: PubSub<DataGridFilteringEvent<CheckTreeItem<TItem>>>

Defined in: src/ui/datagrid/datagrid.tsx:71

Inherited from

CheckTreeEditor.onFiltering

---

onPersistence

readonly onPersistence: PubSub<DataGridPersistenceEvent>

Defined in: src/ui/datagrid/datagrid.tsx:72

Inherited from

CheckTreeEditor.onPersistence

---

onProcessData

readonly onProcessData: PubSub<DataGridProcessEvent<CheckTreeItem<TItem>>>

Defined in: src/ui/datagrid/datagrid.tsx:73

Inherited from

CheckTreeEditor.onProcessData

---

onSubmitting

readonly onSubmitting: PubSub<DataGridSubmitEvent>

Defined in: src/ui/datagrid/datagrid.tsx:74

Inherited from

CheckTreeEditor.onSubmitting

---

openDialogsAsPanel

openDialogsAsPanel: boolean

Defined in: src/ui/datagrid/datagrid.tsx:55

Inherited from

CheckTreeEditor.openDialogsAsPanel

---

options

protected readonly options: WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

CheckTreeEditor.options

---

propertyItemsData

protected propertyItemsData: PropertyItemsData

Defined in: src/ui/datagrid/datagrid.tsx:51

Inherited from

CheckTreeEditor.propertyItemsData

---

quickFiltersBar

protected quickFiltersBar: QuickFilterBar

Defined in: src/ui/datagrid/datagrid.tsx:49

Inherited from

CheckTreeEditor.quickFiltersBar

---

quickFiltersDiv

protected quickFiltersDiv: Fluent

Defined in: src/ui/datagrid/datagrid.tsx:48

Inherited from

CheckTreeEditor.quickFiltersDiv

---

restoringSettings

protected restoringSettings: number

Defined in: src/ui/datagrid/datagrid.tsx:52

Inherited from

CheckTreeEditor.restoringSettings

---

slickContainer

protected slickContainer: Fluent

Defined in: src/ui/datagrid/datagrid.tsx:50

Inherited from

CheckTreeEditor.slickContainer

---

titleDiv

protected titleDiv: Fluent

Defined in: src/ui/datagrid/datagrid.tsx:45

Inherited from

CheckTreeEditor.titleDiv

---

toolbar

protected toolbar: Toolbar

Defined in: src/ui/datagrid/datagrid.tsx:46

Inherited from

CheckTreeEditor.toolbar

---

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

CheckTreeEditor.uniqueName

---

view

view: IRemoteView<CheckTreeItem<TItem>>

Defined in: src/ui/datagrid/datagrid.tsx:53

Inherited from

CheckTreeEditor.view

---

[typeInfo]

static [typeInfo]: EditorTypeInfo<"Serenity.">

Defined in: src/ui/editors/checktreeeditor.ts:479

Overrides

CheckTreeEditor.[typeInfo]

---

defaultOptions

readonly static defaultOptions: object = dataGridDefaults

Defined in: src/ui/datagrid/datagrid.tsx:57

columnWidthDelta

columnWidthDelta: number

Default column width delta. This value if specified, is added to the width of columns defined server side. Default is null

columnWidthScale

columnWidthScale: number

Default column width scale. This value if specified, is multiplied with the width of columns defined server side. Default is null

enableAdvancedFiltering

enableAdvancedFiltering: boolean | (grid) => boolean

Controls whether to enable advanced filtering, e.g. via filter dialog/bar. Default is null.

openDialogsAsPanel

openDialogsAsPanel: boolean

Controls whether to open dialogs as panels. Default is null.

persistenceFlags

persistenceFlags: GridPersistenceFlags = defaultGridPersistenceFlags

Default persistence flags. Defaults are true except quickSearch and quickFilterText

persistenceStorage

persistenceStorage: SettingStorage

Default persistence storage. Default is null

rowHeight

rowHeight: number

Default row height. Default is null.

Inherited from

CheckTreeEditor.defaultOptions

---

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

CheckTreeEditor.isComponent

---

onAfterInit

readonly static onAfterInit: PubSub<DataGridEvent>

Defined in: src/ui/datagrid/datagrid.tsx:67

Inherited from

CheckTreeEditor.onAfterInit

Accessors

allColumns

Get Signature

get allColumns(): Column<any>[]

Defined in: src/ui/datagrid/datagrid.tsx:1260

Returns

Column<any>[]

Inherited from

CheckTreeEditor.allColumns

---

cascadeField

Get Signature

get cascadeField(): string

Defined in: src/ui/editors/checktreeeditor.ts:642

Returns

string

Set Signature

set cascadeField(value): void

Defined in: src/ui/editors/checktreeeditor.ts:650

Parameters

value

string

Returns

void

---

cascadeFrom

Get Signature

get cascadeFrom(): string

Defined in: src/ui/editors/checktreeeditor.ts:598

Returns

string

Set Signature

set cascadeFrom(value): void

Defined in: src/ui/editors/checktreeeditor.ts:634

Parameters

value

string

Returns

void

---

cascadeValue

Get Signature

get cascadeValue(): any

Defined in: src/ui/editors/checktreeeditor.ts:658

Returns

any

Set Signature

set cascadeValue(value): void

Defined in: src/ui/editors/checktreeeditor.ts:670

Parameters

value

any

Returns

void

---

columns

Get Signature

get columns(): Column<TItem>[]

Defined in: src/ui/datagrid/datagrid.tsx:1261

Returns

Column<TItem>[]

Inherited from

CheckTreeEditor.columns

---

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

CheckTreeEditor.element

---

filterField

Get Signature

get filterField(): string

Defined in: src/ui/editors/checktreeeditor.ts:678

Returns

string

Set Signature

set filterField(value): void

Defined in: src/ui/editors/checktreeeditor.ts:686

Parameters

value

string

Returns

void

---

filterValue

Get Signature

get filterValue(): any

Defined in: src/ui/editors/checktreeeditor.ts:694

Returns

any

Set Signature

set filterValue(value): void

Defined in: src/ui/editors/checktreeeditor.ts:706

Parameters

value

any

Returns

void

---

initialSettings

Get Signature

get initialSettings(): PersistedGridSettings

Defined in: src/ui/datagrid/datagrid.tsx:1262

Returns

PersistedGridSettings

Set Signature

set initialSettings(value): void

Defined in: src/ui/datagrid/datagrid.tsx:1263

Parameters

value

PersistedGridSettings

Returns

void

Inherited from

CheckTreeEditor.initialSettings

---

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

CheckTreeEditor.props

---

readOnly

Get Signature

get readOnly(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:921

Returns

boolean

Set Signature

set readOnly(value): void

Defined in: src/ui/datagrid/datagrid.tsx:925

Parameters

value

boolean

Returns

void

Inherited from

CheckTreeEditor.readOnly

---

sleekGrid

Get Signature

get sleekGrid(): ISleekGrid<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:1246

Returns

ISleekGrid<TItem>

Set Signature

set sleekGrid(value): void

Defined in: src/ui/datagrid/datagrid.tsx:1247

Parameters

value

ISleekGrid<TItem>

Returns

void

Inherited from

CheckTreeEditor.sleekGrid

---

slickGrid

Get Signature

get slickGrid(): ISleekGrid<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:1250

Deprecated

Use sleekGrid or getGrid()

Returns

ISleekGrid<TItem>

Inherited from

CheckTreeEditor.slickGrid

---

value

Get Signature

get value(): string[]

Defined in: src/ui/editors/checktreeeditor.ts:421

Returns

string[]

Set Signature

set value(v): void

Defined in: src/ui/editors/checktreeeditor.ts:460

Parameters

v

string[]

Returns

void

Inherited from

CheckTreeEditor.value

---

defaultColumnWidthDelta

Get Signature

get static defaultColumnWidthDelta(): number

Defined in: src/ui/datagrid/datagrid.tsx:64

Returns

number

Set Signature

set static defaultColumnWidthDelta(value): void

Defined in: src/ui/datagrid/datagrid.tsx:65

Parameters

value

number

Returns

void

Inherited from

CheckTreeEditor.defaultColumnWidthDelta

---

defaultColumnWidthScale

Get Signature

get static defaultColumnWidthScale(): number

Defined in: src/ui/datagrid/datagrid.tsx:62

Returns

number

Set Signature

set static defaultColumnWidthScale(value): void

Defined in: src/ui/datagrid/datagrid.tsx:63

Parameters

value

number

Returns

void

Inherited from

CheckTreeEditor.defaultColumnWidthScale

---

defaultPersistanceStorage

Get Signature

get static defaultPersistanceStorage(): SettingStorage

Defined in: src/ui/datagrid/datagrid.tsx:1266

Deprecated

use defaultPersistenceStorage, this one has a typo

Returns

SettingStorage

Set Signature

set static defaultPersistanceStorage(value): void

Defined in: src/ui/datagrid/datagrid.tsx:1268

Deprecated

use defaultPersistenceStorage, this one has a typo

Parameters

value

SettingStorage

Returns

void

Inherited from

CheckTreeEditor.defaultPersistanceStorage

---

defaultPersistenceStorage

Get Signature

get static defaultPersistenceStorage(): SettingStorage

Defined in: src/ui/datagrid/datagrid.tsx:60

Returns

SettingStorage

Set Signature

set static defaultPersistenceStorage(value): void

Defined in: src/ui/datagrid/datagrid.tsx:61

Parameters

value

SettingStorage

Returns

void

Inherited from

CheckTreeEditor.defaultPersistenceStorage

---

defaultRowHeight

Get Signature

get static defaultRowHeight(): number

Defined in: src/ui/datagrid/datagrid.tsx:59

Returns

number

Inherited from

CheckTreeEditor.defaultRowHeight

Methods

addBooleanFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1044

Parameters

field

string

title?

string

yes?

string

no?

string

Returns

SelectEditor

Inherited from

CheckTreeEditor.addBooleanFilter

---

addCssClass()

protected addCssClass(): void

Defined in: src/ui/widgets/widget.ts:63

Returns

void

Inherited from

CheckTreeEditor.addCssClass

---

addDateRangeFilter()

protected addDateRangeFilter(field, title?): DateEditor

Defined in: src/ui/datagrid/datagrid.tsx:1028

Parameters

field

string

title?

string

Returns

DateEditor

Inherited from

CheckTreeEditor.addDateRangeFilter

---

addDateTimeRangeFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1036

Parameters

field

string

title?

string

Returns

DateTimeEditor<DateTimeEditorOptions>

Inherited from

CheckTreeEditor.addDateTimeRangeFilter

---

addFilterSeparator()

protected addFilterSeparator(): void

Defined in: src/ui/datagrid/datagrid.tsx:1008

Returns

void

Inherited from

CheckTreeEditor.addFilterSeparator

---

addQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1024

Type Parameters

TWidget

TWidget extends Widget<any>

P

P

Parameters

opt

QuickFilter<TWidget, P>

Returns

TWidget

Inherited from

CheckTreeEditor.addQuickFilter

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

CheckTreeEditor.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

CheckTreeEditor.addValidationRule

---

afterInit()

protected afterInit(): void

Defined in: src/ui/datagrid/datagrid.tsx:150

Returns

void

Inherited from

CheckTreeEditor.afterInit

---

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

CheckTreeEditor.afterRender

---

allDescendantsSelected()

protected allDescendantsSelected(item): boolean

Defined in: src/ui/editors/checktreeeditor.ts:289

Parameters

item

CheckTreeItem

Returns

boolean

Inherited from

CheckTreeEditor.allDescendantsSelected

---

allItemsSelected()

protected allItemsSelected(): boolean

Defined in: src/ui/editors/checktreeeditor.ts:278

Returns

boolean

Inherited from

CheckTreeEditor.allItemsSelected

---

anyDescendantsSelected()

protected anyDescendantsSelected(item): boolean

Defined in: src/ui/editors/checktreeeditor.ts:309

Parameters

item

CheckTreeItem

Returns

boolean

Inherited from

CheckTreeEditor.anyDescendantsSelected

---

autoRegisteringPlugin()

protected autoRegisteringPlugin(args): void

Defined in: src/ui/datagrid/datagrid.tsx:103

Parameters

args

AutoRegisterArgs

Returns

void

Inherited from

CheckTreeEditor.autoRegisteringPlugin

---

bindToSlickEvents()

protected bindToSlickEvents(): void

Defined in: src/ui/datagrid/datagrid.tsx:478

Returns

void

Inherited from

CheckTreeEditor.bindToSlickEvents

---

bindToViewEvents()

protected bindToViewEvents(): void

Defined in: src/ui/datagrid/datagrid.tsx:529

Returns

void

Inherited from

CheckTreeEditor.bindToViewEvents

---

booleanQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1048

Parameters

field

string

title?

string

yes?

string

no?

string

Returns

QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Inherited from

CheckTreeEditor.booleanQuickFilter

---

byId()

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

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

CheckTreeEditor.byId

---

canFilterColumn()

protected canFilterColumn(column): boolean

Defined in: src/ui/datagrid/datagrid.tsx:359

Parameters

column

Column

Returns

boolean

Inherited from

CheckTreeEditor.canFilterColumn

---

canShowColumn()

protected canShowColumn(column): boolean

Defined in: src/ui/datagrid/datagrid.tsx:1089

Parameters

column

Column

Returns

boolean

Inherited from

CheckTreeEditor.canShowColumn

---

cascadeItems()

protected cascadeItems(items): TItem[]

Defined in: src/ui/editors/checktreeeditor.ts:532

Parameters

items

TItem[]

Returns

TItem[]

---

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

CheckTreeEditor.change

---

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

CheckTreeEditor.changeSelect2

---

createColumns()

protected createColumns(): Column<any>[]

Defined in: src/ui/editors/checktreeeditor.ts:324

Creates initial column set for this grid. This column set is then passed to postProcessColumns to adjust widths etc, and then used as the initial columns for the slickgrid.

Returns

Column<any>[]

Inherited from

CheckTreeEditor.createColumns

---

createFilterBar()

protected createFilterBar(): void

Defined in: src/ui/datagrid/datagrid.tsx:650

Returns

void

Inherited from

CheckTreeEditor.createFilterBar

---

createIncludeDeletedButton()

protected createIncludeDeletedButton(): void

Defined in: src/ui/datagrid/datagrid.tsx:250

Returns

void

Inherited from

CheckTreeEditor.createIncludeDeletedButton

---

createPager()

protected createPager(): void

Defined in: src/ui/datagrid/datagrid.tsx:668

Returns

void

Inherited from

CheckTreeEditor.createPager

---

createQuickFilters()

protected createQuickFilters(filters?): void

Defined in: src/ui/datagrid/datagrid.tsx:198

Parameters

filters?

QuickFilter<Widget<any>, any>[]

Returns

void

Inherited from

CheckTreeEditor.createQuickFilters

---

createQuickSearchInput()

protected createQuickSearchInput(): void

Defined in: src/ui/datagrid/datagrid.tsx:259

Returns

void

Inherited from

CheckTreeEditor.createQuickSearchInput

---

createSleekColumns()

protected createSleekColumns(): Column<CheckTreeItem<TItem>>[]

Defined in: src/ui/datagrid/datagrid.tsx:398

Creates the SleekGrid columns. This method calls createColumns (via getColumns for compatibility) and then post processes them.

Returns

Column<CheckTreeItem<TItem>>[]

The SleekGrid columns.

Inherited from

CheckTreeEditor.createSleekColumns

---

createSlickContainer()

protected createSlickContainer(): Fluent

Defined in: src/ui/datagrid/datagrid.tsx:622

Returns

Fluent

Inherited from

CheckTreeEditor.createSlickContainer

---

createSlickGrid()

protected createSlickGrid(): ISleekGrid<CheckTreeItem<TItem>>

Defined in: src/ui/datagrid/datagrid.tsx:404

Override initSleekGrid to add plugins to the sleekgrid

Returns

ISleekGrid<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.createSlickGrid

---

createToolbar()

protected createToolbar(buttons): void

Defined in: src/ui/datagrid/datagrid.tsx:694

Parameters

buttons

ToolButton[]

Returns

void

Inherited from

CheckTreeEditor.createToolbar

---

createToolbarExtensions()

protected createToolbarExtensions(): void

Defined in: src/ui/editors/checktreeeditor.ts:516

Returns

void

Overrides

CheckTreeEditor.createToolbarExtensions

---

createView()

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

Defined in: src/ui/datagrid/datagrid.tsx:626

Returns

IRemoteView<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.createView

---

dateRangeQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1032

Parameters

field

string

title?

string

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Inherited from

CheckTreeEditor.dateRangeQuickFilter

---

dateTimeRangeQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1040

Parameters

field

string

title?

string

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Inherited from

CheckTreeEditor.dateTimeRangeQuickFilter

---

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

CheckTreeEditor.deferRender

---

destroy()

destroy(): void

Defined in: src/ui/editors/checktreeeditor.ts:494

Returns

void

Overrides

CheckTreeEditor.destroy

---

determineText()

protected determineText(getKey): string

Defined in: src/ui/datagrid/datagrid.tsx:1012

Parameters

getKey

(prefix) => string

Returns

string

Inherited from

CheckTreeEditor.determineText

---

editItem()

protected editItem(entityOrId): void

Defined in: src/ui/datagrid/datagrid.tsx:494

Parameters

entityOrId

any

Returns

void

Inherited from

CheckTreeEditor.editItem

---

editItemOfType()

protected editItemOfType(itemType, entityOrId): void

Defined in: src/ui/datagrid/datagrid.tsx:498

Parameters

itemType

string

entityOrId

any

Returns

void

Inherited from

CheckTreeEditor.editItemOfType

---

EditLink()

EditLink(props): any

Defined in: src/ui/datagrid/datagrid.tsx:740

Renders an edit link for the item in current row. Returns a DocumentFragment for non-data rows, and an anchor element otherwise.

Parameters

props

children?

any

The link text. If not provided it will be taken from ctx.escape(ctx.value)

context?

FormatterContext

formatter context (contains item, value etc)

cssClass?

string

Extra CSS class to add to the link element besides s-EditLink. Optional.

id?

string

The id of the entity to link to. If not provided it will be taken from ctx.item[idField]

idField?

string

The name of the field in item that contains the entity id. Defaults to idProperty. Used if id is not provided.

itemType?

string

The item type to link to. Defaults to this.getItemType()

tabindex?

number

The tabindex to assign to the link, default is undefined

tabIndex?

number

Deprecated

Use tabindex.

Returns

any

Inherited from

CheckTreeEditor.EditLink

---

enableAdvancedFiltering()

protected enableAdvancedFiltering(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:639

Returns

boolean

Inherited from

CheckTreeEditor.enableAdvancedFiltering

---

ensureQuickFilterBar()

protected ensureQuickFilterBar(): QuickFilterBar

Defined in: src/ui/datagrid/datagrid.tsx:190

Returns

QuickFilterBar

Inherited from

CheckTreeEditor.ensureQuickFilterBar

---

filterItems()

protected filterItems(items): TItem[]

Defined in: src/ui/editors/checktreeeditor.ts:554

Parameters

items

TItem[]

Returns

TItem[]

---

filterStoreChanged()

protected filterStoreChanged(): void

Defined in: src/ui/datagrid/datagrid.tsx:376

Returns

void

Inherited from

CheckTreeEditor.filterStoreChanged

---

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

CheckTreeEditor.findById

---

findQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:234

Type Parameters

TWidget

TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

CheckTreeEditor.findQuickFilter

---

get_cascadeField()

protected get_cascadeField(): string

Defined in: src/ui/editors/checktreeeditor.ts:638

Returns

string

---

get_cascadeFrom()

protected get_cascadeFrom(): string

Defined in: src/ui/editors/checktreeeditor.ts:594

Returns

string

---

get_cascadeValue()

protected get_cascadeValue(): any

Defined in: src/ui/editors/checktreeeditor.ts:654

Returns

any

---

get_filterField()

protected get_filterField(): string

Defined in: src/ui/editors/checktreeeditor.ts:674

Returns

string

---

get_filterValue()

protected get_filterValue(): any

Defined in: src/ui/editors/checktreeeditor.ts:690

Returns

any

---

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/editors/checktreeeditor.ts:399

Returns

boolean

Inherited from

CheckTreeEditor.get_readOnly

---

getAddButtonCaption()

protected getAddButtonCaption(): string

Defined in: src/ui/datagrid/datagrid.tsx:486

Returns

string

Inherited from

CheckTreeEditor.getAddButtonCaption

---

getButtons()

protected getButtons(): ToolButton[]

Defined in: src/ui/editors/checktreeeditor.ts:512

Returns

ToolButton[]

Overrides

CheckTreeEditor.getButtons

---

getCascadeFromValue()

protected getCascadeFromValue(parent): any

Defined in: src/ui/editors/checktreeeditor.ts:602

Parameters

parent

Widget<any>

Returns

any

---

getColumns()

protected getColumns(): Column<CheckTreeItem<TItem>>[]

Defined in: src/ui/datagrid/datagrid.tsx:822

Returns

Column<CheckTreeItem<TItem>>[]

Deprecated

override createColumns

Inherited from

CheckTreeEditor.getColumns

---

getColumnsKey()

protected getColumnsKey(): string

Defined in: src/ui/datagrid/datagrid.tsx:784

Returns

string

Inherited from

CheckTreeEditor.getColumnsKey

---

getColumnWidthDelta()

protected getColumnWidthDelta(): number

Defined in: src/ui/datagrid/datagrid.tsx:336

Returns

number

Inherited from

CheckTreeEditor.getColumnWidthDelta

---

getColumnWidthScale()

protected getColumnWidthScale(): number

Defined in: src/ui/datagrid/datagrid.tsx:340

Returns

number

Inherited from

CheckTreeEditor.getColumnWidthScale

---

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

CheckTreeEditor.getCssClass

---

getCurrentSettings()

getCurrentSettings(flags?): PersistedGridSettings

Defined in: src/ui/datagrid/datagrid.tsx:1208

Parameters

flags?

GridPersistenceFlags

Returns

PersistedGridSettings

Inherited from

CheckTreeEditor.getCurrentSettings

---

getCustomAttribute()

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

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

CheckTreeEditor.getCustomAttribute

---

getDefaultSortBy()

protected getDefaultSortBy(): any[]

Defined in: src/ui/datagrid/datagrid.tsx:631

Returns

any[]

Inherited from

CheckTreeEditor.getDefaultSortBy

---

getDelimited()

protected getDelimited(): boolean

Defined in: src/ui/editors/checktreeeditor.ts:305

Returns

boolean

Inherited from

CheckTreeEditor.getDelimited

---

getDescendantsSelected()

protected getDescendantsSelected(item): boolean

Defined in: src/ui/editors/checktreeeditor.ts:257

Parameters

item

CheckTreeItem

Returns

boolean

Inherited from

CheckTreeEditor.getDescendantsSelected

---

getEditValue()

getEditValue(property, target): void

Defined in: src/ui/editors/checktreeeditor.ts:73

Parameters

property

PropertyItem

target

any

Returns

void

Inherited from

CheckTreeEditor.getEditValue

---

getElement()

getElement(): HTMLElement

Defined in: src/ui/datagrid/datagrid.tsx:1238

Returns

HTMLElement

Inherited from

CheckTreeEditor.getElement

---

getFilterStore()

getFilterStore(): FilterStore

Defined in: src/ui/datagrid/datagrid.tsx:1256

Returns

FilterStore

Inherited from

CheckTreeEditor.getFilterStore

---

getGrid()

getGrid(): ISleekGrid<CheckTreeItem<TItem>>

Defined in: src/ui/datagrid/datagrid.tsx:1242

Returns

ISleekGrid<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.getGrid

---

getGridCanLoad()

protected getGridCanLoad(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:874

Returns

boolean

Inherited from

CheckTreeEditor.getGridCanLoad

---

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Fluent

Inherited from

CheckTreeEditor.getGridField

---

getIdProperty()

protected getIdProperty(): string

Defined in: src/ui/editors/checktreeeditor.ts:44

Returns

string

Inherited from

CheckTreeEditor.getIdProperty

---

getIncludeColumns()

protected getIncludeColumns(include): void

Defined in: src/ui/datagrid/datagrid.tsx:570

Parameters

include

Returns

void

Inherited from

CheckTreeEditor.getIncludeColumns

---

getInitialCollapse()

protected getInitialCollapse(): boolean

Defined in: src/ui/editors/checktreeeditor.ts:156

Returns

boolean

Inherited from

CheckTreeEditor.getInitialCollapse

---

getInitialTitle()

protected getInitialTitle(): string

Defined in: src/ui/datagrid/datagrid.tsx:183

Returns

string

Inherited from

CheckTreeEditor.getInitialTitle

---

getIsActiveProperty()

protected getIsActiveProperty(): string

Defined in: src/ui/datagrid/datagrid.tsx:989

Returns

string

Inherited from

CheckTreeEditor.getIsActiveProperty

---

getIsDeletedProperty()

protected getIsDeletedProperty(): string

Defined in: src/ui/datagrid/datagrid.tsx:983

Returns

string

Inherited from

CheckTreeEditor.getIsDeletedProperty

---

getItemCssClass()

protected getItemCssClass(item, index): string

Defined in: src/ui/datagrid/datagrid.tsx:303

Parameters

item

CheckTreeItem

index

number

Returns

string

Inherited from

CheckTreeEditor.getItemCssClass

---

getItemMetadata()

protected getItemMetadata(item, index): any

Defined in: src/ui/datagrid/datagrid.tsx:307

Parameters

item

CheckTreeItem

index

number

Returns

any

Inherited from

CheckTreeEditor.getItemMetadata

---

getItems()

getItems(): CheckTreeItem<TItem>[]

Defined in: src/ui/datagrid/datagrid.tsx:453

Returns

CheckTreeItem<TItem>[]

Inherited from

CheckTreeEditor.getItems

---

getItemText()

protected getItemText(ctx): string

Defined in: src/ui/editors/checktreeeditor.ts:355

Parameters

ctx

FormatterContext

Returns

string

Inherited from

CheckTreeEditor.getItemText

---

getItemType()

protected getItemType(): string

Defined in: src/ui/datagrid/datagrid.tsx:730

Returns

string

Inherited from

CheckTreeEditor.getItemType

---

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

Defined in: src/ui/datagrid/datagrid.tsx:950

Returns

string

Inherited from

CheckTreeEditor.getLocalTextDbPrefix

---

getLocalTextPrefix()

protected getLocalTextPrefix(): string

Defined in: src/ui/datagrid/datagrid.tsx:962

Returns

string

Inherited from

CheckTreeEditor.getLocalTextPrefix

---

getLookupItems()

protected getLookupItems(lookup): TItem[]

Defined in: src/ui/editors/checktreeeditor.ts:570

Parameters

lookup

Lookup<TItem>

Returns

TItem[]

---

getLookupKey()

protected getLookupKey(): string

Defined in: src/ui/editors/checktreeeditor.ts:508

Returns

string

---

getPagerOptions()

protected getPagerOptions(): PagerOptions

Defined in: src/ui/datagrid/datagrid.tsx:660

Returns

PagerOptions

Inherited from

CheckTreeEditor.getPagerOptions

---

getPersistedSettings()

protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Defined in: src/ui/datagrid/datagrid.tsx:1110

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

CheckTreeEditor.getPersistedSettings

---

getPersistenceKey()

protected getPersistenceKey(): string

Defined in: src/ui/datagrid/datagrid.tsx:1070

Returns

string

Inherited from

CheckTreeEditor.getPersistenceKey

---

getPersistenceStorage()

protected getPersistenceStorage(): SettingStorage

Defined in: src/ui/datagrid/datagrid.tsx:1064

Returns

SettingStorage

Inherited from

CheckTreeEditor.getPersistenceStorage

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Defined in: src/ui/datagrid/datagrid.tsx:788

Returns

PropertyItem[]

Inherited from

CheckTreeEditor.getPropertyItems

---

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

Defined in: src/ui/datagrid/datagrid.tsx:792

Returns

PropertyItemsData

Inherited from

CheckTreeEditor.getPropertyItemsData

---

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Defined in: src/ui/datagrid/datagrid.tsx:812

Returns

Promise<PropertyItemsData>

Inherited from

CheckTreeEditor.getPropertyItemsDataAsync

---

getQuickFilters()

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

Defined in: src/ui/datagrid/datagrid.tsx:220

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

CheckTreeEditor.getQuickFilters

---

getQuickSearchFields()

protected getQuickSearchFields(): QuickSearchField[]

Defined in: src/ui/datagrid/datagrid.tsx:255

Returns

QuickSearchField[]

Inherited from

CheckTreeEditor.getQuickSearchFields

---

getRowDefinition()

protected getRowDefinition(): IRowDefinition

Defined in: src/ui/datagrid/datagrid.tsx:944

Returns

IRowDefinition

Inherited from

CheckTreeEditor.getRowDefinition

---

getSelectAllText()

protected getSelectAllText(): string

Defined in: src/ui/editors/checktreeeditor.ts:525

Returns

string

Overrides

CheckTreeEditor.getSelectAllText

---

getSlickOptions()

protected getSlickOptions(): GridOptions

Defined in: src/ui/editors/checktreeeditor.ts:359

Returns

GridOptions

Inherited from

CheckTreeEditor.getSlickOptions

---

getTitle()

getTitle(): string

Defined in: src/ui/datagrid/datagrid.tsx:702

Returns

string

Inherited from

CheckTreeEditor.getTitle

---

getTreeItems()

protected getTreeItems(): CheckTreeItem<TItem>[]

Defined in: src/ui/editors/checktreeeditor.ts:574

Returns

CheckTreeItem<TItem>[]

Overrides

CheckTreeEditor.getTreeItems

---

getView()

getView(): IRemoteView<CheckTreeItem<TItem>>

Defined in: src/ui/datagrid/datagrid.tsx:1252

Returns

IRemoteView<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.getView

---

getViewOptions()

protected getViewOptions(): RemoteViewOptions<any>

Defined in: src/ui/datagrid/datagrid.tsx:672

Returns

RemoteViewOptions<any>

Inherited from

CheckTreeEditor.getViewOptions

---

gridPersistenceFlags()

protected gridPersistenceFlags(): GridPersistenceFlags

Defined in: src/ui/datagrid/datagrid.tsx:1083

Returns

GridPersistenceFlags

Inherited from

CheckTreeEditor.gridPersistenceFlags

---

handleGridClick()

protected handleGridClick(e): void

Defined in: src/ui/datagrid/datagrid.tsx:466

Parameters

e

CellMouseEvent

Returns

void

Inherited from

CheckTreeEditor.handleGridClick

---

handleGridColumnsReordered()

protected handleGridColumnsReordered(): void

Defined in: src/ui/datagrid/datagrid.tsx:470

Returns

void

Inherited from

CheckTreeEditor.handleGridColumnsReordered

---

handleGridColumnsResized()

protected handleGridColumnsResized(): void

Defined in: src/ui/datagrid/datagrid.tsx:474

Returns

void

Inherited from

CheckTreeEditor.handleGridColumnsResized

---

handleGridSort()

protected handleGridSort(e): void

Defined in: src/ui/datagrid/datagrid.tsx:461

Parameters

e

GridSortEvent

Returns

void

Inherited from

CheckTreeEditor.handleGridSort

---

handleViewFilter()

protected handleViewFilter(item): boolean

Defined in: src/ui/datagrid/datagrid.tsx:537

Parameters

item

CheckTreeItem

Returns

boolean

Inherited from

CheckTreeEditor.handleViewFilter

---

handleViewProcessData()

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

Defined in: src/ui/datagrid/datagrid.tsx:546

Parameters

response

ListResponse<CheckTreeItem<TItem>>

Returns

ListResponse<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.handleViewProcessData

---

handleViewSubmit()

protected handleViewSubmit(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:553

Returns

boolean

Inherited from

CheckTreeEditor.handleViewSubmit

---

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

CheckTreeEditor.init

---

initializeFilterBar()

protected initializeFilterBar(): void

Defined in: src/ui/datagrid/datagrid.tsx:366

Returns

void

Inherited from

CheckTreeEditor.initializeFilterBar

---

initialPopulate()

protected initialPopulate(): void

Defined in: src/ui/datagrid/datagrid.tsx:344

Returns

void

Inherited from

CheckTreeEditor.initialPopulate

---

initSleekGrid()

protected initSleekGrid(): void

Defined in: src/ui/editors/checktreeeditor.ts:122

Returns

void

Inherited from

CheckTreeEditor.initSleekGrid

---

internalRefresh()

protected internalRefresh(): void

Defined in: src/ui/datagrid/datagrid.tsx:915

Returns

void

Inherited from

CheckTreeEditor.internalRefresh

---

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

CheckTreeEditor.internalRenderContents

---

invokeSubmitHandlers()

protected invokeSubmitHandlers(): void

Defined in: src/ui/datagrid/datagrid.tsx:1052

Returns

void

Inherited from

CheckTreeEditor.invokeSubmitHandlers

---

isThreeStateHierarchy()

protected isThreeStateHierarchy(): boolean

Defined in: src/ui/editors/checktreeeditor.ts:118

Returns

boolean

Inherited from

CheckTreeEditor.isThreeStateHierarchy

---

itemAt()

itemAt(row): CheckTreeItem

Defined in: src/ui/datagrid/datagrid.tsx:441

Parameters

row

number

Returns

CheckTreeItem

Inherited from

CheckTreeEditor.itemAt

---

itemId()

itemId(item): any

Defined in: src/ui/datagrid/datagrid.tsx:445

Parameters

item

CheckTreeItem

Returns

any

Inherited from

CheckTreeEditor.itemId

---

itemLink()

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

Defined in: src/ui/datagrid/datagrid.tsx:734

Parameters

itemType?

string

idField?

string

text?

Format<CheckTreeItem<TItem>>

cssClass?

(ctx) => string

encode?

boolean = true

Returns

Format<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.itemLink

---

itemSelectedChanged()

protected itemSelectedChanged(item): void

Defined in: src/ui/editors/checktreeeditor.ts:111

Parameters

item

CheckTreeItem

Returns

void

Inherited from

CheckTreeEditor.itemSelectedChanged

---

layout()

protected layout(): void

Defined in: src/ui/datagrid/datagrid.tsx:161

Returns

void

Inherited from

CheckTreeEditor.layout

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

CheckTreeEditor.legacyTemplateRender

---

markupReady()

protected markupReady(): void

Defined in: src/ui/datagrid/datagrid.tsx:618

Returns

void

Inherited from

CheckTreeEditor.markupReady

---

moveSelectedUp()

protected moveSelectedUp(): boolean

Defined in: src/ui/editors/checktreeeditor.ts:590

Returns

boolean

Overrides

CheckTreeEditor.moveSelectedUp

---

onClick()

protected onClick(e, row, cell): void

Defined in: src/ui/editors/checktreeeditor.ts:171

Parameters

e

Event

row

number

cell

number

Returns

void

Inherited from

CheckTreeEditor.onClick

---

onViewFilter()

protected onViewFilter(item): boolean

Defined in: src/ui/editors/checktreeeditor.ts:584

Parameters

item

CheckTreeItem<TItem>

Returns

boolean

Overrides

CheckTreeEditor.onViewFilter

---

onViewProcessData()

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

Defined in: src/ui/editors/checktreeeditor.ts:160

Parameters

response

ListResponse<CheckTreeItem<TItem>>

Returns

ListResponse<CheckTreeItem<TItem>>

Inherited from

CheckTreeEditor.onViewProcessData

---

onViewSubmit()

protected onViewSubmit(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:609

Returns

boolean

Inherited from

CheckTreeEditor.onViewSubmit

---

persistenceLock()

persistenceLock(): void

Defined in: src/ui/datagrid/datagrid.tsx:1187

Returns

void

Inherited from

CheckTreeEditor.persistenceLock

---

persistenceUnlock()

persistenceUnlock(): void

Defined in: src/ui/datagrid/datagrid.tsx:1191

Returns

void

Inherited from

CheckTreeEditor.persistenceUnlock

---

persistSettings()

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

Defined in: src/ui/datagrid/datagrid.tsx:1195

Parameters

flags?

GridPersistenceFlags

Returns

void | Promise<void>

Inherited from

CheckTreeEditor.persistSettings

---

populateLock()

protected populateLock(): void

Defined in: src/ui/datagrid/datagrid.tsx:866

Returns

void

Inherited from

CheckTreeEditor.populateLock

---

populateUnlock()

protected populateUnlock(): void

Defined in: src/ui/datagrid/datagrid.tsx:870

Returns

void

Inherited from

CheckTreeEditor.populateUnlock

---

populateWhenVisible()

protected populateWhenVisible(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:646

Returns

boolean

Inherited from

CheckTreeEditor.populateWhenVisible

---

postProcessColumns()

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

Defined in: src/ui/datagrid/datagrid.tsx:315

Parameters

columns

Column<any>[]

Returns

Column<any>[]

Inherited from

CheckTreeEditor.postProcessColumns

---

prepareSubmit()

prepareSubmit(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:886

Prepares submit arguments in this.view.params by calling this.view.onSubmit if available, or this.handleViewSubmit if not. Note that if getGridCanLoad returns false, the prepared arguments might be in a incomplete state.

Returns

boolean

Inherited from

CheckTreeEditor.prepareSubmit

---

propertyItemsReady()

protected propertyItemsReady(itemsData): void

Defined in: src/ui/datagrid/datagrid.tsx:112

Parameters

itemsData

PropertyItemsData

Returns

void

Inherited from

CheckTreeEditor.propertyItemsReady

---

propertyItemsToColumns()

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

Defined in: src/ui/datagrid/datagrid.tsx:841

Parameters

propertyItems

PropertyItem[]

Returns

Column<any>[]

Inherited from

CheckTreeEditor.propertyItemsToColumns

---

quickFilterChange()

protected quickFilterChange(e): void

Defined in: src/ui/datagrid/datagrid.tsx:1058

Parameters

e

Event

Returns

void

Inherited from

CheckTreeEditor.quickFilterChange

---

refresh()

refresh(): void

Defined in: src/ui/datagrid/datagrid.tsx:895

Returns

void

Inherited from

CheckTreeEditor.refresh

---

refreshIfNeeded()

protected refreshIfNeeded(): void

Defined in: src/ui/datagrid/datagrid.tsx:908

Returns

void

Inherited from

CheckTreeEditor.refreshIfNeeded

---

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

CheckTreeEditor.render

---

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

CheckTreeEditor.renderContents

---

resizeCanvas()

protected resizeCanvas(): void

Defined in: src/ui/datagrid/datagrid.tsx:1000

Returns

void

Inherited from

CheckTreeEditor.resizeCanvas

---

restoreSettings()

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

Defined in: src/ui/datagrid/datagrid.tsx:1129

Parameters

settings?

PersistedGridSettings

flags?

GridPersistenceFlags

Returns

void | Promise<void>

Inherited from

CheckTreeEditor.restoreSettings

---

restoreSettingsFrom()

protected restoreSettingsFrom(settings, flags?): void

Defined in: src/ui/datagrid/datagrid.tsx:1140

Parameters

settings

PersistedGridSettings

flags?

GridPersistenceFlags

Returns

void

Inherited from

CheckTreeEditor.restoreSettingsFrom

---

rowCount()

rowCount(): number

Defined in: src/ui/datagrid/datagrid.tsx:449

Returns

number

Inherited from

CheckTreeEditor.rowCount

---

set_cascadeField()

protected set_cascadeField(value): void

Defined in: src/ui/editors/checktreeeditor.ts:646

Parameters

value

string

Returns

void

---

set_cascadeFrom()

protected set_cascadeFrom(value): void

Defined in: src/ui/editors/checktreeeditor.ts:627

Parameters

value

string

Returns

void

---

set_cascadeValue()

protected set_cascadeValue(value): void

Defined in: src/ui/editors/checktreeeditor.ts:662

Parameters

value

any

Returns

void

---

set_filterField()

protected set_filterField(value): void

Defined in: src/ui/editors/checktreeeditor.ts:682

Parameters

value

string

Returns

void

---

set_filterValue()

protected set_filterValue(value): void

Defined in: src/ui/editors/checktreeeditor.ts:698

Parameters

value

any

Returns

void

---

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/editors/checktreeeditor.ts:403

Parameters

value

boolean

Returns

void

Inherited from

CheckTreeEditor.set_readOnly

---

setAllSubTreeSelected()

protected setAllSubTreeSelected(item, selected): boolean

Defined in: src/ui/editors/checktreeeditor.ts:261

Parameters

item

CheckTreeItem

selected

boolean

Returns

boolean

Inherited from

CheckTreeEditor.setAllSubTreeSelected

---

setCascadeFrom()

protected setCascadeFrom(value): void

Defined in: src/ui/editors/checktreeeditor.ts:608

Parameters

value

string

Returns

void

---

setCriteriaParameter()

protected setCriteriaParameter(): void

Defined in: src/ui/datagrid/datagrid.tsx:585

Returns

void

Inherited from

CheckTreeEditor.setCriteriaParameter

---

setEditValue()

setEditValue(source, property): void

Defined in: src/ui/editors/checktreeeditor.ts:80

Parameters

source

any

property

PropertyItem

Returns

void

Inherited from

CheckTreeEditor.setEditValue

---

setEquality()

protected setEquality(field, value): void

Defined in: src/ui/datagrid/datagrid.tsx:595

Parameters

field

string

value

any

Returns

void

Inherited from

CheckTreeEditor.setEquality

---

setIncludeColumnsParameter()

protected setIncludeColumnsParameter(): void

Defined in: src/ui/datagrid/datagrid.tsx:599

Returns

void

Inherited from

CheckTreeEditor.setIncludeColumnsParameter

---

setInitialSortOrder()

protected setInitialSortOrder(): void

Defined in: src/ui/datagrid/datagrid.tsx:416

Returns

void

Inherited from

CheckTreeEditor.setInitialSortOrder

---

setItems()

setItems(value): void

Defined in: src/ui/datagrid/datagrid.tsx:457

Parameters

value

CheckTreeItem<TItem>[]

Returns

void

Inherited from

CheckTreeEditor.setItems

---

setTitle()

setTitle(value): void

Defined in: src/ui/datagrid/datagrid.tsx:710

Parameters

value

string

Returns

void

Inherited from

CheckTreeEditor.setTitle

---

sortItems()

protected sortItems(): void

Defined in: src/ui/editors/checktreeeditor.ts:365

Returns

void

Inherited from

CheckTreeEditor.sortItems

---

subDialogDataChange()

protected subDialogDataChange(): void

Defined in: src/ui/datagrid/datagrid.tsx:1004

Returns

void

Inherited from

CheckTreeEditor.subDialogDataChange

---

syncOrAsyncThen()

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

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

CheckTreeEditor.syncOrAsyncThen

---

tryFindQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:242

Type Parameters

TWidget

TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

CheckTreeEditor.tryFindQuickFilter

---

updateFlags()

protected updateFlags(): void

Defined in: src/ui/editors/checktreeeditor.ts:220

Returns

void

Inherited from

CheckTreeEditor.updateFlags

---

updateInterface()

updateInterface(): void

Defined in: src/ui/datagrid/datagrid.tsx:940

Returns

void

Inherited from

CheckTreeEditor.updateInterface

---

updateItems()

protected updateItems(): void

Defined in: src/ui/editors/checktreeeditor.ts:503

Returns

void

Overrides

CheckTreeEditor.updateItems

---

updateSelectAll()

protected updateSelectAll(): void

Defined in: src/ui/editors/checktreeeditor.ts:214

Returns

void

Inherited from

CheckTreeEditor.updateSelectAll

---

useAsync()

protected useAsync(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:153

Returns

boolean

Inherited from

CheckTreeEditor.useAsync

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

IdPrefixType

Inherited from

CheckTreeEditor.useIdPrefix

---

useLayoutTimer()

protected useLayoutTimer(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:157

Returns

boolean

Inherited from

CheckTreeEditor.useLayoutTimer

---

usePager()

protected usePager(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:635

Returns

boolean

Inherited from

CheckTreeEditor.usePager

---

viewDataChanged()

protected viewDataChanged(): void

Defined in: src/ui/datagrid/datagrid.tsx:523

Returns

void

Inherited from

CheckTreeEditor.viewDataChanged

---

wrapFormatterWithEditLink()

protected wrapFormatterWithEditLink(column, item): void

Defined in: src/ui/datagrid/datagrid.tsx:826

Parameters

column

Column

item

PropertyItem

Returns

void

Inherited from

CheckTreeEditor.wrapFormatterWithEditLink

---

create()

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

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

CheckTreeEditor.create

---

createDefaultElement()

static createDefaultElement(): HTMLDivElement

Defined in: src/ui/editors/checktreeeditor.ts:33

Returns

HTMLDivElement

Inherited from

CheckTreeEditor.createDefaultElement

---

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

CheckTreeEditor.getWidgetName

---

propertyItemToQuickFilter()

static propertyItemToQuickFilter(item): QuickFilter<any, any>

Defined in: src/ui/datagrid/datagrid.tsx:230

Parameters

item

PropertyItem

Returns

QuickFilter<any, any>

Inherited from

CheckTreeEditor.propertyItemToQuickFilter

---

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

ClassTypeInfo<TypeName>

Inherited from

CheckTreeEditor.registerClass

---

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

CheckTreeEditor.registerEditor