@serenity-is/corelib / ColumnPickerDialog

Class: ColumnPickerDialog

Hierarchy

• TemplatedDialog<any>

  ↳ ColumnPickerDialog

Table of contents

Constructors

• constructor

Properties

• allColumns
• colById
• defaultColumns
• done
• element
• idPrefix
• options
• tabs
• toolbar
• ulHidden
• ulVisible
• uniqueName
• validator
• visibleColumns
• widgetName
• bootstrapModal

Accessors

• dialogTitle
• isMarkedAsPanel
• isResponsive

Methods

• addCssClass
• addValidationRule
• allowHide
• arrange
• byId
• change
• changeSelect2
• createLI
• destroy
• dialogClose
• dialogOpen
• getCssClass
• getDialogButtons
• getDialogOptions
• getDialogTitle
• getFallbackTemplate
• getGridField
• getModalOptions
• getTemplate
• getTemplateName
• getTitle
• getToolbarButtons
• getValidatorOptions
• handleResponsive
• init
• initDialog
• initModal
• initTabs
• initToolbar
• initValidator
• initialize
• onDialogClose
• onDialogOpen
• renderContents
• resetValidation
• set_dialogTitle
• setupColumns
• updateListStates
• useIdPrefix
• validateForm
• closePanel
• create
• createToolButton
• elementFor
• getWidgetName
• openPanel

Constructors

constructor

• new ColumnPickerDialog()

Overrides

TemplatedDialog.constructor

Defined in

src/ui/datagrid/columnpickerdialog.ts:23

Properties

allColumns

• allColumns: Column<any>[]

Defined in

src/ui/datagrid/columnpickerdialog.ts:18

---

colById

• Private colById: Object

Index signature

▪ [key: string]: Column

Defined in

src/ui/datagrid/columnpickerdialog.ts:16

---

defaultColumns

• defaultColumns: string[]

Defined in

src/ui/datagrid/columnpickerdialog.ts:20

---

done

• done: () => void

Type declaration

▸ (): void

Returns

void

Defined in

src/ui/datagrid/columnpickerdialog.ts:21

---

element

• element: JQuery

Inherited from

TemplatedDialog.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedDialog.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

options

• Protected options: any

Inherited from

TemplatedDialog.options

Defined in

src/ui/widgets/widget.ts:62

---

tabs

• Protected tabs: JQuery

Inherited from

TemplatedDialog.tabs

Defined in

src/ui/dialogs/templateddialog.ts:12

---

toolbar

• Protected toolbar: Toolbar

Inherited from

TemplatedDialog.toolbar

Defined in

src/ui/dialogs/templateddialog.ts:13

---

ulHidden

• Private ulHidden: JQuery

Defined in

src/ui/datagrid/columnpickerdialog.ts:15

---

ulVisible

• Private ulVisible: JQuery

Defined in

src/ui/datagrid/columnpickerdialog.ts:14

---

uniqueName

• Protected uniqueName: string

Inherited from

TemplatedDialog.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

validator

• Protected validator: Validator

Inherited from

TemplatedDialog.validator

Defined in

src/ui/dialogs/templateddialog.ts:14

---

visibleColumns

• visibleColumns: string[]

Defined in

src/ui/datagrid/columnpickerdialog.ts:19

---

widgetName

• Protected widgetName: string

Inherited from

TemplatedDialog.widgetName

Defined in

src/ui/widgets/widget.ts:63

---

bootstrapModal

▪ Static bootstrapModal: boolean

Inherited from

TemplatedDialog.bootstrapModal

Defined in

src/ui/dialogs/templateddialog.ts:274

Accessors

dialogTitle

• get dialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:360

• set dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:395

---

isMarkedAsPanel

• Private get isMarkedAsPanel(): boolean

Returns

boolean

Inherited from

TemplatedDialog.isMarkedAsPanel

Defined in

src/ui/dialogs/templateddialog.ts:26

---

isResponsive

• Private get isResponsive(): boolean

Returns

boolean

Inherited from

