@serenity-is/corelib / Toolbar

Class: Toolbar

Hierarchy

• Widget<ToolbarOptions>

  ↳ Toolbar

Table of contents

Constructors

• constructor

Properties

• element
• idPrefix
• mouseTrap
• options
• uniqueName
• widgetName

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• createButton
• createButtons
• destroy
• findButton
• getCssClass
• getGridField
• init
• initialize
• renderContents
• updateInterface
• create
• elementFor
• getWidgetName

Constructors

constructor

• new Toolbar(div, options)

Parameters

Name	Type
div	JQuery
options	ToolbarOptions

Overrides

Widget.constructor

Defined in

src/ui/widgets/toolbar.ts:89

Properties

element

• element: JQuery

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

mouseTrap

• Protected mouseTrap: any

Defined in

src/ui/widgets/toolbar.ts:114

---

options

• Protected options: ToolbarOptions

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:62

---

uniqueName

• Protected uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

widgetName

• Protected widgetName: string

Inherited from

Widget.widgetName

Defined in

src/ui/widgets/widget.ts:63

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

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

Returns

JQuery

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

createButton

▸ Protected createButton(container, b): void

Parameters

Name	Type
container	JQuery
b	ToolButton

Returns

void

Defined in

src/ui/widgets/toolbar.ts:131

---

createButtons

▸ Protected createButtons(): void

Returns

void

Defined in

src/ui/widgets/toolbar.ts:116

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/widgets/toolbar.ts:99

---

findButton

▸ findButton(className): JQuery

Parameters

Name	Type
className	string

Returns

JQuery

Defined in

src/ui/widgets/toolbar.ts:212

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

init

▸ init(action?): Toolbar

Parameters

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

Returns

Toolbar

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:179

---

initialize

▸ initialize(): void

Returns

void

Inherited from

Widget.initialize

Defined in

src/ui/widgets/widget.ts:176

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

updateInterface

▸ updateInterface(): void

Returns

void

Defined in

src/ui/widgets/toolbar.ts:219

---

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

Widget.create

Defined in

src/ui/widgets/widget.ts:153

---

elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

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

Returns

JQuery

Inherited from

Widget.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124