@serenity-is/corelib / ColumnPickerDialog

Class: ColumnPickerDialog<P>

Defined in: src/ui/datagrid/columnpickerdialog.tsx:31

Extends

BaseDialog<P>

Type Parameters

P

P extends ColumnPickerDialogOptions = ColumnPickerDialogOptions

Constructors

Constructor

new ColumnPickerDialog<P>(opt): ColumnPickerDialog<P>

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

Parameters

opt

P

Returns

ColumnPickerDialog<P>

Overrides

BaseDialog.constructor

Properties

dialog

protected dialog: Dialog

Defined in: src/ui/dialogs/basedialog.tsx:20

Inherited from

BaseDialog.dialog

domNode

readonly domNode: HTMLElement

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

Inherited from

BaseDialog.domNode

idPrefix

readonly idPrefix: string

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

Inherited from

BaseDialog.idPrefix

options

protected readonly options: WidgetProps<P>

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

Inherited from

BaseDialog.options

tabs

protected tabs: Fluent<HTMLElement>

Defined in: src/ui/dialogs/basedialog.tsx:17

Inherited from

BaseDialog.tabs

protected toolbar: Toolbar

Defined in: src/ui/dialogs/basedialog.tsx:18

Inherited from

BaseDialog.toolbar

uniqueName

readonly uniqueName: string

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

Inherited from

BaseDialog.uniqueName

validator

protected validator: any

Defined in: src/ui/dialogs/basedialog.tsx:19

Inherited from

BaseDialog.validator

[typeInfo]

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

Defined in: src/ui/datagrid/columnpickerdialog.tsx:33

Overrides

BaseDialog.[typeInfo]

isComponent

readonly static isComponent: true = true

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

Inherited from

BaseDialog.isComponent

Accessors

dialogTitle

Get Signature

get dialogTitle(): string

Defined in: src/ui/dialogs/basedialog.tsx:211

Returns

string

Set Signature

set dialogTitle(value): void

Defined in: src/ui/dialogs/basedialog.tsx:215

Parameters

value

string

Returns

void

Inherited from

BaseDialog.dialogTitle

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

BaseDialog.element

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Inherited from

BaseDialog.props

Methods

addCssClass()

protected addCssClass(): void

Defined in: src/ui/dialogs/basedialog.tsx:58

Returns

void

Inherited from

BaseDialog.addCssClass

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

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

BaseDialog.addValidationRule

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

BaseDialog.afterRender

arrange()

arrange(): void

Defined in: src/ui/dialogs/basedialog.tsx:184

Returns

void

Inherited from

BaseDialog.arrange

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

BaseDialog.byId

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

BaseDialog.change

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

BaseDialog.changeSelect2

createColumnItems()

protected createColumnItems(): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:388

Returns

void

createSearch()

protected createSearch(div): void

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

Parameters

div

HTMLElement

Returns

void

deferRender()

protected deferRender(): boolean

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

Returns

boolean

Inherited from

BaseDialog.deferRender

destroy()

destroy(): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:126

Returns

void

Overrides

BaseDialog.destroy

dialogClose()

dialogClose(result?): void

Defined in: src/ui/dialogs/basedialog.tsx:207

Parameters

result?

string

Returns

void

Inherited from

BaseDialog.dialogClose

dialogOpen()

dialogOpen(asPanel?): void

Defined in: src/ui/dialogs/basedialog.tsx:121

Parameters

asPanel?

boolean

Returns

void

Inherited from

BaseDialog.dialogOpen

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

BaseDialog.findById

getCssClass()

protected getCssClass(): string

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

Returns

string

Inherited from

BaseDialog.getCssClass

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

BaseDialog.getCustomAttribute

getDialogButtons()

protected getDialogButtons(): DialogButton[]

Defined in: src/ui/datagrid/columnpickerdialog.tsx:330

Returns

DialogButton[]

Overrides

BaseDialog.getDialogButtons

getDialogOptions()

protected getDialogOptions(): DialogOptions

Defined in: src/ui/datagrid/columnpickerdialog.tsx:323

Returns

DialogOptions

Overrides

BaseDialog.getDialogOptions

getGridField()

getGridField(): Fluent

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

Returns

Fluent

Inherited from

BaseDialog.getGridField

getInitialDialogTitle()

protected getInitialDialogTitle(): string

Defined in: src/ui/dialogs/basedialog.tsx:62

Returns

string

Inherited from

BaseDialog.getInitialDialogTitle

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

Defined in: src/ui/dialogs/basedialog.tsx:149

Returns

ToolButton[]

Inherited from

BaseDialog.getToolbarButtons

getValidatorOptions()

protected getValidatorOptions(): any

Defined in: src/ui/dialogs/basedialog.tsx:164

Returns

any

Inherited from

BaseDialog.getValidatorOptions

handleResponsive()

protected handleResponsive(): void

Defined in: src/ui/dialogs/basedialog.tsx:227

Returns

void

Inherited from

BaseDialog.handleResponsive

handleRestoreDefaults()

protected handleRestoreDefaults(): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:210

