@serenity-is/corelib / CheckTreeEditor

Class: CheckTreeEditor<TItem, P>

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

Extends

• DataGrid<TItem, P>

Extended by

• CheckLookupEditor

Type Parameters

TItem

TItem extends CheckTreeItem<TItem>

P

P = { }

Implements

• IGetEditValue
• ISetEditValue
• IReadOnly

Constructors

Constructor

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

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

Parameters

props

EditorProps<P>

Returns

CheckTreeEditor<TItem, P>

Overrides

DataGrid.constructor

Properties

domNode

readonly domNode: HTMLElement

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

Inherited from

DataGrid.domNode

---

filterBar

protected filterBar: FilterDisplayBar

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

Inherited from

DataGrid.filterBar

---

idPrefix

readonly idPrefix: string

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

Inherited from

DataGrid.idPrefix

---

onAfterInit

readonly onAfterInit: PubSub<DataGridEvent>

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

Inherited from

DataGrid.onAfterInit

---

onCanSubmit

readonly onCanSubmit: PubSub<DataGridSubmitEvent>

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

Inherited from

DataGrid.onCanSubmit

---

onDataChanged

readonly onDataChanged: PubSub<DataGridEvent>

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

Inherited from

DataGrid.onDataChanged

---

onFiltering

readonly onFiltering: PubSub<DataGridFilteringEvent<TItem>>

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

Inherited from

DataGrid.onFiltering

---

onPersistence

readonly onPersistence: PubSub<DataGridPersistenceEvent>

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

Inherited from

DataGrid.onPersistence

---

onProcessData

readonly onProcessData: PubSub<DataGridProcessEvent<TItem>>

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

Inherited from

DataGrid.onProcessData

---

onSubmitting

readonly onSubmitting: PubSub<DataGridSubmitEvent>

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

Inherited from

DataGrid.onSubmitting

---

openDialogsAsPanel

openDialogsAsPanel: boolean

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

Inherited from

DataGrid.openDialogsAsPanel

---

options

protected readonly options: WidgetProps<P>

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

Inherited from

DataGrid.options

---

propertyItemsData

protected propertyItemsData: PropertyItemsData

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

Inherited from

DataGrid.propertyItemsData

---

quickFiltersBar

protected quickFiltersBar: QuickFilterBar

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

Inherited from

DataGrid.quickFiltersBar

---

quickFiltersDiv

protected quickFiltersDiv: Fluent

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

Inherited from

DataGrid.quickFiltersDiv

---

restoringSettings

protected restoringSettings: number

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

Inherited from

DataGrid.restoringSettings

---

slickContainer

protected slickContainer: Fluent

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

Inherited from

DataGrid.slickContainer

---

titleDiv

protected titleDiv: Fluent

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

Inherited from

DataGrid.titleDiv

---

toolbar

protected toolbar: Toolbar

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

Inherited from

DataGrid.toolbar

---

uniqueName

readonly uniqueName: string

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

Inherited from

DataGrid.uniqueName

---

view

view: IRemoteView<TItem>

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

Inherited from

DataGrid.view

---

[typeInfo]

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

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

Implementation of

IReadOnly.[typeInfo]

Overrides