TemplatedDialog.isResponsive

Defined in

src/ui/dialogs/templateddialog.ts:32

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

TemplatedDialog.addCssClass

Defined in

src/ui/dialogs/templateddialog.ts:315

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

Name	Type
eventClass	string
rule	(p1: JQuery) => string

Returns

JQuery

Inherited from

TemplatedDialog.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

allowHide

▸ Private allowHide(col): boolean

Parameters

Name	Type
col	Column<any>

Returns

boolean

Defined in

src/ui/datagrid/columnpickerdialog.ts:162

---

arrange

▸ arrange(): void

Returns

void

Inherited from

TemplatedDialog.arrange

Defined in

src/ui/dialogs/templateddialog.ts:291

---

byId

▸ Protected byId(id): JQuery

Parameters

Name	Type
id	string

Returns

JQuery

Inherited from

TemplatedDialog.byId

Defined in

src/ui/widgets/templatedwidget.ts:10

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

createLI

▸ Private createLI(col): JQuery

Parameters

Name	Type
col	Column<any>

Returns

JQuery

Defined in

src/ui/datagrid/columnpickerdialog.ts:166

---

destroy

▸ destroy(): void

Returns

void

Inherited from

TemplatedDialog.destroy

Defined in

src/ui/dialogs/templateddialog.ts:81

---

dialogClose

▸ dialogClose(): void

Returns

void

Inherited from

TemplatedDialog.dialogClose

Defined in

src/ui/dialogs/templateddialog.ts:350

---

dialogOpen

▸ dialogOpen(asPanel?): void

Parameters

Name	Type
asPanel?	boolean

Returns

void

Inherited from

TemplatedDialog.dialogOpen

Defined in

src/ui/dialogs/templateddialog.ts:244

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

TemplatedDialog.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getDialogButtons

▸ Protected getDialogButtons(): { click: () => void ; text: string }[]

Returns

{ click: () => void ; text: string }[]

Overrides

TemplatedDialog.getDialogButtons

Defined in

src/ui/datagrid/columnpickerdialog.ts:81

---

getDialogOptions

▸ Protected getDialogOptions(): any

Returns

any

Overrides

TemplatedDialog.getDialogOptions

Defined in

src/ui/datagrid/columnpickerdialog.ts:149

---

getDialogTitle

▸ Protected getDialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.getDialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:346

---

getFallbackTemplate

▸ Protected getFallbackTemplate(): string

Returns

string

Inherited from

TemplatedDialog.getFallbackTemplate

Defined in

src/ui/widgets/templatedwidget.ts:79

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

TemplatedDialog.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getModalOptions

▸ Protected getModalOptions(): ModalOptions

Returns

ModalOptions

Inherited from

TemplatedDialog.getModalOptions

Defined in

src/ui/dialogs/templateddialog.ts:153

---

getTemplate

▸ Protected getTemplate(): string

Returns

string

Overrides

TemplatedDialog.getTemplate

Defined in

src/ui/datagrid/columnpickerdialog.ts:271

---

getTemplateName

▸ Protected getTemplateName(): string

Returns

string

Inherited from

TemplatedDialog.getTemplateName

Defined in

src/ui/widgets/templatedwidget.ts:31

---

getTitle

▸ Private getTitle(col): string

Parameters

Name	Type
col	Column<any>

Returns

string

Defined in

src/ui/datagrid/columnpickerdialog.ts:155

---

getToolbarButtons

▸ Protected getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

TemplatedDialog.getToolbarButtons

Defined in

src/ui/dialogs/templateddialog.ts:220

---

getValidatorOptions

▸ Protected getValidatorOptions(): ValidationOptions

Returns

ValidationOptions

Inherited from

TemplatedDialog.getValidatorOptions

Defined in

src/ui/dialogs/templateddialog.ts:224

---

handleResponsive

▸ Protected handleResponsive(): void

Returns

void

Inherited from

TemplatedDialog.handleResponsive

Defined in

src/ui/dialogs/templateddialog.ts:426

