@serenity-is/corelib / ColumnPickerDialog

Class: ColumnPickerDialog<P>

Type parameters

Name	Type
P

Hierarchy

• TemplatedDialog<P>

  ↳ ColumnPickerDialog

Table of contents

Constructors

• constructor

Properties

• allColumns
• defaultColumns
• dialog
• domNode
• done
• idPrefix
• options
• tabs
• toolbar
• uniqueName
• validator
• visibleColumns
• typeInfo

Accessors

• dialogTitle
• element
• props

Methods

• addCssClass
• addValidationRule
• arrange
• byId
• change
• changeSelect2
• destroy
• dialogClose
• dialogOpen
• findById
• getCssClass
• getCustomAttribute
• getDialogButtons
• getDialogOptions
• getFieldElement
• getGridField
• getInitialDialogTitle
• getTemplate
• getToolbarButtons
• getValidatorOptions
• handleResponsive
• init
• initDialog
• initTabs
• initToolbar
• initUIDialog
• initValidator
• internalInit
• internalRenderContents
• isStaticPanel
• onDialogClose
• onDialogOpen
• render
• renderContents
• resetValidation
• setupColumns
• syncOrAsyncThen
• useIdPrefix
• validateForm
• create
• createDefaultElement
• createToolButton
• getWidgetName

Constructors

constructor

• new ColumnPickerDialog<P>(props?): ColumnPickerDialog<P>

Type parameters

Name	Type
P

Parameters

Name	Type
props?	WidgetProps<P>

Returns

ColumnPickerDialog<P>

Inherited from

TemplatedDialog.constructor

Defined in

src/ui/dialogs/templateddialog.ts:22

Properties

allColumns

• allColumns: Column<any>[]

Defined in

src/ui/datagrid/columnpickerdialog.ts:18

---

defaultColumns

• defaultColumns: string[]

Defined in

src/ui/datagrid/columnpickerdialog.ts:20

---

dialog

• Protected dialog: Dialog

Inherited from

TemplatedDialog.dialog

Defined in

src/ui/dialogs/templateddialog.ts:20

---

domNode

• Readonly domNode: HTMLElement

Inherited from

TemplatedDialog.domNode

Defined in

src/ui/widgets/widget.ts:18

---

done

• done: () => void

Type declaration

▸ (): void

Returns

void

Defined in

src/ui/datagrid/columnpickerdialog.ts:21

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedDialog.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

TemplatedDialog.options

Defined in

src/ui/widgets/widget.ts:15

---

tabs

• Protected tabs: Fluent<HTMLElement>

Inherited from

TemplatedDialog.tabs

Defined in

src/ui/dialogs/templateddialog.ts:17

---

toolbar

• Protected toolbar: Toolbar<ToolbarOptions>

Inherited from

TemplatedDialog.toolbar

Defined in

src/ui/dialogs/templateddialog.ts:18

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

TemplatedDialog.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

validator

• Protected validator: any

Inherited from

TemplatedDialog.validator

Defined in

src/ui/dialogs/templateddialog.ts:19

---

visibleColumns

• visibleColumns: string[]

Defined in

src/ui/datagrid/columnpickerdialog.ts:19

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

TemplatedDialog.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

dialogTitle

• get dialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:189

• set dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:193

---

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

TemplatedDialog.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

TemplatedDialog.props

Defined in

src/ui/widgets/widget.ts:182

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

TemplatedDialog.addCssClass

Defined in

src/ui/dialogs/templateddialog.ts:46

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

TemplatedDialog.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

TemplatedDialog.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

arrange

▸ arrange(): void

Returns

void

Inherited from

TemplatedDialog.arrange

Defined in

src/ui/dialogs/templateddialog.ts:162

---

byId

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

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

Fluent<TElement>

Inherited from

TemplatedDialog.byId

Defined in

src/ui/widgets/templatedwidget.ts:8

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedDialog.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedDialog.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

destroy

▸ destroy(): void

Returns

void

Inherited from

TemplatedDialog.destroy

Defined in

src/ui/dialogs/templateddialog.ts:31

---

dialogClose

▸ dialogClose(result?): void

Parameters

Name	Type
result?	string

Returns

void

Inherited from

TemplatedDialog.dialogClose

Defined in

src/ui/dialogs/templateddialog.ts:185

---

dialogOpen

▸ dialogOpen(asPanel?): void

Parameters

Name	Type
asPanel?	boolean

Returns

void

Inherited from

TemplatedDialog.dialogOpen

Defined in

src/ui/dialogs/templateddialog.ts:109

---

findById

▸ findById<TElement>(id): TElement

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

TElement

Inherited from

TemplatedDialog.findById

Defined in

src/ui/widgets/templatedwidget.ts:12

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

TemplatedDialog.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute

▸ getCustomAttribute<TAttr>(attrType, inherit?): TAttr

Type parameters

Name
TAttr

Parameters