DataGrid.[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

DataGrid.defaultOptions

---

isComponent

readonly static isComponent: true = true

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

Inherited from

DataGrid.isComponent

---

onAfterInit

readonly static onAfterInit: PubSub<DataGridEvent>

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

Inherited from

DataGrid.onAfterInit

Accessors

allColumns

Get Signature

get allColumns(): Column<any>[]

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

Returns

Column<any>[]

Inherited from

DataGrid.allColumns

---

columns

Get Signature

get columns(): Column<TItem>[]

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

Returns

Column<TItem>[]

Inherited from

DataGrid.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

DataGrid.element

---

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

DataGrid.initialSettings

---

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Inherited from

DataGrid.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

DataGrid.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

DataGrid.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

DataGrid.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

---

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

DataGrid.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

DataGrid.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

DataGrid.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

DataGrid.defaultPersistenceStorage

---

defaultRowHeight

Get Signature

get static defaultRowHeight(): number

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

Returns

number

Inherited from

DataGrid.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

DataGrid.addBooleanFilter

---

addCssClass()

protected addCssClass(): void

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

Returns

void

Inherited from

DataGrid.addCssClass

---

addDateRangeFilter()

protected addDateRangeFilter(field, title?): DateEditor

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

Parameters

field

string

title?

string

Returns

DateEditor

Inherited from

DataGrid.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

DataGrid.addDateTimeRangeFilter

---

addFilterSeparator()

protected addFilterSeparator(): void

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

Returns

void

Inherited from

DataGrid.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

DataGrid.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

DataGrid.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

DataGrid.addValidationRule

---

afterInit()

protected afterInit(): void

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

Returns

void

Inherited from

DataGrid.afterInit

---

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

DataGrid.afterRender

---

allDescendantsSelected()

protected allDescendantsSelected(item): boolean

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

Parameters

item

TItem

Returns

boolean

---

allItemsSelected()

protected allItemsSelected(): boolean

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

Returns

boolean

---

anyDescendantsSelected()

protected anyDescendantsSelected(item): boolean

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

Parameters

item

TItem

Returns

boolean

---

autoRegisteringPlugin()

protected autoRegisteringPlugin(args): void

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

Parameters

args

AutoRegisterArgs

Returns

void

Inherited from

DataGrid.autoRegisteringPlugin

---

bindToSlickEvents()

protected bindToSlickEvents(): void

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

Returns

void

Inherited from

DataGrid.bindToSlickEvents

---

bindToViewEvents()

protected bindToViewEvents(): void

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

Returns

void

Inherited from

DataGrid.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

DataGrid.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

DataGrid.byId

---

canFilterColumn()

protected canFilterColumn(column): boolean

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

Parameters

column

Column

Returns

boolean

Inherited from

DataGrid.canFilterColumn

---

canShowColumn()

protected canShowColumn(column): boolean

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

Parameters

column

Column

Returns

boolean

Inherited from

DataGrid.canShowColumn

---

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

DataGrid.change

---

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

DataGrid.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>[]

Overrides

DataGrid.createColumns

---

createFilterBar()

protected createFilterBar(): void

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

Returns

void

Inherited from

DataGrid.createFilterBar

---

createIncludeDeletedButton()

protected createIncludeDeletedButton(): void

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

Returns

void

Inherited from

DataGrid.createIncludeDeletedButton

---

createPager()

protected createPager(): void

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

Returns

void

Inherited from

DataGrid.createPager

---

createQuickFilters()

protected createQuickFilters(filters?): void

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

Parameters

filters?

QuickFilter<Widget<any>, any>[]

Returns

void

Inherited from

DataGrid.createQuickFilters

---

createQuickSearchInput()

protected createQuickSearchInput(): void

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

Returns

void

Inherited from

DataGrid.createQuickSearchInput

---

createSleekColumns()

protected createSleekColumns(): Column<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<TItem>[]

The SleekGrid columns.

Inherited from

DataGrid.createSleekColumns

---

createSlickContainer()

protected createSlickContainer(): Fluent

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

Returns

Fluent

Inherited from

DataGrid.createSlickContainer

---

createSlickGrid()

protected createSlickGrid(): ISleekGrid<TItem>

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

Override initSleekGrid to add plugins to the sleekgrid

Returns

ISleekGrid<TItem>

Inherited from

DataGrid.createSlickGrid

---

createToolbar()

protected createToolbar(buttons): void

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

Parameters

buttons

ToolButton[]

Returns

void

Inherited from

DataGrid.createToolbar

---

createToolbarExtensions()

protected createToolbarExtensions(): void

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

Returns

void

Inherited from

DataGrid.createToolbarExtensions

---

createView()

protected createView(): IRemoteView<TItem>

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

Returns

IRemoteView<TItem>

Inherited from

DataGrid.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

DataGrid.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

DataGrid.dateTimeRangeQuickFilter

---

deferRender()

protected deferRender(): boolean

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

Returns

boolean

Inherited from

DataGrid.deferRender

---

destroy()

destroy(): void

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

Returns

void

Inherited from

DataGrid.destroy

---

determineText()

protected determineText(getKey): string

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

Parameters

getKey

(prefix) => string

Returns

string

Inherited from

DataGrid.determineText

---

editItem()

protected editItem(entityOrId): void

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

Parameters

entityOrId

any

Returns

void

Inherited from

DataGrid.editItem

---

editItemOfType()

protected editItemOfType(itemType, entityOrId): void

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

Parameters

itemType

string

entityOrId

any

Returns

void

Inherited from

DataGrid.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

DataGrid.EditLink

---

enableAdvancedFiltering()

protected enableAdvancedFiltering(): boolean

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

Returns

boolean

Inherited from

DataGrid.enableAdvancedFiltering

---

ensureQuickFilterBar()

protected ensureQuickFilterBar(): QuickFilterBar

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

Returns

QuickFilterBar

Inherited from

DataGrid.ensureQuickFilterBar

---

filterStoreChanged()

protected filterStoreChanged(): void

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

Returns

void

Inherited from

DataGrid.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

DataGrid.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

DataGrid.findQuickFilter

---

get_readOnly()

get_readOnly(): boolean

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

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Overrides

DataGrid.get_readOnly

---

getAddButtonCaption()

protected getAddButtonCaption(): string

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

Returns

string

Inherited from

DataGrid.getAddButtonCaption

---

getButtons()

protected getButtons(): ToolButton[]

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

Returns

ToolButton[]

Overrides

DataGrid.getButtons

---

getColumns()

protected getColumns(): Column<TItem>[]

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

Returns

Column<TItem>[]

Deprecated

override createColumns

Inherited from

DataGrid.getColumns

---

getColumnsKey()

protected getColumnsKey(): string

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

Returns

string

Inherited from

DataGrid.getColumnsKey

---

getColumnWidthDelta()

protected getColumnWidthDelta(): number

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

Returns

number

Inherited from

DataGrid.getColumnWidthDelta

---

getColumnWidthScale()

protected getColumnWidthScale(): number

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

Returns

number

Inherited from

DataGrid.getColumnWidthScale

---

getCssClass()

protected getCssClass(): string

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

Returns

string

Inherited from

DataGrid.getCssClass

---

getCurrentSettings()

getCurrentSettings(flags?): PersistedGridSettings

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

Parameters

flags?

GridPersistenceFlags

Returns

PersistedGridSettings

Inherited from

DataGrid.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

DataGrid.getCustomAttribute

---

getDefaultSortBy()

protected getDefaultSortBy(): any[]

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

Returns

any[]

Inherited from

DataGrid.getDefaultSortBy

---

getDelimited()

protected getDelimited(): boolean

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

Returns

boolean

---

getDescendantsSelected()

protected getDescendantsSelected(item): boolean

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

Parameters

item

TItem

Returns

boolean

---

getEditValue()

getEditValue(property, target): void

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

Parameters

property

PropertyItem

target

any

Returns

void

Implementation of

IGetEditValue.getEditValue

---

getElement()

getElement(): HTMLElement

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

Returns

HTMLElement

Inherited from

DataGrid.getElement

---

getFilterStore()

getFilterStore(): FilterStore

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

Returns

FilterStore

Inherited from

DataGrid.getFilterStore

---

getGrid()

getGrid(): ISleekGrid<TItem>

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

Returns

ISleekGrid<TItem>

Inherited from

DataGrid.getGrid

---

getGridCanLoad()

protected getGridCanLoad(): boolean

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

Returns

boolean

Inherited from

DataGrid.getGridCanLoad

---

getGridField()

getGridField(): Fluent

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

Returns

Fluent

Inherited from

DataGrid.getGridField

---

getIdProperty()

protected getIdProperty(): string

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

Returns

string

Overrides

DataGrid.getIdProperty

---

getIncludeColumns()

protected getIncludeColumns(include): void

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

Parameters

include

Returns

void

Inherited from

DataGrid.getIncludeColumns

---

getInitialCollapse()

protected getInitialCollapse(): boolean

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

Returns

boolean

---

getInitialTitle()

protected getInitialTitle(): string

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

Returns

string

Inherited from

DataGrid.getInitialTitle

---

getIsActiveProperty()

protected getIsActiveProperty(): string

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

Returns

string

Inherited from

DataGrid.getIsActiveProperty

---

getIsDeletedProperty()

protected getIsDeletedProperty(): string

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

Returns

string

Inherited from

DataGrid.getIsDeletedProperty

---

getItemCssClass()

protected getItemCssClass(item, index): string

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

Parameters

item

TItem

index

number

Returns

string

Inherited from

DataGrid.getItemCssClass

---

getItemMetadata()

protected getItemMetadata(item, index): any

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

Parameters

item

TItem

index

number

Returns

any

Inherited from

DataGrid.getItemMetadata

---

getItems()

getItems(): TItem[]

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

Returns

TItem[]

Inherited from

DataGrid.getItems

---

getItemText()

protected getItemText(ctx): string

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

Parameters

ctx

FormatterContext

Returns

string

---

getItemType()

protected getItemType(): string

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

Returns

string

Inherited from

DataGrid.getItemType

---

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

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

Returns

string

Inherited from

DataGrid.getLocalTextDbPrefix

---

getLocalTextPrefix()

protected getLocalTextPrefix(): string

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

Returns

string

Inherited from

DataGrid.getLocalTextPrefix

---

getPagerOptions()

protected getPagerOptions(): PagerOptions

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

Returns

PagerOptions

Inherited from

DataGrid.getPagerOptions

---

getPersistedSettings()

protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

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

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

DataGrid.getPersistedSettings

---

getPersistenceKey()

protected getPersistenceKey(): string

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

Returns

string

Inherited from

DataGrid.getPersistenceKey

---

getPersistenceStorage()

protected getPersistenceStorage(): SettingStorage

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

Returns

SettingStorage

Inherited from

DataGrid.getPersistenceStorage

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

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

Returns

PropertyItem[]

Inherited from

DataGrid.getPropertyItems

---

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

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

Returns

PropertyItemsData

Inherited from

DataGrid.getPropertyItemsData

---

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

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

Returns

Promise<PropertyItemsData>

Inherited from

DataGrid.getPropertyItemsDataAsync

---

getQuickFilters()

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

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

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

DataGrid.getQuickFilters

---

getQuickSearchFields()

protected getQuickSearchFields(): QuickSearchField[]

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

Returns

QuickSearchField[]

Inherited from

DataGrid.getQuickSearchFields

---

getRowDefinition()

protected getRowDefinition(): IRowDefinition

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

Returns

IRowDefinition

Inherited from

DataGrid.getRowDefinition

---

getSelectAllText()

protected getSelectAllText(): string

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

Returns

string

---

getSlickOptions()

protected getSlickOptions(): GridOptions

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

Returns

GridOptions

Overrides

DataGrid.getSlickOptions

---

getTitle()

getTitle(): string

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

Returns

string

Inherited from

DataGrid.getTitle

---

getTreeItems()

protected getTreeItems(): TItem[]

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

Returns

TItem[]

---

getView()

getView(): IRemoteView<TItem>

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

Returns

IRemoteView<TItem>

Inherited from

DataGrid.getView

---

getViewOptions()

protected getViewOptions(): RemoteViewOptions<any>

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

Returns

RemoteViewOptions<any>

Inherited from

DataGrid.getViewOptions

---

gridPersistenceFlags()

protected gridPersistenceFlags(): GridPersistenceFlags

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

Returns

GridPersistenceFlags

Inherited from

DataGrid.gridPersistenceFlags

---

handleGridClick()

protected handleGridClick(e): void

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

Parameters

e

CellMouseEvent

Returns

void

Inherited from

DataGrid.handleGridClick

---

handleGridColumnsReordered()

protected handleGridColumnsReordered(): void

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

Returns

void

Inherited from

DataGrid.handleGridColumnsReordered

---

handleGridColumnsResized()

protected handleGridColumnsResized(): void

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

Returns

void

Inherited from

DataGrid.handleGridColumnsResized

---

handleGridSort()

protected handleGridSort(e): void

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

Parameters

e

GridSortEvent

Returns

void

Inherited from

DataGrid.handleGridSort

---

handleViewFilter()

protected handleViewFilter(item): boolean

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

Parameters

item

TItem

Returns

boolean

Inherited from

DataGrid.handleViewFilter

---

handleViewProcessData()

protected handleViewProcessData(response): ListResponse<TItem>

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

Parameters

response

ListResponse<TItem>

Returns

ListResponse<TItem>

Inherited from

DataGrid.handleViewProcessData

---

handleViewSubmit()

protected handleViewSubmit(): boolean

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

Returns

boolean

Inherited from

DataGrid.handleViewSubmit

---

init()

init(): this

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

Returns

this

Inherited from

DataGrid.init

---

initializeFilterBar()

protected initializeFilterBar(): void

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

Returns

void

Inherited from

DataGrid.initializeFilterBar

---

initialPopulate()

protected initialPopulate(): void

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

Returns

void

Inherited from

DataGrid.initialPopulate

---

initSleekGrid()

protected initSleekGrid(): void

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

Returns

void

Overrides

DataGrid.initSleekGrid

---

internalRefresh()

protected internalRefresh(): void

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

Returns

void

Inherited from

DataGrid.internalRefresh

---

internalRenderContents()

internalRenderContents(): void

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

Returns

void

Inherited from

DataGrid.internalRenderContents

---

invokeSubmitHandlers()

protected invokeSubmitHandlers(): void

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

Returns

void

Inherited from

DataGrid.invokeSubmitHandlers

---

isThreeStateHierarchy()

protected isThreeStateHierarchy(): boolean

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

Returns

boolean

---

itemAt()

itemAt(row): TItem

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

Parameters

row

number

Returns

TItem

Inherited from

DataGrid.itemAt

---

itemId()

itemId(item): any

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

Parameters

item

TItem

Returns

any

Inherited from

DataGrid.itemId

---

itemLink()

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

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

Parameters

itemType?

string

idField?

string

text?

Format<TItem>

cssClass?

(ctx) => string

encode?

boolean = true

Returns

Format<TItem>

Inherited from

DataGrid.itemLink

---

itemSelectedChanged()

protected itemSelectedChanged(item): void

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

Parameters

item

TItem

Returns

void

---

layout()

protected layout(): void

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

Returns

void

Inherited from

DataGrid.layout

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

Inherited from

DataGrid.legacyTemplateRender

---

markupReady()

protected markupReady(): void

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

Returns

void

Inherited from

DataGrid.markupReady

---

moveSelectedUp()

protected moveSelectedUp(): boolean

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

Returns

boolean

---

onClick()

protected onClick(e, row, cell): void

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

Parameters

e

Event

row

number

cell

number

Returns

void

Overrides

DataGrid.onClick

---

onViewFilter()

protected onViewFilter(item): boolean

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

Parameters

item

TItem

Returns

boolean

Overrides

DataGrid.onViewFilter

---

onViewProcessData()

protected onViewProcessData(response): ListResponse<TItem>

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

Parameters

response

ListResponse<TItem>

Returns

ListResponse<TItem>

Overrides

DataGrid.onViewProcessData

---

onViewSubmit()

protected onViewSubmit(): boolean

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

Returns

boolean

Inherited from

DataGrid.onViewSubmit

---

persistenceLock()

persistenceLock(): void

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

Returns

void

Inherited from

DataGrid.persistenceLock

---

persistenceUnlock()

persistenceUnlock(): void

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

Returns

void

Inherited from

DataGrid.persistenceUnlock

---

persistSettings()

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

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

Parameters

flags?

GridPersistenceFlags

Returns

void | Promise<void>

Inherited from

DataGrid.persistSettings

---

populateLock()

protected populateLock(): void

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

Returns

void

Inherited from

DataGrid.populateLock

---

populateUnlock()

protected populateUnlock(): void

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

Returns

void

Inherited from

DataGrid.populateUnlock

---

populateWhenVisible()

protected populateWhenVisible(): boolean

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

Returns

boolean

Inherited from

DataGrid.populateWhenVisible

---

postProcessColumns()

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

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

Parameters

columns

Column<any>[]

Returns

Column<any>[]

Inherited from

DataGrid.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

DataGrid.prepareSubmit

---

propertyItemsReady()

protected propertyItemsReady(itemsData): void

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

Parameters

itemsData

PropertyItemsData

Returns

void

Inherited from

DataGrid.propertyItemsReady

---

propertyItemsToColumns()

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

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

Parameters

propertyItems

PropertyItem[]

Returns

Column<any>[]

Inherited from

DataGrid.propertyItemsToColumns

---

quickFilterChange()

protected quickFilterChange(e): void

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

Parameters

e

Event

Returns

void

Inherited from

DataGrid.quickFilterChange

---

refresh()

refresh(): void

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

Returns

void

Inherited from

DataGrid.refresh

---

refreshIfNeeded()

protected refreshIfNeeded(): void

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

Returns

void

Inherited from

DataGrid.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

DataGrid.render

---

renderContents()

protected renderContents(): any

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

Returns

any

Inherited from

DataGrid.renderContents

---

resizeCanvas()

protected resizeCanvas(): void

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

Returns

void

Inherited from

DataGrid.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

DataGrid.restoreSettings

---

restoreSettingsFrom()

protected restoreSettingsFrom(settings, flags?): void

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

Parameters

settings

PersistedGridSettings

flags?

GridPersistenceFlags

Returns

void

Inherited from

DataGrid.restoreSettingsFrom

---

rowCount()

rowCount(): number

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

Returns

number

Inherited from

DataGrid.rowCount

---

set_readOnly()

set_readOnly(value): void

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

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Overrides

DataGrid.set_readOnly

---

setAllSubTreeSelected()

protected setAllSubTreeSelected(item, selected): boolean

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

Parameters

item

TItem

selected

boolean

Returns

boolean

---

setCriteriaParameter()

protected setCriteriaParameter(): void

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

Returns

void

Inherited from

DataGrid.setCriteriaParameter

---

setEditValue()

setEditValue(source, property): void

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

Parameters

source

any

property

PropertyItem

Returns

void

Implementation of

ISetEditValue.setEditValue

---

setEquality()

protected setEquality(field, value): void

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

Parameters

field

string

value

any

Returns

void

Inherited from

DataGrid.setEquality

---

setIncludeColumnsParameter()

protected setIncludeColumnsParameter(): void

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

Returns

void

Inherited from

DataGrid.setIncludeColumnsParameter

---

setInitialSortOrder()

protected setInitialSortOrder(): void

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

Returns

void

Inherited from

DataGrid.setInitialSortOrder

---

setItems()

setItems(value): void

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

Parameters

value

TItem[]

Returns

void

Inherited from

DataGrid.setItems

---

setTitle()

setTitle(value): void

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

Parameters

value

string

Returns

void

Inherited from

DataGrid.setTitle

---

sortItems()

protected sortItems(): void

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

Returns

void

---

subDialogDataChange()

protected subDialogDataChange(): void

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

Returns

void

Inherited from

DataGrid.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

DataGrid.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

DataGrid.tryFindQuickFilter

---

updateFlags()

protected updateFlags(): void

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

Returns

void

---

updateInterface()

updateInterface(): void

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

Returns

void

Inherited from

DataGrid.updateInterface

---

updateItems()

protected updateItems(): void

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

Returns

void

---

updateSelectAll()

protected updateSelectAll(): void

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

Returns

void

---

useAsync()

protected useAsync(): boolean

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

Returns

boolean

Inherited from

DataGrid.useAsync

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

Inherited from

DataGrid.useIdPrefix

---

useLayoutTimer()

protected useLayoutTimer(): boolean

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

Returns

boolean

Inherited from

DataGrid.useLayoutTimer

---

usePager()

protected usePager(): boolean

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

Returns

boolean

Inherited from

DataGrid.usePager

---

viewDataChanged()

protected viewDataChanged(): void

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

Returns

void

Inherited from

DataGrid.viewDataChanged

---

wrapFormatterWithEditLink()

protected wrapFormatterWithEditLink(column, item): void

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

Parameters

column

Column

item

PropertyItem

Returns

void

Inherited from

DataGrid.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

DataGrid.create

---

createDefaultElement()

static createDefaultElement(): HTMLDivElement

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

Returns

HTMLDivElement

Overrides

DataGrid.createDefaultElement

---

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

Inherited from

DataGrid.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

DataGrid.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

DataGrid.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

DataGrid.registerEditor