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.IOptions<T>): 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 node_modules/@lumino/widgets/types/title.d.ts:20

Properties

`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 node_modules/@lumino/widgets/types/title.d.ts:99
set caption(value: string): void
Set the caption for the title.
Parameters
- value: string
Returns void
- Defined in node_modules/@lumino/widgets/types/title.d.ts:103

changed

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

Returns ISignal<this, void>
- Defined in node_modules/@lumino/widgets/types/title.d.ts:24

className

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

Notes
The default value is an empty string.

Returns string
- Defined in node_modules/@lumino/widgets/types/title.d.ts:110
set className(value: string): 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 node_modules/@lumino/widgets/types/title.d.ts:117

closable

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

Notes
The default value is false.

Returns boolean
- Defined in node_modules/@lumino/widgets/types/title.d.ts:124
set closable(value: boolean): 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 node_modules/@lumino/widgets/types/title.d.ts:131

dataset

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

Notes
The default value is an empty dataset.

Returns Dataset
- Defined in node_modules/@lumino/widgets/types/title.d.ts:138
set dataset(value: Dataset): void
Set the dataset for the title.

Notes
This controls the data attributes when applicable.
Parameters
- value: Dataset
Returns void
- Defined in node_modules/@lumino/widgets/types/title.d.ts:145

icon

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

Notes
The default value is undefined.

Returns undefined | IRenderer
- Defined in node_modules/@lumino/widgets/types/title.d.ts:57
set icon(value: undefined | IRenderer): void
Set the icon renderer for the title.

Notes
A renderer is an object that supplies a render and unrender function.
Parameters
- value: undefined | IRenderer
Returns void
- Defined in node_modules/@lumino/widgets/types/title.d.ts:64

iconClass

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

Notes
The default value is an empty string.

Returns string
- Defined in node_modules/@lumino/widgets/types/title.d.ts:71
set iconClass(value: string): 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 node_modules/@lumino/widgets/types/title.d.ts:78

iconLabel

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

Notes
The default value is an empty string.

Returns string
- Defined in node_modules/@lumino/widgets/types/title.d.ts:85
set iconLabel(value: string): void
Set the icon label for the title.

Notes
Multiple class names can be separated with whitespace.
Parameters
- value: string
Returns void
- Defined in node_modules/@lumino/widgets/types/title.d.ts:92

isDisposed

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

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in node_modules/@lumino/widgets/types/title.d.ts:149

label

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

Notes
The default value is an empty string.

Returns string
- Defined in node_modules/@lumino/widgets/types/title.d.ts:35
set label(value: string): void
Set the label for the title.
Parameters
- value: string
Returns void
- Defined in node_modules/@lumino/widgets/types/title.d.ts:39

mnemonic

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

Notes
The default value is -1.

Returns number
- Defined in node_modules/@lumino/widgets/types/title.d.ts:46
set mnemonic(value: number): void
Set the mnemonic index for the title.
Parameters
- value: number
Returns void
- Defined in node_modules/@lumino/widgets/types/title.d.ts:50

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 node_modules/@lumino/widgets/types/title.d.ts:156

Class Title<T>

Notes

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Title<T>

Properties

Readonlyowner

Accessors

caption

Notes

Returns string

Parameters

Returns void

changed

Returns ISignal<this, void>

className

Notes

Returns string

Notes

Parameters

Returns void

closable

Notes

Returns boolean

Notes

Parameters

Returns void

dataset

Notes

Returns Dataset

Notes

Parameters

Returns void

icon

Notes

Returns undefined | IRenderer

Notes

Parameters

Returns void

iconClass

Notes

Returns string

Notes

Parameters

Returns void

iconLabel

Notes

Returns string

Notes

Parameters

Returns void

isDisposed

Returns boolean

label

Notes

Returns string

Parameters

Returns void

mnemonic

Notes

Returns number

Parameters

Returns void

Methods

dispose

Notes

Returns void

Settings

On This Page

`Readonly`owner