Name	Type	Default value
attrType	(...args: any[]) => TAttr	undefined
inherit	boolean	true

Returns

TAttr

Inherited from

TemplatedDialog.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getDialogButtons

▸ getDialogButtons(): DialogButton[]

Returns

DialogButton[]

Overrides

TemplatedDialog.getDialogButtons

Defined in

src/ui/datagrid/columnpickerdialog.ts:84

---

getDialogOptions

▸ getDialogOptions(): DialogOptions

Returns

DialogOptions

Overrides

TemplatedDialog.getDialogOptions

Defined in

src/ui/datagrid/columnpickerdialog.ts:146

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

TemplatedDialog.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

TemplatedDialog.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getInitialDialogTitle

▸ getInitialDialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.getInitialDialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:50

---

getTemplate

▸ getTemplate(): string

Returns

string

Inherited from

TemplatedDialog.getTemplate

Defined in

src/ui/widgets/templatedwidget.ts:16

---

getToolbarButtons

▸ getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

TemplatedDialog.getToolbarButtons

Defined in

src/ui/dialogs/templateddialog.ts:127

---

getValidatorOptions

▸ getValidatorOptions(): any

Returns

any

Inherited from

TemplatedDialog.getValidatorOptions

Defined in

src/ui/dialogs/templateddialog.ts:142

---

handleResponsive

▸ handleResponsive(): void

Returns

void

Inherited from

TemplatedDialog.handleResponsive

Defined in

src/ui/dialogs/templateddialog.ts:205

---

init

▸ init(): this

Returns

this

Inherited from

TemplatedDialog.init

Defined in

src/ui/widgets/widget.ts:146

---

initDialog

▸ initDialog(): void

Returns

void

Inherited from

TemplatedDialog.initDialog

Defined in

src/ui/dialogs/templateddialog.ts:86

---

initTabs

▸ initTabs(): void

Returns

void

Inherited from

TemplatedDialog.initTabs

Defined in

src/ui/dialogs/templateddialog.ts:198

---

initToolbar

▸ initToolbar(): void

Returns

void

Inherited from

TemplatedDialog.initToolbar

Defined in

src/ui/dialogs/templateddialog.ts:131

---

initUIDialog

▸ initUIDialog(): void

Returns

void

Inherited from

TemplatedDialog.initUIDialog

Defined in

src/ui/dialogs/templateddialog.ts:95

---

initValidator

▸ initValidator(): void

Returns

void

Inherited from

TemplatedDialog.initValidator

Defined in

src/ui/dialogs/templateddialog.ts:146

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

TemplatedDialog.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

TemplatedDialog.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

isStaticPanel

▸ isStaticPanel(): boolean

Returns

boolean

Inherited from

TemplatedDialog.isStaticPanel

Defined in

src/ui/dialogs/templateddialog.ts:54

---

onDialogClose

▸ onDialogClose(result?): void

Parameters

Name	Type
result?	string

Returns

void

Inherited from

TemplatedDialog.onDialogClose

Defined in

src/ui/dialogs/templateddialog.ts:168

---

onDialogOpen

▸ onDialogOpen(): void

Returns

void

Overrides

TemplatedDialog.onDialogOpen

Defined in

src/ui/datagrid/columnpickerdialog.ts:265

---

render

▸ render(): any

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

Returns

any

Inherited from

TemplatedDialog.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): Fluent<HTMLDivElement>

Returns

Fluent<HTMLDivElement>

Overrides

TemplatedDialog.renderContents

Defined in

src/ui/datagrid/columnpickerdialog.ts:23

---

resetValidation

▸ resetValidation(): void

Returns

void

Inherited from

TemplatedDialog.resetValidation

Defined in

src/ui/dialogs/templateddialog.ts:154

---

setupColumns

▸ setupColumns(): void

Returns

void

Defined in

src/ui/datagrid/columnpickerdialog.ts:187

---

syncOrAsyncThen

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

Type parameters

Name
T

Parameters

Name	Type
syncMethod	() => T
asyncMethod	() => PromiseLike<T>
then	(v: T) => void

Returns

void

Inherited from

TemplatedDialog.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedDialog.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

validateForm

▸ validateForm(): boolean

Returns

boolean

Inherited from

TemplatedDialog.validateForm

Defined in

src/ui/dialogs/templateddialog.ts:158

---

create

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

Type parameters

Name	Type
TWidget	extends Widget<P>
P	P

Parameters

Name	Type
params	CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

TemplatedDialog.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLDivElement

Returns

HTMLDivElement

Inherited from

TemplatedDialog.createDefaultElement

Defined in

src/ui/dialogs/templateddialog.ts:15

---

createToolButton

▸ createToolButton(grid): ToolButton

Parameters

Name	Type
grid	IDataGrid

Returns

ToolButton

Defined in

src/ui/datagrid/columnpickerdialog.ts:48

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedDialog.getWidgetName

Defined in

src/ui/widgets/widget.ts:95