Class Title<T>

An object which holds data related to an object's title.

Notes

A title object is intended to hold the data necessary to display a header for a particular object. A common example is the TabPanel, which uses the widget title to populate the tab for a child widget.

It is the responsibility of the owner to call the title disposal.

Type Parameters

Implements

IDisposable

Index

Constructors

constructor

new Title<T>(options): Title<T>
Construct a new title.
Type Parameters
- T
Parameters
- options: Title.IOptions<T>
  The options for initializing the title.
Returns Title<T>
- Defined in widgets/src/title.ts:32

Properties

`Private` _caption

_caption: string = ''

`Private` _changed

_changed: Signal<Title<T>, void> = ...

`Private` _className

_className: string = ''

`Private` _closable

_closable: boolean = false

`Private` _dataset

_dataset: Title.Dataset

`Private` _icon

_icon: undefined | VirtualElement.IRenderer = undefined

`Private` _iconClass

_iconClass: string = ''

`Private` _iconLabel

_iconLabel: string = ''

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _label

_label: string = ''

`Private` _mnemonic

_mnemonic: number = -1

`Readonly` owner

owner: T

The object which owns the title.

Accessors

caption

get caption(): string
Get the caption for the title.

Notes
The default value is an empty string.

Returns string
- Defined in widgets/src/title.ts:194
set caption(value): void
Set the caption for the title.
Parameters
- value: string
Returns void
- Defined in widgets/src/title.ts:201

changed

get changed(): ISignal<this, void>
A signal emitted when the state of the title changes.

Returns ISignal<this, void>
- Defined in widgets/src/title.ts:65

className

get className(): string
Get the extra class name for the title.

Notes
The default value is an empty string.

Returns string
- Defined in widgets/src/title.ts:215
set className(value): void
Set the extra class name for the title.

Notes
Multiple class names can be separated with whitespace.
Parameters
- value: string
Returns void
- Defined in widgets/src/title.ts:225

closable

get closable(): boolean
Get the closable state for the title.

Notes
The default value is false.

Returns boolean
- Defined in widgets/src/title.ts:239
set closable(value): void
Set the closable state for the title.

Notes
This controls the presence of a close icon when applicable.
Parameters
- value: boolean
Returns void
- Defined in widgets/src/title.ts:249

dataset

get dataset(): Title.Dataset
Get the dataset for the title.

Notes
The default value is an empty dataset.

Returns Title.Dataset
- Defined in widgets/src/title.ts:263
set dataset(value): void
Set the dataset for the title.

Notes
This controls the data attributes when applicable.
Parameters
- value: Title.Dataset
Returns void
- Defined in widgets/src/title.ts:273

icon

get icon(): undefined | VirtualElement.IRenderer
Get the icon renderer for the title.

Notes
The default value is undefined.

Returns undefined | VirtualElement.IRenderer
- Defined in widgets/src/title.ts:122
set icon(value): void
Set the icon renderer for the title.

Notes
A renderer is an object that supplies a render and unrender function.
Parameters
- value: undefined | VirtualElement.IRenderer
Returns void
- Defined in widgets/src/title.ts:132

iconClass

get iconClass(): string
Get the icon class name for the title.

Notes
The default value is an empty string.

Returns string
- Defined in widgets/src/title.ts:146
set iconClass(value): void
Set the icon class name for the title.

Notes
Multiple class names can be separated with whitespace.
Parameters
- value: string
Returns void
- Defined in widgets/src/title.ts:156

iconLabel

get iconLabel(): string
Get the icon label for the title.

Notes
The default value is an empty string.

Returns string
- Defined in widgets/src/title.ts:170
set iconLabel(value): void
Set the icon label for the title.

Notes
Multiple class names can be separated with whitespace.
Parameters
- value: string
Returns void
- Defined in widgets/src/title.ts:180

isDisposed

get isDisposed(): boolean
Test whether the title has been disposed.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in widgets/src/title.ts:284

label

get label(): string
Get the label for the title.

Notes
The default value is an empty string.

Returns string
- Defined in widgets/src/title.ts:80
set label(value): void
Set the label for the title.
Parameters
- value: string
Returns void
- Defined in widgets/src/title.ts:87

mnemonic

get mnemonic(): number
Get the mnemonic index for the title.

Notes
The default value is -1.

Returns number
- Defined in widgets/src/title.ts:101
set mnemonic(value): void
Set the mnemonic index for the title.
Parameters
- value: number
Returns void
- Defined in widgets/src/title.ts:108

Methods

dispose

dispose(): void
Dispose of the resources held by the title.

Notes
It is the responsibility of the owner to call the title disposal.

Returns void
Implementation of IDisposable.dispose
- Defined in widgets/src/title.ts:294

Class Title<T>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Title<T>

Properties

Private _caption

Private _changed

Private _className

Private _closable

Private _dataset

Private _icon

Private _iconClass

Private _iconLabel

Private _isDisposed

Private _label

Private _mnemonic

Readonly owner

Accessors

caption

Returns string

Parameters

Returns void

changed

Returns ISignal<this, void>

className

Returns string

Parameters

Returns void

closable

Returns boolean

Parameters

Returns void

dataset

Returns Title.Dataset

Parameters

Returns void

icon

Returns undefined | VirtualElement.IRenderer

Parameters

Returns void

iconClass

Returns string

Parameters

Returns void

iconLabel

Returns string

Parameters

Returns void

isDisposed

Returns boolean

label

Returns string

Parameters

Returns void

mnemonic

Returns number

Parameters

Returns void

Methods

dispose

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` _caption

`Private` _changed

`Private` _className

`Private` _closable

`Private` _dataset

`Private` _icon

`Private` _iconClass

`Private` _iconLabel

`Private` _isDisposed

`Private` _label

`Private` _mnemonic

`Readonly` owner