Previous Page Next Page

@serenity-is/corelib / Toolbar

Class: Toolbar<P>

Type parameters

Name Type
P extends ToolbarOptions = ToolbarOptions

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new Toolbar<P>(props): Toolbar<P>

Type parameters

Name Type
P extends ToolbarOptions = ToolbarOptions

Parameters

Name Type
props WidgetProps<P>

Returns

Toolbar<P>

Inherited from

Widget.constructor

Defined in

src/ui/widgets/widget.ts:20

Properties

domNode

• Readonly domNode: HTMLElement

Inherited from

Widget.domNode

Defined in

src/ui/widgets/widget.ts:18

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:17

mouseTrap

• Protected mouseTrap: any

Defined in

src/ui/widgets/toolbar.ts:129

options

• Protected Readonly options: WidgetProps<P>

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:15

uniqueName

• Protected Readonly uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:16

typeInfo

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

Inherited from

Widget.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:67

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

Widget.props

Defined in

src/ui/widgets/widget.ts:182

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:71

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

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

Returns

void

Inherited from

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

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

change

▸ change(handler): void

Parameters

Name Type
handler (e: Event) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:114

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name Type
handler (e: Event) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

createButton

▸ createButton(container, tb): void

Parameters

Name Type
container Fluent<HTMLElement>
tb ToolButton

Returns

void

Defined in

src/ui/widgets/toolbar.ts:131

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/widgets/toolbar.ts:114

findButton

▸ findButton(className): Fluent<HTMLElement>

Parameters

Name Type
className string

Returns

Fluent<HTMLElement>

Defined in

src/ui/widgets/toolbar.ts:153

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

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

Widget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:110

init

▸ init(): this

Returns

this

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:146

internalInit

▸ internalInit(): void

Returns

void

Inherited from

Widget.internalInit

Defined in

src/ui/widgets/widget.ts:142

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

Widget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

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

Widget.render

Defined in

src/ui/widgets/widget.ts:159

renderContents

▸ renderContents(): HTMLDivElement

Returns

HTMLDivElement

Overrides

Widget.renderContents

Defined in

src/ui/widgets/toolbar.ts:89

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

Widget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

updateInterface

▸ updateInterface(): void

Returns

void

Defined in

src/ui/widgets/toolbar.ts:161

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

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

Widget.create

Defined in

src/ui/widgets/widget.ts:126

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

getWidgetName

▸ getWidgetName(type): string

Parameters

Name Type
type Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95