@serenity-is/corelib / CheckLookupEditor

Class: CheckLookupEditor<TItem, P>

Defined in: src/ui/editors/checktreeeditor.tsx:640

A CheckTreeEditor that populates its tree from a lookup, with optional cascading, filtering and search.

Extends

• CheckTreeEditor<CheckTreeItem<TItem>, P>

Type Parameters

TItem

TItem extends CheckTreeItem<TItem> = any

The lookup item type.

P

P extends CheckLookupEditorOptions = CheckLookupEditorOptions

Widget props type.

Constructors

Constructor

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

Defined in: src/ui/editors/checktreeeditor.tsx:651

Creates a check lookup editor.

Parameters

props

EditorProps<P>

Widget props.

Returns

CheckLookupEditor<TItem, P>

Overrides

CheckTreeEditor.constructor

Properties

cascadeLink

protected cascadeLink: CascadedWidgetLink<Widget<any>>

Defined in: src/ui/editors/checktreeeditor.tsx:781

---

domNode

readonly domNode: HTMLElement

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

The DOM node this widget is bound to.

Inherited from

CheckTreeEditor.domNode

---

filterBar

protected filterBar: FilterDisplayBar

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

The advanced filter bar widget.

Inherited from

CheckTreeEditor.filterBar

---

idPrefix

readonly idPrefix: string

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

The id prefix used for this widget's child element ids.

Inherited from

CheckTreeEditor.idPrefix

---

onAfterInit

readonly onAfterInit: PubSub<DataGridEvent>

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

Raised after this grid is initialized.

Inherited from

CheckTreeEditor.onAfterInit

---

onCanSubmit

readonly onCanSubmit: PubSub<DataGridSubmitEvent>

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

Raised to determine whether the grid can submit its view.

Inherited from

CheckTreeEditor.onCanSubmit

---

onDataChanged

readonly onDataChanged: PubSub<DataGridEvent>

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

Raised when the grid data changes.

Inherited from

CheckTreeEditor.onDataChanged

---

onFiltering

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

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

Raised while filtering items in the view.

Inherited from

CheckTreeEditor.onFiltering

---

onPersistence

readonly onPersistence: PubSub<DataGridPersistenceEvent>

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

Raised before/after persisting or restoring grid settings.

Inherited from

CheckTreeEditor.onPersistence

---

onProcessData

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

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

Raised when the view processes a list response.

Inherited from

CheckTreeEditor.onProcessData

---

onSetViewParams

readonly onSetViewParams: PubSub<DataGridEvent>

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

Raised after view parameters are prepared for submission.

Inherited from

CheckTreeEditor.onSetViewParams

---

onSubmitting

readonly onSubmitting: PubSub<DataGridSubmitEvent>

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

Raised to determine whether the view submit should proceed.

Inherited from

CheckTreeEditor.onSubmitting

---

openDialogsAsPanel

openDialogsAsPanel: boolean

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

Whether dialogs opened from this grid should be shown as panels.

Inherited from

CheckTreeEditor.openDialogsAsPanel

---

options

protected readonly options: WidgetProps<P>

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

The widget's options/props.

Inherited from

CheckTreeEditor.options

---

propertyItemsData

protected propertyItemsData: PropertyItemsData

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

The property items data for this grid.

Inherited from

CheckTreeEditor.propertyItemsData

---

quickFiltersBar

protected quickFiltersBar: QuickFilterBar

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

The quick filter bar widget.

Inherited from

CheckTreeEditor.quickFiltersBar

---

quickFiltersDiv

protected quickFiltersDiv: Fluent

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

The quick filters container element.

Inherited from

CheckTreeEditor.quickFiltersDiv

---

restoringSettings

protected restoringSettings: number

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

Counter tracking nested settings restoration.

Inherited from

CheckTreeEditor.restoringSettings

---

slickContainer

protected slickContainer: Fluent

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

The container element that hosts the grid.

Inherited from

CheckTreeEditor.slickContainer

---

titleDiv

protected titleDiv: Fluent

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

The title element.

Inherited from

CheckTreeEditor.titleDiv

---

toolbar

protected toolbar: Toolbar

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

The toolbar widget.

Inherited from

CheckTreeEditor.toolbar

---

uniqueName

readonly uniqueName: string

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

A unique name for this widget instance, used for event namespacing.

Inherited from

CheckTreeEditor.uniqueName

---

view

view: IRemoteView<CheckTreeItem<TItem>>

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

The remote view used for paging and server communication.

Inherited from

CheckTreeEditor.view

---

[typeInfo]

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

Defined in: src/ui/editors/checktreeeditor.tsx:641

Overrides

CheckTreeEditor.[typeInfo]

---

defaultOptions

readonly static defaultOptions: object = dataGridDefaults

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

Default options shared by all data grid instances.

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:334

Inherited from

CheckTreeEditor.isComponent

---

onAfterInit

readonly static onAfterInit: PubSub<DataGridEvent>

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

Static event raised after any grid is initialized.

Inherited from

CheckTreeEditor.onAfterInit

Accessors

allColumns

Get Signature

get allColumns(): Column<any>[]

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

All columns including hidden ones.

Returns

Column<any>[]

All columns from the underlying SleekGrid.

Inherited from

CheckTreeEditor.allColumns

---

cascadeField

Get Signature

get cascadeField(): string

Defined in: src/ui/editors/checktreeeditor.tsx:823

Returns the field name used for cascading.

Returns

string

The cascade field.

Set Signature