---

init

▸ init(action?): ColumnPickerDialog

Parameters

Name	Type
action?	(widget: any) => void

Returns

ColumnPickerDialog

Inherited from

TemplatedDialog.init

Defined in

src/ui/widgets/widget.ts:179

---

initDialog

▸ Protected initDialog(): void

Returns

void

Inherited from

TemplatedDialog.initDialog

Defined in

src/ui/dialogs/templateddialog.ts:104

---

initModal

▸ Protected initModal(): void

Returns

void

Inherited from

TemplatedDialog.initModal

Defined in

src/ui/dialogs/templateddialog.ts:162

---

initTabs

▸ Protected initTabs(): void

Returns

void

Inherited from

TemplatedDialog.initTabs

Defined in

src/ui/dialogs/templateddialog.ts:417

---

initToolbar

▸ Protected initToolbar(): void

Returns

void

Inherited from

TemplatedDialog.initToolbar

Defined in

src/ui/dialogs/templateddialog.ts:203

---

initValidator

▸ Protected initValidator(): void

Returns

void

Inherited from

TemplatedDialog.initValidator

Defined in

src/ui/dialogs/templateddialog.ts:228

---

initialize

▸ initialize(): void

Returns

void

Inherited from

TemplatedDialog.initialize

Defined in

src/ui/widgets/widget.ts:176

---

onDialogClose

▸ Protected onDialogClose(): void

Returns

void

Inherited from

TemplatedDialog.onDialogClose

Defined in

src/ui/dialogs/templateddialog.ts:297

---

onDialogOpen

▸ Protected onDialogOpen(): void

Returns

void

Overrides

TemplatedDialog.onDialogOpen

Defined in

src/ui/datagrid/columnpickerdialog.ts:260

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

TemplatedDialog.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:110

---

resetValidation

▸ Protected resetValidation(): void

Returns

void

Inherited from

TemplatedDialog.resetValidation

Defined in

src/ui/dialogs/templateddialog.ts:236

---

set_dialogTitle

▸ set_dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

TemplatedDialog.set_dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:413

---

setupColumns

▸ Protected setupColumns(): void

Returns

void

Defined in

src/ui/datagrid/columnpickerdialog.ts:182

---

updateListStates

▸ Private updateListStates(): void

Returns

void

Defined in

src/ui/datagrid/columnpickerdialog.ts:177

---

useIdPrefix

▸ Protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedDialog.useIdPrefix

Defined in

src/ui/widgets/templatedwidget.ts:131

---

validateForm

▸ Protected validateForm(): boolean

Returns

boolean

Inherited from

TemplatedDialog.validateForm

Defined in

src/ui/dialogs/templateddialog.ts:240

---

closePanel

▸ Static closePanel(element, e?): void

Parameters

Name	Type
element	JQuery
e?	JQueryEventObject

Returns

void

Inherited from

TemplatedDialog.closePanel

Defined in

src/ui/dialogs/templateddialog.ts:280

---

create

▸ Static create<TWidget, TOpt>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<TOpt, TWidget>
TOpt	TOpt

Parameters

Name	Type
params	CreateWidgetParams<TWidget, TOpt>

Returns

TWidget

Inherited from

TemplatedDialog.create

Defined in

src/ui/widgets/widget.ts:153

---

createToolButton

▸ Static createToolButton(grid): ToolButton

Parameters

Name	Type
grid	IDataGrid

Returns

ToolButton

Defined in

src/ui/datagrid/columnpickerdialog.ts:45

---

elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

Name	Type
editorType	(...args: any[]) => TWidget

Returns

JQuery

Inherited from

TemplatedDialog.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedDialog.getWidgetName

Defined in

src/ui/widgets/widget.ts:124

---

openPanel

▸ Static openPanel(element, uniqueName): void

Parameters

Name	Type
element	JQuery
uniqueName	string

Returns

void

Inherited from

TemplatedDialog.openPanel

Defined in

src/ui/dialogs/templateddialog.ts:276