@serenity-is/corelib / PopupToolButton

Class: PopupToolButton

Hierarchy

• PopupMenuButton

  ↳ PopupToolButton

Table of contents

Constructors

• constructor

Properties

• element
• idPrefix
• options
• uniqueName
• widgetName

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• destroy
• getCssClass
• getGridField
• init
• initialize
• renderContents
• create
• elementFor
• getWidgetName

Constructors

constructor

• new PopupToolButton(div, opt)

Parameters

Name	Type
div	JQuery
opt	PopupToolButtonOptions

Overrides

PopupMenuButton.constructor

Defined in

src/ui/widgets/toolbar.ts:74

Properties

element

• element: JQuery

Inherited from

PopupMenuButton.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

PopupMenuButton.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

options

• Protected options: PopupMenuButtonOptions

Inherited from

PopupMenuButton.options

Defined in

src/ui/widgets/widget.ts:62

---

uniqueName

• Protected uniqueName: string

Inherited from

PopupMenuButton.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

widgetName

• Protected widgetName: string

Inherited from

PopupMenuButton.widgetName

Defined in

src/ui/widgets/widget.ts:63

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

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

PopupMenuButton.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

PopupMenuButton.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

PopupMenuButton.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

PopupMenuButton.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

PopupMenuButton.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

destroy

▸ destroy(): void

Returns

void

Inherited from

PopupMenuButton.destroy

Defined in

src/ui/widgets/toolbar.ts:58

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

PopupMenuButton.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

PopupMenuButton.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

init

▸ init(action?): PopupToolButton

Parameters

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

Returns

PopupToolButton

Inherited from

PopupMenuButton.init

Defined in

src/ui/widgets/widget.ts:179

---

initialize

▸ initialize(): void

Returns

void

Inherited from

PopupMenuButton.initialize

Defined in

src/ui/widgets/widget.ts:176

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

PopupMenuButton.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

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

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

PopupMenuButton.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

PopupMenuButton.getWidgetName

Defined in

src/ui/widgets/widget.ts:124