set cascadeField(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:835

Sets the field name used for cascading.

Parameters

value

string

The cascade field name.

Returns

void

---

cascadeFrom

Get Signature

get cascadeFrom(): string

Defined in: src/ui/editors/checktreeeditor.tsx:773

Returns the id of the parent editor to cascade from.

Returns

string

The cascade source id.

Set Signature

set cascadeFrom(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:813

Sets the cascade source.

Parameters

value

string

Id of the parent editor to cascade from.

Returns

void

---

cascadeValue

Get Signature

get cascadeValue(): any

Defined in: src/ui/editors/checktreeeditor.tsx:845

Returns the current cascade filter value.

Returns

any

The cascade value.

Set Signature

set cascadeValue(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:861

Sets the cascade filter value.

Parameters

value

any

The cascade value to set.

Returns

void

---

columns

Get Signature

get columns(): Column<TItem>[]

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

The currently visible columns.

Returns

Column<TItem>[]

Inherited from

CheckTreeEditor.columns

---

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

CheckTreeEditor.element

---

filterField

Get Signature

get filterField(): string

Defined in: src/ui/editors/checktreeeditor.tsx:871

Returns the field name used for filtering.

Returns

string

The filter field.

Set Signature

set filterField(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:883

Sets the field name used for filtering.

Parameters

value

string

The filter field name.

Returns

void

---

filterValue

Get Signature

get filterValue(): any

Defined in: src/ui/editors/checktreeeditor.tsx:893

Returns the current filter value.

Returns

any

The filter value.

Set Signature

set filterValue(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:909

Sets the filter value.

Parameters

value

any

The filter value to set.

Returns

void

---

initialSettings

Get Signature

get initialSettings(): PersistedGridSettings

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

The initial persisted settings captured at startup.

Returns

PersistedGridSettings

Set Signature

set initialSettings(value): void

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

Sets the initial persisted settings.

Parameters

value

PersistedGridSettings

Returns

void

Inherited from

CheckTreeEditor.initialSettings

---

props

Get Signature

get props(): WidgetProps<P>

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

Returns the widget's props/options.

Returns

WidgetProps<P>

Inherited from

CheckTreeEditor.props

---

readOnly

Get Signature

get readOnly(): boolean

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

Whether the grid is in read-only mode.

Returns

boolean

true if read-only, otherwise false.

Set Signature

set readOnly(value): void

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

Sets whether the grid is in read-only mode.

Parameters

value

boolean

true to enable read-only mode, false to disable.

Returns

void

Inherited from

CheckTreeEditor.readOnly

---

sleekGrid

Get Signature

get sleekGrid(): ISleekGrid<TItem>

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

The underlying SleekGrid instance.

Returns

ISleekGrid<TItem>

The current SleekGrid instance.

Set Signature

set sleekGrid(value): void

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

Sets the underlying SleekGrid instance.

Parameters

value

ISleekGrid<TItem>

SleekGrid instance to set.

Returns

void

Inherited from

CheckTreeEditor.sleekGrid

---

slickGrid

Get Signature

get slickGrid(): ISleekGrid<TItem>

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

Deprecated

Use sleekGrid or getGrid().

Returns

ISleekGrid<TItem>

The underlying SleekGrid instance.

Inherited from

CheckTreeEditor.slickGrid

---

value

Get Signature

get value(): string[]

Defined in: src/ui/editors/checktreeeditor.tsx:561

Returns the selected item ids.

Returns

string[]

Array of selected ids.

Set Signature

set value(v): void

Defined in: src/ui/editors/checktreeeditor.tsx:604

Sets the selected item ids.

Parameters

v

string[]

Array of ids to select.

Returns

void

Inherited from

CheckTreeEditor.value

---

defaultColumnWidthDelta

Get Signature

get static defaultColumnWidthDelta(): number

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

Default column width delta applied to all grids.

Returns

number

The current column width delta.

Set Signature

set static defaultColumnWidthDelta(value): void

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

Sets the default column width delta applied to all grids.

Parameters

value

number

Delta in pixels added to each column width.

Returns

void

Inherited from

CheckTreeEditor.defaultColumnWidthDelta

---

defaultColumnWidthScale

Get Signature

get static defaultColumnWidthScale(): number

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

Default column width scale applied to all grids.

Returns

number

The current column width scale.

Set Signature

set static defaultColumnWidthScale(value): void

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

Sets the default column width scale applied to all grids.

Parameters

value

number

Scale factor (e.g. 1.1 for 10% wider).

Returns

void

Inherited from

CheckTreeEditor.defaultColumnWidthScale

---

defaultPersistanceStorage

Get Signature

get static defaultPersistanceStorage(): SettingStorage

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

Deprecated

Use defaultPersistenceStorage — this has a typo.

Returns

SettingStorage

The current persistence storage.

Set Signature

set static defaultPersistanceStorage(value): void

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

Deprecated

Use defaultPersistenceStorage — this has a typo.

Parameters

value

SettingStorage

Persistence storage to set.

Returns

void

Inherited from

CheckTreeEditor.defaultPersistanceStorage

---

defaultPersistenceStorage

Get Signature

get static defaultPersistenceStorage(): SettingStorage

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

Default storage used for grid persistence.

Returns

SettingStorage

The current persistence storage.

Set Signature

set static defaultPersistenceStorage(value): void

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

Sets the default storage used for grid persistence.

Parameters

value

SettingStorage

Persistence storage to use (e.g. localStorage-backed).

Returns

void

Inherited from

CheckTreeEditor.defaultPersistenceStorage

---

defaultRowHeight

Get Signature

get static defaultRowHeight(): number

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

Default row height used when creating grids.

Returns

number

Inherited from

CheckTreeEditor.defaultRowHeight

Methods

addBooleanFilter()

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

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

Adds a boolean quick filter for the specified field.

Parameters

field

string

Field name.

title?

string

Optional display title.

yes?

string

Optional text for the true option.

no?

string

Optional text for the false option.

Returns

SelectEditor

The created select editor.

Inherited from

CheckTreeEditor.addBooleanFilter

---

addCssClass()

protected addCssClass(): void

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

Adds the widget's CSS class to its DOM node.

Returns

void

Inherited from

CheckTreeEditor.addCssClass

---

addDateRangeFilter()

protected addDateRangeFilter(field, title?): DateEditor

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

Adds a date range quick filter for the specified field.

Parameters

field

string

Field name.

title?

string

Optional display title.

Returns

DateEditor

The created date editor.

Inherited from

CheckTreeEditor.addDateRangeFilter

---

addDateTimeRangeFilter()

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

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

Adds a date-time range quick filter for the specified field.

Parameters

field

string

Field name.

title?

string

Optional display title.

Returns

DateTimeEditor<DateTimeEditorOptions>

The created date-time editor.

Inherited from

CheckTreeEditor.addDateTimeRangeFilter

---

addFilterSeparator()

protected addFilterSeparator(): void

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

Adds a separator to the quick filter bar.

Returns

void

Inherited from

CheckTreeEditor.addFilterSeparator

---

addQuickFilter()

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

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

Adds a quick filter to the quick filter bar.

Type Parameters

TWidget

TWidget extends Widget<any>

P

P

Parameters

opt

QuickFilter<TWidget, P>

Quick filter definition.

Returns

TWidget

The created widget instance.

Inherited from

CheckTreeEditor.addQuickFilter

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

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

Adds a validation rule to the widget's DOM node.

Parameters

rule

(input) => string

The validation rule function, or a unique name when the two-argument overload is used.

uniqueName?

string

A unique name for the rule, or the rule function when the two-argument overload is used.

Returns

void

Inherited from

CheckTreeEditor.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

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

Adds a validation rule to the widget's DOM node.

Parameters

uniqueName

string

A unique name for the rule, or the rule function when the two-argument overload is used.

rule

(input) => string

The validation rule function, or a unique name when the two-argument overload is used.

Returns

void

Inherited from

CheckTreeEditor.addValidationRule

---

afterInit()

protected afterInit(): void

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

Hook invoked after the grid is initialized and settings are restored.

Returns

void

Inherited from

CheckTreeEditor.afterInit

---

afterRender()

protected afterRender(callback): void

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

Queues a callback to run after the widget's contents are rendered.

Parameters

callback

() => void

The callback to run after rendering.

Returns

void

Inherited from

CheckTreeEditor.afterRender

---

allDescendantsSelected()

protected allDescendantsSelected(item): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:398

Whether all descendants of an item are selected.

Parameters

item

CheckTreeItem

The item.

Returns

boolean

True when all descendants are selected.

Inherited from

CheckTreeEditor.allDescendantsSelected

---

allItemsSelected()

protected allItemsSelected(): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:382

Whether all items are selected.

Returns

boolean

True when all items are selected.

Inherited from

CheckTreeEditor.allItemsSelected

---

anyDescendantsSelected()

protected anyDescendantsSelected(item): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:427

Whether any descendant of an item is selected.

Parameters

item

CheckTreeItem

The item.

Returns

boolean

True when any descendant is selected.

Inherited from

CheckTreeEditor.anyDescendantsSelected

---

autoRegisteringPlugin()

protected autoRegisteringPlugin(args): void

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

Hook invoked when the grid is registered as an auto-registering plugin.

Parameters

args

AutoRegisterArgs

Auto-registration arguments.

Returns

void

Inherited from

CheckTreeEditor.autoRegisteringPlugin

---

bindToSlickEvents()

protected bindToSlickEvents(): void

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

Subscribes to the underlying grid events.

Returns

void

Inherited from

CheckTreeEditor.bindToSlickEvents

---

bindToViewEvents()

protected bindToViewEvents(): void

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

Subscribes to view events for filtering, submitting, and processing data.

Returns

void

Inherited from

CheckTreeEditor.bindToViewEvents

---

booleanQuickFilter()

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

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

Creates a boolean quick filter definition.

Parameters

field

string

Field name.

title?

string

Optional display title.

yes?

string

Optional text for the true option.

no?

string

Optional text for the false option.

Returns

QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

A quick filter definition.

Inherited from

CheckTreeEditor.booleanQuickFilter

---

byId()

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

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

Finds a child element by its prefix-relative id.

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

The id relative to the widget's id prefix.

Returns

Fluent<TElement>

A Fluent wrapper for the matching element.

Inherited from

CheckTreeEditor.byId

---

canFilterColumn()

protected canFilterColumn(column): boolean

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

Whether the given column can be used in the advanced filter bar.

Parameters

column

Column

Column to check.

Returns

boolean

True when the column is filterable.

Inherited from

CheckTreeEditor.canFilterColumn

---

cascadeItems()

protected cascadeItems(items): TItem[]

Defined in: src/ui/editors/checktreeeditor.tsx:705

Parameters

items

TItem[]

Returns

TItem[]

---

change()

change(handler): void

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

Registers a change handler on the widget's DOM node.

Parameters

handler

(e) => void

The change event handler.

Returns

void

Inherited from

CheckTreeEditor.change

---

changeSelect2()

changeSelect2(handler): void

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

Registers a change handler that ignores changes originating from combobox setting values.

Parameters

handler

(e) => void

The change event handler.

Returns

void

Inherited from

CheckTreeEditor.changeSelect2

---

createColumns()

protected createColumns(): Column<any>[]

Defined in: src/ui/editors/checktreeeditor.tsx:446

Creates the grid columns for the tree.

Returns

Column<any>[]

The columns.

Inherited from

CheckTreeEditor.createColumns

---

createFilterBar()

protected createFilterBar(): void

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

Creates the advanced filter bar and initializes its store.

Returns

void

Inherited from

CheckTreeEditor.createFilterBar

---

createIncludeDeletedButton()

protected createIncludeDeletedButton(): void

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

Creates the include-deleted toggle button when the row type supports it.

Returns

void

Inherited from

CheckTreeEditor.createIncludeDeletedButton

---

createPager()

protected createPager(): void

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

Creates the pager widget for this grid.

Returns

void

Inherited from

CheckTreeEditor.createPager

---

createQuickFilters()

protected createQuickFilters(filters?): void

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

Creates the quick filter bar with the given filters.

Parameters

filters?

QuickFilter<Widget<any>, any>[]

Quick filter definitions to render.

Returns

void

Inherited from

CheckTreeEditor.createQuickFilters

---

createQuickSearchInput()

protected createQuickSearchInput(): void

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

Creates the quick search input in the toolbar.

Returns

void

Inherited from

CheckTreeEditor.createQuickSearchInput

---

createSleekColumns()

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

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

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:930

Creates the container element that hosts the grid.

Returns

Fluent

The grid container element.

Inherited from

CheckTreeEditor.createSlickContainer

---

createSlickGrid()

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

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

Creates the underlying SleekGrid instance with the processed columns.

Returns

ISleekGrid<CheckTreeItem<TItem>>

The created grid instance.

Inherited from

CheckTreeEditor.createSlickGrid

---

createToolbar()

protected createToolbar(buttons): void

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

Creates the toolbar with the given buttons.

Parameters

buttons

ToolButton[]

Tool button definitions.

Returns

void

Inherited from

CheckTreeEditor.createToolbar

---

createToolbarExtensions()

protected createToolbarExtensions(): void

Defined in: src/ui/editors/checktreeeditor.tsx:685

Hook for subclasses to add extra toolbar buttons or controls.

Returns

void

Overrides

CheckTreeEditor.createToolbarExtensions

---

createView()

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

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

Creates the remote view used for paging and server communication.

Returns

IRemoteView<CheckTreeItem<TItem>>

The remote view instance.

Inherited from

CheckTreeEditor.createView

---

dateRangeQuickFilter()

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

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

Creates a date range quick filter definition.

Parameters

field

string

Field name.

title?

string

Optional display title.

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

A quick filter definition.

Inherited from

CheckTreeEditor.dateRangeQuickFilter

---

dateTimeRangeQuickFilter()

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

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

Creates a date-time range quick filter definition.

Parameters

field

string

Field name.

title?

string

Optional display title.

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

A quick filter definition.

Inherited from

CheckTreeEditor.dateTimeRangeQuickFilter

---

deferRender()

protected deferRender(): boolean

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

Determines whether rendering should be deferred until init is called.

Returns

boolean

True to defer rendering.

Inherited from

CheckTreeEditor.deferRender

---

destroy()

destroy(): void

Defined in: src/ui/editors/checktreeeditor.tsx:663

Cleans up lookup change handlers and delegates to the base destroy.

Returns

void

Overrides

CheckTreeEditor.destroy

---

determineText()

protected determineText(getKey): string

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

Resolves a localized text using the grid's local text db prefix.

Parameters

getKey

(prefix) => string

Callback that builds the text key from the prefix.

Returns

string

The localized text, or null if not found.

Inherited from

CheckTreeEditor.determineText

---

editItem()

protected editItem(entityOrId): void

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

Opens an edit dialog for the given entity or id.

Parameters

entityOrId

any

Entity instance or identifier to edit.

Returns

void

Inherited from

CheckTreeEditor.editItem

---

editItemOfType()

protected editItemOfType(itemType, entityOrId): void

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

Opens an edit dialog for a specific item type.

Parameters

itemType

string

Item type key.

entityOrId

any

Entity instance or identifier to edit.

Returns

void

Inherited from

CheckTreeEditor.editItemOfType

---

EditLink()

EditLink(props): any

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

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:963

Whether advanced filtering is enabled for this grid.

Returns

boolean

True when advanced filtering is enabled.

Inherited from

CheckTreeEditor.enableAdvancedFiltering

---

ensureQuickFilterBar()

protected ensureQuickFilterBar(): QuickFilterBar

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

Ensures the quick filter bar exists and returns it.

Returns

QuickFilterBar

The quick filter bar instance.

Inherited from

CheckTreeEditor.ensureQuickFilterBar

---

filterItems()

protected filterItems(items): TItem[]

Defined in: src/ui/editors/checktreeeditor.tsx:727

Parameters

items

TItem[]

Returns

TItem[]

---

filterStoreChanged()

protected filterStoreChanged(): void

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

Handles filter store changes by persisting settings and refreshing.

Returns

void

Inherited from

CheckTreeEditor.filterStoreChanged

---

findById()

protected findById<TElement>(id): TElement

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

Finds a child element by its prefix-relative id.

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

The id relative to the widget's id prefix.

Returns

TElement

The matching element, or null if not found.

Inherited from

CheckTreeEditor.findById

---

findQuickFilter()

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

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

Finds a quick filter widget by field name.

Type Parameters

TWidget

TWidget

Parameters

type

(...args) => TWidget

Widget constructor type.

field

string

Field name of the quick filter.

Returns

TWidget

The widget instance.

Inherited from

CheckTreeEditor.findQuickFilter

---

get_cascadeField()

protected get_cascadeField(): string

Defined in: src/ui/editors/checktreeeditor.tsx:817

Returns

string

---

get_cascadeFrom()

protected get_cascadeFrom(): string

Defined in: src/ui/editors/checktreeeditor.tsx:767

Returns

string

---

get_cascadeValue()

protected get_cascadeValue(): any

Defined in: src/ui/editors/checktreeeditor.tsx:839

Returns

any

---

get_filterField()

protected get_filterField(): string

Defined in: src/ui/editors/checktreeeditor.tsx:865

Returns

string

---

get_filterValue()

protected get_filterValue(): any

Defined in: src/ui/editors/checktreeeditor.tsx:887

Returns

any

---

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:533

Returns whether the editor is read-only.

Returns

boolean

True when read-only.

Inherited from

CheckTreeEditor.get_readOnly

---

getAddButtonCaption()

protected getAddButtonCaption(): string

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

Returns the caption for the add/new button.

Returns

string

The add button caption.

Inherited from

CheckTreeEditor.getAddButtonCaption

---

getButtons()

protected getButtons(): ToolButton[]

Defined in: src/ui/editors/checktreeeditor.tsx:681

Returns the toolbar buttons for the editor.

Returns

ToolButton[]

Tool button definitions.

Overrides

CheckTreeEditor.getButtons

---

getCascadeFromValue()

protected getCascadeFromValue(parent): any

Defined in: src/ui/editors/checktreeeditor.tsx:777

Parameters

parent

Widget<any>

Returns

any

---

getColumns()

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

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

Returns

Column<CheckTreeItem<TItem>>[]

Deprecated

override createColumns

Inherited from

CheckTreeEditor.getColumns

---

getColumnsKey()

protected getColumnsKey(): string

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

Returns the columns key used to load property items.

Returns

string

The columns key, or null for none.

Inherited from

CheckTreeEditor.getColumnsKey

---

getColumnWidthDelta()

protected getColumnWidthDelta(): number

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

Returns the width delta applied to all columns.

Returns

number

The column width delta.

Inherited from

CheckTreeEditor.getColumnWidthDelta

---

getColumnWidthScale()

protected getColumnWidthScale(): number

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

Returns the width scale applied to all columns.

Returns

number

The column width scale.

Inherited from

CheckTreeEditor.getColumnWidthScale

---

getCssClass()

protected getCssClass(): string

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

Returns the CSS class(es) applied to the widget's DOM node.

Returns

string

The space-separated CSS class string.

Inherited from

CheckTreeEditor.getCssClass

---

getCurrentSettings()

getCurrentSettings(flags?): PersistedGridSettings

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

Returns the current grid settings snapshot.

Parameters

flags?

GridPersistenceFlags

Optional persistence flags.

Returns

PersistedGridSettings

The current grid settings.

Inherited from

CheckTreeEditor.getCurrentSettings

---

getCustomAttribute()

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

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

Returns a custom attribute applied to the widget's type.

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

The attribute type to look up.

inherit

boolean = true

Whether to search inherited types; defaults to true.

Returns

TAttr

The matching attribute, or null.

Inherited from

CheckTreeEditor.getCustomAttribute

---

getDefaultSortBy()

protected getDefaultSortBy(): any[]

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

Returns the default sort order for the grid.

Returns

any[]

Array of sort descriptors.

Inherited from

CheckTreeEditor.getDefaultSortBy

---

getDelimited()

protected getDelimited(): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:418

Returns whether the value is delimited.

Returns

boolean

True when delimited.

Inherited from

CheckTreeEditor.getDelimited

---

getDescendantsSelected()

protected getDescendantsSelected(item): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:351

Whether all descendants of an item are selected.

Parameters

item

CheckTreeItem

The item.

Returns

boolean

True when all descendants are selected.

Inherited from

CheckTreeEditor.getDescendantsSelected

---

getEditValue()

getEditValue(property, target): void

Defined in: src/ui/editors/checktreeeditor.tsx:112

Gets the edit value into a target object.

Parameters

property

PropertyItem

The property item.

target

any

The target object.

Returns

void

Inherited from

CheckTreeEditor.getEditValue

---

getElement()

getElement(): HTMLElement

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

Returns the root DOM element of the grid widget.

Returns

HTMLElement

The grid container element.

Inherited from

CheckTreeEditor.getElement

---

getFilterStore()

getFilterStore(): FilterStore

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

Returns the filter store owned by the grid.

Returns

FilterStore

The filter store, or null if no filter bar exists.

Inherited from

CheckTreeEditor.getFilterStore

---

getGrid()

getGrid(): ISleekGrid<CheckTreeItem<TItem>>

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

Returns the underlying SleekGrid instance.

Returns

ISleekGrid<CheckTreeItem<TItem>>

The grid instance.

Inherited from

CheckTreeEditor.getGrid

---

getGridCanLoad()

protected getGridCanLoad(): boolean

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

Determines whether the grid can load data, notifying onCanSubmit subscribers.

Returns

boolean

True when the grid can load.

Inherited from

CheckTreeEditor.getGridCanLoad

---

getGridField()

getGridField(): Fluent

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

Returns the closest .field element containing the widget's DOM node.

Returns

Fluent

A Fluent wrapper for the grid field.

Inherited from

CheckTreeEditor.getGridField

---

getIdProperty()

protected getIdProperty(): string

Defined in: src/ui/editors/checktreeeditor.tsx:71

Returns the id property name.

Returns

string

"id".

Inherited from

CheckTreeEditor.getIdProperty

---

getIncludeColumns()

protected getIncludeColumns(include): void

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

Collects the fields and referenced fields of all columns into the given map.

Parameters

include

Map to populate with column field names.

Returns

void

Inherited from

CheckTreeEditor.getIncludeColumns

---

getInitialCollapse()

protected getInitialCollapse(): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:228

Returns the initial collapse state for tree rows.

Returns

boolean

True when collapsed.

Inherited from

CheckTreeEditor.getInitialCollapse

---

getInitialTitle()

protected getInitialTitle(): string

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

Returns the initial title shown above the grid.

Returns

string

The title text, or null for no title.

Inherited from

CheckTreeEditor.getInitialTitle

---

getIsActiveProperty()

protected getIsActiveProperty(): string

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

Returns the is-active property name for this grid.

Returns

string

The is-active property name.

Inherited from

CheckTreeEditor.getIsActiveProperty

---

getIsDeletedProperty()

protected getIsDeletedProperty(): string

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

Returns the is-deleted property name for this grid.

Returns

string

The is-deleted property name, or undefined.

Inherited from

CheckTreeEditor.getIsDeletedProperty

---

getItemCssClass()

protected getItemCssClass(item, index): string

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

Returns the CSS class for a grid row based on its active/deleted state.

Parameters

item

CheckTreeItem

The row item.

index

number

The row index.

Returns

string

The CSS class name, or an empty string.

Inherited from

CheckTreeEditor.getItemCssClass

---

getItemMetadata()

protected getItemMetadata(item, index): any

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

Returns row metadata (e.g. CSS classes) for the given item.

Parameters

item

CheckTreeItem

The row item.

index

number

The row index.

Returns

any

Row metadata object.

Inherited from

CheckTreeEditor.getItemMetadata

---

getItems()

getItems(): CheckTreeItem<TItem>[]

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

Returns the items currently displayed in the grid.

Returns

CheckTreeItem<TItem>[]

The grid items.

Inherited from

CheckTreeEditor.getItems

---

getItemText()

protected getItemText(ctx): FormatterResult

Defined in: src/ui/editors/checktreeeditor.tsx:474

Returns the display text for an item.

Parameters

ctx

FormatterContext

The formatter context.

Returns

FormatterResult

The item text.

Inherited from

CheckTreeEditor.getItemText

---

getItemType()

protected getItemType(): string

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

Returns the item type key for this grid.

Returns

string

The item type key.

Inherited from

CheckTreeEditor.getItemType

---

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

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

Returns the local text database prefix for this grid.

Returns

string

The local text db prefix.

Inherited from

CheckTreeEditor.getLocalTextDbPrefix

---

getLocalTextPrefix()

protected getLocalTextPrefix(): string

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

Returns the local text prefix for this grid.

Returns

string

The local text prefix, or undefined.

Inherited from

CheckTreeEditor.getLocalTextPrefix

---

getLookupItems()

protected getLookupItems(lookup): TItem[]

Defined in: src/ui/editors/checktreeeditor.tsx:743

Parameters

lookup

Lookup<TItem>

Returns

TItem[]

---

getLookupKey()

protected getLookupKey(): string

Defined in: src/ui/editors/checktreeeditor.tsx:677

Returns

string

---

getPagerOptions()

protected getPagerOptions(): PagerOptions

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

Returns the pager options for this grid.

Returns

PagerOptions

Pager options.

Inherited from

CheckTreeEditor.getPagerOptions

---

getPersistedSettings()

protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

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

Retrieves the persisted grid settings from storage.

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

The persisted settings, or a promise resolving to them.

Inherited from

CheckTreeEditor.getPersistedSettings

---

getPersistenceKey()

protected getPersistenceKey(): string

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

Returns the key used to store grid settings.

Returns

string

The persistence key.

Inherited from

CheckTreeEditor.getPersistenceKey

---

getPersistenceStorage()

protected getPersistenceStorage(): SettingStorage

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

Returns the storage used for grid persistence.

Returns

SettingStorage

The persistence storage.

Inherited from

CheckTreeEditor.getPersistenceStorage

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

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

Returns the property items for this grid.

Returns

PropertyItem[]

The property items.

Inherited from

CheckTreeEditor.getPropertyItems

---

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

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

Loads the property items data, either from script data or local items.

Returns

PropertyItemsData

The property items data.

Inherited from

CheckTreeEditor.getPropertyItemsData

---

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

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

Asynchronously loads the property items data.

Returns

Promise<PropertyItemsData>

A promise resolving to the property items data.

Inherited from

CheckTreeEditor.getPropertyItemsDataAsync

---

getQuickFilters()

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

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

Returns the quick filter definitions derived from the grid columns.

Returns

QuickFilter<Widget<any>, any>[]

Quick filter definitions for columns marked as quick filters.

Inherited from

CheckTreeEditor.getQuickFilters

---

getQuickSearchFields()

protected getQuickSearchFields(): QuickSearchField[]

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

Returns the quick search fields available for this grid.

Returns

QuickSearchField[]

The quick search fields, or null for none.

Inherited from

CheckTreeEditor.getQuickSearchFields

---

getRowDefinition()

protected getRowDefinition(): IRowDefinition

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

Returns the row definition for this grid.

Returns

IRowDefinition

The row definition, or null for none.

Inherited from

CheckTreeEditor.getRowDefinition

---

getSelectAllText()

protected getSelectAllText(): string

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

Returns the text for the select-all button.

Returns

string

The select-all text.

Overrides

CheckTreeEditor.getSelectAllText

---

getSlickOptions()

protected getSlickOptions(): GridOptions

Defined in: src/ui/editors/checktreeeditor.tsx:482

Returns the grid options for the editor.

Returns

GridOptions

Grid options.

Inherited from

CheckTreeEditor.getSlickOptions

---

getTitle()

getTitle(): string

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

Returns the current grid title text.

Returns

string

The title text, or null if no title is set.

Inherited from

CheckTreeEditor.getTitle

---

getTreeItems()

protected getTreeItems(): object[]

Defined in: src/ui/editors/checktreeeditor.tsx:747

Returns the tree items to display.

Returns

object[]

The tree items.

Overrides

CheckTreeEditor.getTreeItems

---

getView()

getView(): IRemoteView<CheckTreeItem<TItem>>

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

Returns the remote view used for paging and server communication.

Returns

IRemoteView<CheckTreeItem<TItem>>

The remote view instance.

Inherited from

CheckTreeEditor.getView

---

getViewOptions()

protected getViewOptions(): RemoteViewOptions<any>

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

Returns the remote view options for this grid.

Returns

RemoteViewOptions<any>

Remote view options.

Inherited from

CheckTreeEditor.getViewOptions

---

gridPersistenceFlags()

protected gridPersistenceFlags(): GridPersistenceFlags

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

Returns the default persistence flags for this grid.

Returns

GridPersistenceFlags

Grid persistence flags.

Inherited from

CheckTreeEditor.gridPersistenceFlags

---

handleGridClick()

protected handleGridClick(e): void

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

Handles grid cell click events by delegating to onClick.

Parameters

e

CellMouseEvent

Cell mouse event.

Returns

void

Inherited from

CheckTreeEditor.handleGridClick

---

handleGridColumnsReordered()

protected handleGridColumnsReordered(): void

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

Persists settings when columns are reordered.

Returns

void

Inherited from

CheckTreeEditor.handleGridColumnsReordered

---

handleGridColumnsResized()

protected handleGridColumnsResized(): void

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

Persists settings when columns are resized.

Returns

void

Inherited from

CheckTreeEditor.handleGridColumnsResized

---

handleGridSort()

protected handleGridSort(e): void

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

Handles grid sort events by applying the sort and persisting settings.

Parameters

e

GridSortEvent

Grid sort event.

Returns

void

Inherited from

CheckTreeEditor.handleGridSort

---

handleViewFilter()

protected handleViewFilter(item): boolean

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

Filters a view item, notifying the onFiltering subscribers.

Parameters

item

CheckTreeItem

The item to filter.

Returns

boolean

True when the item matches.

Inherited from

CheckTreeEditor.handleViewFilter

---

handleViewProcessData()

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

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

Processes a list response, notifying the onProcessData subscribers.

Parameters

response

ListResponse<CheckTreeItem<TItem>>

The list response.

Returns

ListResponse<CheckTreeItem<TItem>>

The processed response.

Inherited from

CheckTreeEditor.handleViewProcessData

---

handleViewSubmit()

protected handleViewSubmit(): boolean

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

Handles view submission, notifying the onSubmitting subscribers.

Returns

boolean

True when the submit should proceed.

Inherited from

CheckTreeEditor.handleViewSubmit

---

init()

init(): this

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

Initializes the widget, rendering its contents if rendering was deferred.

Returns

this

This widget instance.

Inherited from

CheckTreeEditor.init

---

initializeFilterBar()

protected initializeFilterBar(): void

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

Initializes the filter bar store with the filterable columns.

Returns

void

Inherited from

CheckTreeEditor.initializeFilterBar

---

initialPopulate()

protected initialPopulate(): void

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

Performs the initial data population, optionally waiting until visible.

Returns

void

Inherited from

CheckTreeEditor.initialPopulate

---

initSleekGrid()

protected initSleekGrid(): void

Defined in: src/ui/editors/checktreeeditor.tsx:185

Initializes the grid with tree-specific styling.

Returns

void

Inherited from

CheckTreeEditor.initSleekGrid

---

internalRefresh()

protected internalRefresh(): void

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

Performs the actual data refresh by populating the view.

Returns

void

Inherited from

CheckTreeEditor.internalRefresh

---

internalRenderContents()

internalRenderContents(): void

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

Renders the widget's contents and runs any queued after-render callbacks.

Returns

void

Inherited from

CheckTreeEditor.internalRenderContents

---

invokeSubmitHandlers()

protected invokeSubmitHandlers(): void

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

Invokes the quick filter submit handlers with the current view params.

Returns

void

Inherited from

CheckTreeEditor.invokeSubmitHandlers

---

isThreeStateHierarchy()

protected isThreeStateHierarchy(): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:178

Whether the tree uses a three-state hierarchy.

Returns

boolean

True when three-state.

Inherited from

CheckTreeEditor.isThreeStateHierarchy

---

itemAt()

itemAt(row): CheckTreeItem

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

Returns the item at the given row index.

Parameters

row

number

Row index.

Returns

CheckTreeItem

The item at that row.

Inherited from

CheckTreeEditor.itemAt

---

itemId()

itemId(item): any

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

Returns the id of the given item using the grid id property.

Parameters

item

CheckTreeItem

The item.

Returns

any

The item id.

Inherited from

CheckTreeEditor.itemId

---

itemLink()

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

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

Creates a formatter that renders a link to an item.

Parameters

itemType?

string

Item type key; defaults to the grid item type.

idField?

string

Id field name; defaults to the grid id property.

text?

Format<CheckTreeItem<TItem>>

Optional text formatter.

cssClass?

(ctx) => string

Optional CSS class formatter.

encode?

boolean = true

Whether to HTML-encode the link text.

Returns

Format<CheckTreeItem<TItem>>

A formatter function.

Inherited from

CheckTreeEditor.itemLink

---

itemSelectedChanged()

protected itemSelectedChanged(item): void

Defined in: src/ui/editors/checktreeeditor.tsx:163

Hook invoked when an item's selection changes.

Parameters

item

CheckTreeItem

The item.

Returns

void

Inherited from

CheckTreeEditor.itemSelectedChanged

---

layout()

protected layout(): void

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

Recalculates the grid layout, handling responsive height behavior.

Returns

void

Inherited from

CheckTreeEditor.layout

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Renders the widget from a legacy getTemplate string, if defined.

Returns

boolean

True if a legacy template was rendered.

Inherited from

CheckTreeEditor.legacyTemplateRender

---

markupReady()

protected markupReady(): void

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

Hook invoked when the grid markup is ready after data changes.

Returns

void

Inherited from

CheckTreeEditor.markupReady

---

moveSelectedUp()

protected moveSelectedUp(): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:763

Whether selected items should be moved to the top.

Returns

boolean

True when moving selected items up.

Overrides

CheckTreeEditor.moveSelectedUp

---

onClick()

protected onClick(e, row, cell): void

Defined in: src/ui/editors/checktreeeditor.tsx:254

Handles cell clicks, toggling checkboxes and tree expansion.

Parameters

e

Event

Click event.

row

number

Row index.

cell

number

Cell index.

Returns

void

Inherited from

CheckTreeEditor.onClick

---

onViewFilter()

protected onViewFilter(item): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:757

Filters view items for the tree hierarchy.

Parameters

item

CheckTreeItem<TItem>

The item to filter.

Returns

boolean

True when the item matches.

Overrides

CheckTreeEditor.onViewFilter

---

onViewProcessData()

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

Defined in: src/ui/editors/checktreeeditor.tsx:237

Processes the list response, setting tree indents.

Parameters

response

ListResponse<CheckTreeItem<TItem>>

The list response.

Returns

ListResponse<CheckTreeItem<TItem>>

The processed response.

Inherited from

CheckTreeEditor.onViewProcessData

---

onViewSubmit()

protected onViewSubmit(): boolean

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

Hook invoked before the view submits; prepares parameters and checks loadability.

Returns

boolean

True when the view can load.

Inherited from

CheckTreeEditor.onViewSubmit

---

persistenceLock()

persistenceLock(): void

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

Increments the persistence lock, preventing settings from being persisted.

Returns

void

Inherited from

CheckTreeEditor.persistenceLock

---

persistenceUnlock()

persistenceUnlock(): void

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

Decrements the persistence lock.

Returns

void

Inherited from

CheckTreeEditor.persistenceUnlock

---

persistSettings()

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

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

Persists the current grid settings to storage.

Parameters

flags?

GridPersistenceFlags

Optional persistence flags.

Returns

void | Promise<void>

Void or a promise that resolves when the write completes.

Inherited from

CheckTreeEditor.persistSettings

---

populateLock()

protected populateLock(): void

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

Locks the view against population.

Returns

void

Inherited from

CheckTreeEditor.populateLock

---

populateUnlock()

protected populateUnlock(): void

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

Unlocks the view population.

Returns

void

Inherited from

CheckTreeEditor.populateUnlock

---

populateWhenVisible()

protected populateWhenVisible(): boolean

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

Whether the grid should wait until visible before populating data.

Returns

boolean

True when population waits for visibility.

Inherited from

CheckTreeEditor.populateWhenVisible

---

postProcessColumns()

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

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

Applies defaults and width adjustments to the given columns.

Parameters

columns

Column<any>[]

Columns to post-process.

Returns

Column<any>[]

The processed columns.

Inherited from

CheckTreeEditor.postProcessColumns

---

prepareSubmit()

prepareSubmit(): boolean

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

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 an incomplete state.

Returns

boolean

True when the submit should proceed.

Inherited from

CheckTreeEditor.prepareSubmit

---

propertyItemsReady()

protected propertyItemsReady(itemsData): void

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

Called once property items are available; creates the grid, filter bar, pager, quick filters, and restores persisted settings.

Parameters

itemsData

PropertyItemsData

Property items and additional items for the grid.

Returns

void

Inherited from

CheckTreeEditor.propertyItemsReady

---

propertyItemsToColumns()

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

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

Converts property items to grid columns, wrapping edit-link columns.

Parameters

propertyItems

PropertyItem[]

Property items to convert.

Returns

Column<any>[]

The grid columns.

Inherited from

CheckTreeEditor.propertyItemsToColumns

---

quickFilterChange()

protected quickFilterChange(e): void

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

Handles quick filter changes by persisting settings and refreshing.

Parameters

e

Event

Change event.

Returns

void

Inherited from

CheckTreeEditor.quickFilterChange

---

refresh()

refresh(): void

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

Refreshes the grid data, waiting for visibility if configured to do so.

Returns

void

Inherited from

CheckTreeEditor.refresh

---

refreshIfNeeded()

protected refreshIfNeeded(): void

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

Refreshes the grid if a refresh was requested while hidden.

Returns

void

Inherited from

CheckTreeEditor.refreshIfNeeded

---

render()

render(): any

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

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:281

Renders the widget's contents. Override this to provide custom content.

Returns

any

The rendered contents.

Inherited from

CheckTreeEditor.renderContents

---

resizeCanvas()

protected resizeCanvas(): void

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

Resizes the underlying grid canvas.

Returns

void

Inherited from

CheckTreeEditor.resizeCanvas

---

restoreSettings()

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

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

Restores grid settings from the given settings or from storage.

Parameters

settings?

PersistedGridSettings

Optional settings to restore; defaults to persisted settings.

flags?

GridPersistenceFlags

Optional persistence flags.

Returns

void | Promise<void>

Void or a promise that resolves when restoration completes.

Inherited from

CheckTreeEditor.restoreSettings

---

restoreSettingsFrom()

protected restoreSettingsFrom(settings, flags?): void

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

Restores grid state from a persisted settings snapshot.

Parameters

settings

PersistedGridSettings

The settings to restore.

flags?

GridPersistenceFlags

Optional persistence flags.

Returns

void

Inherited from

CheckTreeEditor.restoreSettingsFrom

---

rowCount()

rowCount(): number

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

Returns the number of rows in the grid.

Returns

number

The row count.

Inherited from

CheckTreeEditor.rowCount

---

set_cascadeField()

protected set_cascadeField(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:829

Sets the field name used for cascading.

Parameters

value

string

The cascade field name.

Returns

void

---

set_cascadeFrom()

protected set_cascadeFrom(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:804

Sets the cascade source.

Parameters

value

string

Id of the parent editor to cascade from.

Returns

void

---

set_cascadeValue()

protected set_cascadeValue(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:851

Sets the cascade filter value and refreshes items.

Parameters

value

any

The cascade value to set.

Returns

void

---

set_filterField()

protected set_filterField(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:877

Sets the field name used for filtering.

Parameters

value

string

The filter field name.

Returns

void

---

set_filterValue()

protected set_filterValue(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:899

Sets the filter value and refreshes items.

Parameters

value

any

The filter value to set.

Returns

void

---

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:541

Sets whether the editor is read-only.

Parameters

value

boolean

True to enable read-only mode.

Returns

void

Inherited from

CheckTreeEditor.set_readOnly

---

setAllSubTreeSelected()

protected setAllSubTreeSelected(item, selected): boolean

Defined in: src/ui/editors/checktreeeditor.tsx:361

Sets the selection state of all descendants of an item.

Parameters

item

CheckTreeItem

The item.

selected

boolean

The selection state.

Returns

boolean

True when any item changed.

Inherited from

CheckTreeEditor.setAllSubTreeSelected

---

setCascadeFrom()

protected setCascadeFrom(value): void

Defined in: src/ui/editors/checktreeeditor.tsx:783

Parameters

value

string

Returns

void

---

setCriteriaParameter()

protected setCriteriaParameter(): void

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

Sets the Criteria view parameter from the active filter store criteria.

Returns

void

Inherited from

CheckTreeEditor.setCriteriaParameter

---

setEditValue()

setEditValue(source, property): void

Defined in: src/ui/editors/checktreeeditor.tsx:124

Sets the edit value from a source object.

Parameters

source

any

The source object.

property

PropertyItem

The property item.

Returns

void

Inherited from

CheckTreeEditor.setEditValue

---

setEquality()

protected setEquality(field, value): void

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

Sets an equality filter on the view parameters.

Parameters

field

string

Field name.

value

any

Equality value.

Returns

void

Inherited from

CheckTreeEditor.setEquality

---

setIncludeColumnsParameter()

protected setIncludeColumnsParameter(): void

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

Sets the IncludeColumns view parameter from the grid columns.

Returns

void

Inherited from

CheckTreeEditor.setIncludeColumnsParameter

---

setInitialSortOrder()

protected setInitialSortOrder(): void

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

Applies the default sort order to the grid and view.

Returns

void

Inherited from

CheckTreeEditor.setInitialSortOrder

---

setItems()

setItems(value): void

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

Sets the items displayed in the grid.

Parameters

value

CheckTreeItem<TItem>[]

The items to display.

Returns

void

Inherited from

CheckTreeEditor.setItems

---

setTitle()

setTitle(value): void

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

Sets the grid title text, creating or removing the title element as needed.

Parameters

value

string

The title text, or null to remove the title.

Returns

void

Inherited from

CheckTreeEditor.setTitle

---

setViewParams()

protected setViewParams(): void

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

Prepares all view parameters and notifies the onSetViewParams subscribers.

Returns

void

Inherited from

CheckTreeEditor.setViewParams

---

sortItems()

protected sortItems(): void

Defined in: src/ui/editors/checktreeeditor.tsx:491

Sorts items, moving selected items to the top.

Returns

void

Inherited from

CheckTreeEditor.sortItems

---

subDialogDataChange()

protected subDialogDataChange(): void

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

Refreshes the grid when a sub-dialog reports a data change.

Returns

void

Inherited from

CheckTreeEditor.subDialogDataChange

---

syncOrAsyncThen()

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

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

Runs a method synchronously or asynchronously depending on the widget's useAsync flag, then invokes a continuation.

Type Parameters

T

T

Parameters

syncMethod

() => T

The synchronous method to run.

asyncMethod

() => PromiseLike<T>

The asynchronous method to run.

then

(v) => void

The continuation invoked with the result.

Returns

void

Inherited from

CheckTreeEditor.syncOrAsyncThen

---

tryFindQuickFilter()

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

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

Tries to find a quick filter widget by field name.

Type Parameters

TWidget

TWidget

Parameters

type

(...args) => TWidget

Widget constructor type.

field

string

Field name of the quick filter.

Returns

TWidget

The widget instance, or null if not found.

Inherited from

CheckTreeEditor.tryFindQuickFilter

---

updateFlags()

protected updateFlags(): void

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

Updates the selection flags for all items.

Returns

void

Inherited from

CheckTreeEditor.updateFlags

---

updateInterface()

updateInterface(): void

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

Updates the toolbar interface to reflect the current grid state.

Returns

void

Inherited from

CheckTreeEditor.updateInterface

---

updateItems()

protected updateItems(): void

Defined in: src/ui/editors/checktreeeditor.tsx:672

Loads the tree items into the view.

Returns

void

Overrides

CheckTreeEditor.updateItems

---

updateSelectAll()

protected updateSelectAll(): void

Defined in: src/ui/editors/checktreeeditor.tsx:300

Updates the select-all button state.

Returns

void

Inherited from

CheckTreeEditor.updateSelectAll

---

useAsync()

protected useAsync(): boolean

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

Whether the grid should load property items asynchronously.

Returns

boolean

True when async loading is used.

Inherited from

CheckTreeEditor.useAsync

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns an id prefix helper for resolving child element ids.

Returns

IdPrefixType

An IdPrefixType proxy for this widget's id prefix.

Inherited from

CheckTreeEditor.useIdPrefix

---

useLayoutTimer()

protected useLayoutTimer(): boolean

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

Whether the grid should use the layout timer for responsive resizing.

Returns

boolean

True when the layout timer is used.

Inherited from

CheckTreeEditor.useLayoutTimer

---

usePager()

protected usePager(): boolean

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

Whether the grid should render a pager.

Returns

boolean

True when paging is enabled.

Inherited from

CheckTreeEditor.usePager

---

viewDataChanged()

protected viewDataChanged(): void

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

Handles view data changes by notifying subscribers and relaying out.

Returns

void

Inherited from

CheckTreeEditor.viewDataChanged

---

wrapFormatterWithEditLink()

protected wrapFormatterWithEditLink(column, item): void

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

Wraps a column formatter with an edit link formatter.

Parameters

column

Column

Column to wrap.

item

PropertyItem

Property item describing the edit link.

Returns

void

Inherited from

CheckTreeEditor.wrapFormatterWithEditLink

---

create()

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

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

Creates a widget instance from the given params, appending its element to the container and invoking the init/init callbacks.

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

The widget creation params.

Returns

TWidget

The created widget instance.

Inherited from

CheckTreeEditor.create

---

createDefaultElement()

static createDefaultElement(): HTMLDivElement

Defined in: src/ui/editors/checktreeeditor.tsx:52

Creates the default div element for the check tree editor.

Returns

HTMLDivElement

The div element.

Inherited from

CheckTreeEditor.createDefaultElement

---

getWidgetName()

static getWidgetName(type): string

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

Returns the widget name for a type, used for association and unique names.

Parameters

type

Function

The widget type.

Returns

string

The widget name.

Inherited from

CheckTreeEditor.getWidgetName

---

propertyItemToQuickFilter()

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

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

Converts a property item to a quick filter definition.

Parameters

item

PropertyItem

Property item to convert.

Returns

QuickFilter<any, any>

The quick filter definition, or null if not applicable.

Inherited from

CheckTreeEditor.propertyItemToQuickFilter

---

registerClass()

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

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

Registers this type as a class with the given type name.

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

The type name to register.

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Optional interfaces and attributes.

Returns

ClassTypeInfo<TypeName>

The class type info.

Inherited from

CheckTreeEditor.registerClass

---

registerEditor()

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

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

Registers this type as an editor with the given type name.

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

The type name to register.

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Optional interfaces and attributes.

Returns

EditorTypeInfo<TypeName>

The editor type info.

Inherited from

CheckTreeEditor.registerEditor