Interface Events

IListener for IProtectedRange events.

interface Events {
    onAnchorCoordsChange?(source: IProtectedRange, prev: Coords): void;
    onAnyChange?(source: IProtectedRange): void;
    onClose?(source: IProtectedRange): void;
    onConfigChange?(source: IProtectedRange): void;
    onDelete?(source: IProtectedRange): void;
    onInvalidated?(source: IProtectedRange): void;
    onProtectedChange?(source: IProtectedRange): void;
    onUnlockChange?(source: IProtectedRange): void;
}

Hierarchy (View Summary)

IAnchored.Events<IProtectedRange>
- Events

Index

Methods

onAnchorCoordsChange? onAnyChange? onClose? onConfigChange? onDelete? onInvalidated? onProtectedChange? onUnlockChange?

Methods

`Optional`onAnchorCoordsChange

onAnchorCoordsChange?(source: IProtectedRange, prev: Coords): void
Called when the anchor bounds are updated.
Parameters
- source: IProtectedRange
- prev: Coords
Returns void

Inherited from Events.onAnchorCoordsChange

`Optional`onAnyChange

onAnyChange?(source: IProtectedRange): void
Called when the state has been updated for any reason.
Parameters
- source: IProtectedRange
Returns void

Inherited from Events.onAnyChange

`Optional`onClose

onClose?(source: IProtectedRange): void
Called when the anchor transaction is closed.
Parameters
- source: IProtectedRange
Returns void

Inherited from Events.onClose

`Optional`onConfigChange

onConfigChange?(source: IProtectedRange): void
Called when the name, descriptor or password changes.
Parameters
- source: IProtectedRange
Returns void

`Optional`onDelete

onDelete?(source: IProtectedRange): void
Called when the anchor is removed.
Parameters
- source: IProtectedRange
Returns void

Inherited from Events.onDelete

`Optional`onInvalidated

onInvalidated?(source: IProtectedRange): void
Called when the state has been updated due to a undo/redo and a rerender is required.
Parameters
- source: IProtectedRange
Returns void

Inherited from Events.onInvalidated

`Optional`onProtectedChange

onProtectedChange?(source: IProtectedRange): void
Called when the anchor protection is updated.
Parameters
- source: IProtectedRange
Returns void

Inherited from Events.onProtectedChange

`Optional`onUnlockChange

onUnlockChange?(source: IProtectedRange): void
Called when session edit access changes.
Parameters
- source: IProtectedRange
Returns void

See
IProtectedRange.isUnlocked