Class InspectionHandler

An object that handles code inspection.

Hierarchy

InspectionHandler

Implements

IDisposable
IInspectable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new InspectionHandler(options: IOptions): InspectionHandler

- Defined in packages/inspector/src/handler.ts:25
Construct a new inspection handler for a widget.

Parameters
- options: IOptions
Returns InspectionHandler

Properties

Private _cleared

_cleared: Signal = new Signal<InspectionHandler, void>(this)

Private _connector

_connector: IDataConnector<IReply, void, IRequest>

Private _debouncer

_debouncer: Debouncer

Private _disposed

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

Private _editor

_editor: CodeEditor.IEditor | null = null

Private _inspected

_inspected: Signal = new Signal<this, IInspector.IInspectorUpdate>(this)

Private _isDisposed

_isDisposed: boolean = false

Private _pending

_pending: number = 0

Private _rendermime

_rendermime: IRenderMimeRegistry

Private _standby

_standby: boolean = true

Accessors

cleared

get cleared(): ISignal<InspectionHandler, void>

- Defined in packages/inspector/src/handler.ts:38
A signal emitted when the inspector should clear all items.

Returns ISignal<InspectionHandler, void>

disposed

get disposed(): ISignal<InspectionHandler, void>

- Defined in packages/inspector/src/handler.ts:45
A signal emitted when the handler is disposed.

Returns ISignal<InspectionHandler, void>

editor

get editor(): CodeEditor.IEditor | null
set editor(newValue: CodeEditor.IEditor | null): void

- Defined in packages/inspector/src/handler.ts:59
The editor widget used by the inspection handler.

Returns CodeEditor.IEditor | null
- Defined in packages/inspector/src/handler.ts:62
The editor widget used by the inspection handler.

Parameters
- newValue: CodeEditor.IEditor | null
Returns void

inspected

get inspected(): ISignal<InspectionHandler, IInspectorUpdate>

- Defined in packages/inspector/src/handler.ts:52
A signal emitted when an inspector value is generated.

Returns ISignal<InspectionHandler, IInspectorUpdate>

isDisposed

get isDisposed(): boolean

- Defined in packages/inspector/src/handler.ts:101
Get whether the inspection handler is disposed.

Notes

This is a read-only property.

Returns boolean

standby

get standby(): boolean
set standby(value: boolean): void

- Defined in packages/inspector/src/handler.ts:88
Indicates whether the handler makes API inspection requests or stands by.

Notes

The use case for this attribute is to limit the API traffic when no inspector is visible.

Returns boolean
- Defined in packages/inspector/src/handler.ts:91
Indicates whether the handler makes API inspection requests or stands by.

Notes

The use case for this attribute is to limit the API traffic when no inspector is visible.

Parameters
- value: boolean
Returns void

Methods

Private _onChange

_onChange(): void

- Defined in packages/inspector/src/handler.ts:173
Handle changes to the editor state, debouncing.

Returns void

dispose

dispose(): void

- Defined in packages/inspector/src/handler.ts:108
Dispose of the resources used by the handler.

Returns void

Protected onEditorChange

onEditorChange(): void

- Defined in packages/inspector/src/handler.ts:123
Handle a text changed signal from an editor.

Notes

Update the hints inspector based on a text change.

Returns void

Generated using TypeDoc