Class ObservableString

A concrete implementation of IObservableString

Hierarchy

ObservableString

Implements

IObservableString

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ObservableString(initialText?: string): ObservableString

- Defined in observablestring.ts:120
Construct a new observable string.

Parameters
- Default value initialText: string = ""
Returns ObservableString

Properties

Private _changed

_changed: Signal<this, IChangedArgs> = new Signal<this, IObservableString.IChangedArgs>(this)

Private _isDisposed

_isDisposed: boolean = false

Private _text

_text: string = ""

Accessors

changed

get changed(): ISignal<this, IChangedArgs>

- Defined in observablestring.ts:138
A signal emitted when the string has changed.

Returns ISignal<this, IChangedArgs>

isDisposed

get isDisposed(): boolean

- Defined in observablestring.ts:210
Test whether the string has been disposed.

Returns boolean

text

get text(): string
set text(value: string): void

- Defined in observablestring.ts:161
Get the value of the string.

Returns string
- Defined in observablestring.ts:145
Set the value of the string.

Parameters
- value: string
Returns void

type

get type(): "String"

- Defined in observablestring.ts:131
The type of the Observable.

Returns "String"

Methods

clear

clear(): void

- Defined in observablestring.ts:203
Set the ObservableString to an empty string.

Returns void

dispose

dispose(): void

- Defined in observablestring.ts:217
Dispose of the resources held by the string.

Returns void

insert

insert(index: number, text: string): void

- Defined in observablestring.ts:172
Insert a substring.

Parameters
- index: number
  
  The starting index.
- text: string
  
  The substring to insert.
Returns void

remove

remove(start: number, end: number): void

- Defined in observablestring.ts:189
Remove a substring.

Parameters
- start: number
  
  The starting index.
- end: number
  
  The ending index.
Returns void

Generated using TypeDoc