Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Title<T>

An object which holds data related to an object's title. The namespace for the Title class statics.

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

  • T

Hierarchy

  • Title

Implements

  • IDisposable

Index

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static Dataset

Dataset: object

A type alias for a simple immutable string dataset.

Type declaration

  • [key: string]: string

Constructors

constructor

Properties

Private _caption

_caption: string = ""

Private _changed

_changed: Signal<this, void> = new Signal<this, void>(this)

Private _className

_className: string = ""

Private _closable

_closable: boolean = false

Private _dataset

_dataset: Dataset

Private _icon

_icon: VirtualElement.IRenderer | undefined | null

Private _iconClass

_iconClass: string = ""

Private _iconLabel

_iconLabel: string = ""

Private _isDisposed

_isDisposed: boolean = false

Private _label

_label: string = ""

Private _mnemonic

_mnemonic: number = -1

owner

owner: T

The object which owns the title.

Accessors

caption

  • get caption(): string
  • set caption(value: string): void

changed

  • get changed(): ISignal<this, void>

  • A signal emitted when the state of the title changes.

    Returns ISignal<this, void>

className

  • get className(): string
  • set className(value: string): void

  • Get the extra class name for the title.

    Notes

    The default value is an empty string.

    Returns string

  • Set the extra class name for the title.

    Notes

    Multiple class names can be separated with whitespace.

    Parameters

    • value: string

    Returns void

closable

  • get closable(): boolean
  • set closable(value: boolean): void

dataset

icon

  • get icon(): VirtualElement.IRenderer | undefined | string
  • set icon(value: VirtualElement.IRenderer | undefined | string): void

  • Get the icon renderer for the title.

    Notes

    The default value is undefined.

    DEPRECATED: if set to a string value, the .icon field will function as an alias for the .iconClass field, for backwards compatibility

    Returns VirtualElement.IRenderer | undefined | string

  • Set the icon renderer for the title.

    Notes

    A renderer is an object that supplies a render and unrender function.

    DEPRECATED: if set to a string value, the .icon field will function as an alias for the .iconClass field, for backwards compatibility

    Parameters

    • value: VirtualElement.IRenderer | undefined | string

    Returns void

iconClass

  • get iconClass(): string
  • set iconClass(value: string): void

iconLabel

  • get iconLabel(): string
  • set iconLabel(value: string): void

iconRenderer

  • get iconRenderer(): VirtualElement.IRenderer | undefined
  • set iconRenderer(value: VirtualElement.IRenderer | undefined): void
  • deprecated

    Use icon instead.

    Returns VirtualElement.IRenderer | undefined

  • deprecated

    Use icon instead.

    Parameters

    • value: VirtualElement.IRenderer | undefined

    Returns void

isDisposed

  • get isDisposed(): boolean

label

  • get label(): string
  • set label(value: string): void

mnemonic

  • get mnemonic(): number
  • set mnemonic(value: number): void

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

Generated using TypeDoc