Class AbstractButton`Abstract`

Base class for navbar buttons

Hierarchy

AbstractComponent
- AbstractButton

Index

Constructors

Properties

config container parent state viewer groupId? id

Accessors

collapsable content id title width

Methods

collapse destroy disable enable hide isSupported isVisible onClick show toggle toggleActive uncollapse

Constructors

constructor

new AbstractButton(navbar, config): AbstractButton
Parameters
- navbar: Navbar
- config: ButtonConfig
Returns AbstractButton
Overrides AbstractComponent.constructor
- Defined in packages/core/src/buttons/AbstractButton.ts:98

Properties

`Protected` `Readonly` config

config: ButtonConfig

`Readonly` container

container: HTMLDivElement = ...

Container element

`Protected` `Readonly` parent

parent: Viewer | AbstractComponent

`Protected` `Readonly` state

state: {
    active: boolean;
    collapsed: boolean;
    enabled: boolean;
    supported: boolean;
    visible: boolean;
    width: number;
} = ...

Internal properties

Type declaration

active: boolean
collapsed: boolean
enabled: boolean
supported: boolean
visible: boolean
width: number

`Protected` `Readonly` viewer

viewer: Viewer

Reference to main controller

`Static` `Optional` `Readonly` groupId

groupId?: string

Identifier to declare a group of buttons

`Static` `Readonly` id

id: string

Unique identifier of the button

Accessors

collapsable

get collapsable(): boolean
Returns boolean
- Defined in packages/core/src/buttons/AbstractButton.ts:94

content

get content(): string
Returns string
- Defined in packages/core/src/buttons/AbstractButton.ts:86

id

get id(): string
Returns string
- Defined in packages/core/src/buttons/AbstractButton.ts:78

title

get title(): string
Returns string
- Defined in packages/core/src/buttons/AbstractButton.ts:82

width

get width(): number
Returns number
- Defined in packages/core/src/buttons/AbstractButton.ts:90

Methods

collapse

collapse(): void
Collapses the button in the navbar menu

Returns void
- Defined in packages/core/src/buttons/AbstractButton.ts:230

destroy

destroy(): void
Destroys the component

Returns void
Inherited from AbstractComponent.destroy
- Defined in packages/core/src/components/AbstractComponent.ts:46

disable

disable(): void
Disables the button

Returns void
- Defined in packages/core/src/buttons/AbstractButton.ts:214

enable

enable(): void
Enables the button

Returns void
- Defined in packages/core/src/buttons/AbstractButton.ts:222

hide

hide(refresh?): void
Hides the component
Parameters
- refresh: boolean = true
Returns void
Overrides AbstractComponent.hide
- Defined in packages/core/src/buttons/AbstractButton.ts:154

isSupported

isSupported(): boolean | ResolvableBoolean
Checks if the button can be displayed

Returns boolean | ResolvableBoolean
- Defined in packages/core/src/buttons/AbstractButton.ts:193

isVisible

isVisible(): boolean
Checks if the component is visible

Returns boolean
Inherited from AbstractComponent.isVisible
- Defined in packages/core/src/components/AbstractComponent.ts:92

`Abstract` onClick

onClick(): void
Action when the button is clicked

Returns void
- Defined in packages/core/src/buttons/AbstractButton.ts:140

show

show(refresh?): void
Displays the component
Parameters
- refresh: boolean = true
Returns void
Overrides AbstractComponent.show
- Defined in packages/core/src/buttons/AbstractButton.ts:142

toggle

toggle(visible?): void
Displays or hides the component
Parameters
- visible: boolean = !this.isVisible()
Returns void
Inherited from AbstractComponent.toggle
- Defined in packages/core/src/components/AbstractComponent.ts:61

toggleActive

toggleActive(active?): void
Changes the active state of the button
Parameters
- active: boolean = !this.state.active
Returns void
- Defined in packages/core/src/buttons/AbstractButton.ts:200

uncollapse

uncollapse(): void
Uncollapses the button from the navbar menu

Returns void
- Defined in packages/core/src/buttons/AbstractButton.ts:238

Generated using TypeDoc