Returns

void

handleSearch()

protected handleSearch(_field, query, done): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:276

Parameters

_field

string

query

string

done

(found) => void

Returns

void

handleToggleAllClick()

protected handleToggleAllClick(): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:254

Returns

void

handleToggleClick()

protected handleToggleClick(e): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:152

Parameters

e

MouseEvent

Returns

void

init()

init(): this

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

Returns

this

Inherited from

BaseDialog.init

initDialog()

protected initDialog(): void

Defined in: src/ui/dialogs/basedialog.tsx:98

Returns

void

Inherited from

BaseDialog.initDialog

initTabs()

protected initTabs(): void

Defined in: src/ui/dialogs/basedialog.tsx:220

Returns

void

Inherited from

BaseDialog.initTabs

initToolbar()

protected initToolbar(): void

Defined in: src/ui/dialogs/basedialog.tsx:153

Returns

void

Inherited from

BaseDialog.initToolbar

initUIDialog()

protected initUIDialog(): void

Defined in: src/ui/dialogs/basedialog.tsx:107

Returns

void

Inherited from

BaseDialog.initUIDialog

initValidator()

protected initValidator(): void

Defined in: src/ui/dialogs/basedialog.tsx:168

Returns

void

Inherited from

BaseDialog.initValidator

internalRenderContents()

internalRenderContents(): void

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

Returns

void

Inherited from

BaseDialog.internalRenderContents

isStaticPanel()

protected isStaticPanel(): boolean

Defined in: src/ui/dialogs/basedialog.tsx:66

Returns

boolean

Inherited from

BaseDialog.isStaticPanel

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

Inherited from

BaseDialog.legacyTemplateRender

onChange()

protected onChange(args): PromiseLike<any>

Defined in: src/ui/datagrid/columnpickerdialog.tsx:148

Parameters

args

ColumnPickerChangeArgs

Returns

PromiseLike<any>

onClose()

onClose(handler, opt?): void

Defined in: src/ui/dialogs/basedialog.tsx:140

Attaches a dialog/modal/panel close event handler. See Dialog.close for more info.

Parameters

handler

(result?, e?) => void

opt?

before?

boolean

oneOff?

boolean

Returns

void

Inherited from

BaseDialog.onClose

onDialogClose()

protected onDialogClose(result?): void

Defined in: src/ui/dialogs/basedialog.tsx:190

Parameters

result?

string

Returns

void

Inherited from

BaseDialog.onDialogClose

onDialogOpen()

protected onDialogOpen(): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:408

Returns

void

Overrides

BaseDialog.onDialogOpen

onOpen()

onOpen(handler, opt?): void

Defined in: src/ui/dialogs/basedialog.tsx:145

Attaches a dialog/modal/panel open event handler. See Dialog.open for more info.

Parameters

handler

(e?) => void

opt?

before?

boolean

oneOff?

boolean

Returns

void

Inherited from

BaseDialog.onOpen

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

BaseDialog.render

renderContents()

protected renderContents(): any

Defined in: src/ui/datagrid/columnpickerdialog.tsx:173

Returns

any

Overrides

BaseDialog.renderContents

reorderColumns()

protected reorderColumns(columnIds, setVisible?, restoredDefaults?): void

Defined in: src/ui/datagrid/columnpickerdialog.tsx:204

Parameters

columnIds

string[]

setVisible?

string[]

restoredDefaults?

boolean

Returns

void

resetValidation()

protected resetValidation(): void

Defined in: src/ui/dialogs/basedialog.tsx:176

Returns

void

Inherited from

BaseDialog.resetValidation

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

BaseDialog.syncOrAsyncThen

toggleColumns()

protected toggleColumns(columnIds, show?): Column<any>[]

Defined in: src/ui/datagrid/columnpickerdialog.tsx:140

Parameters

columnIds

string[]

show?

boolean

Returns

Column<any>[]

updateToggleAllValue()

protected updateToggleAllValue(): boolean

Defined in: src/ui/datagrid/columnpickerdialog.tsx:271

Returns

boolean

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

Inherited from

BaseDialog.useIdPrefix

validateForm()

protected validateForm(): boolean

Defined in: src/ui/dialogs/basedialog.tsx:180

Returns

boolean

Inherited from

BaseDialog.validateForm

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

BaseDialog.create

createDefaultElement()

static createDefaultElement(): HTMLDivElement

Defined in: src/ui/dialogs/basedialog.tsx:15

Returns

HTMLDivElement

Inherited from

BaseDialog.createDefaultElement

createToolButton()

static createToolButton(optOrDataGrid): ToolButton

Defined in: src/ui/datagrid/columnpickerdialog.tsx:298

Parameters

optOrDataGrid

IDataGrid | ColumnPickerDialogOptions

Returns

ToolButton

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

Inherited from

BaseDialog.getWidgetName

openDialog()

static openDialog(opt): void

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

Parameters

opt

ColumnPickerDialogOptions

Returns

void

registerClass()

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

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

Type Parameters

TypeName

TypeName

Parameters

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

BaseDialog.registerEditor