Class InspectionHandler

An object that handles code inspection.

Implements

Index

Constructors

Properties

_cleared _connector _debouncer _disposed _editor _inspected _isDisposed _lastInspectedReply _pending _rendermime _standby

Accessors

cleared disposed editor inspected isDisposed standby

Methods

_onChange dispose onEditorChange

Constructors

constructor

new InspectionHandler(options): InspectionHandler
Construct a new inspection handler for a widget.
Parameters
- options: InspectionHandler.IOptions
Returns InspectionHandler
- Defined in packages/inspector/src/handler.ts:21

Properties

`Private` _cleared

_cleared: Signal<InspectionHandler, void> = ...

`Private` _connector

_connector: IDataConnector<IReply, void, InspectionHandler.IRequest, string>

`Private` _debouncer

_debouncer: Debouncer<any, any, any[]>

`Private` _disposed

_disposed: Signal<InspectionHandler, void> = ...

`Private` _editor

_editor: null | CodeEditor.IEditor = null

`Private` _inspected

_inspected: Signal<InspectionHandler, IInspectorUpdate> = ...

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _lastInspectedReply

_lastInspectedReply: null | ReadonlyJSONObject = null

`Private` _pending

_pending: number = 0

`Private` _rendermime

_rendermime: IRenderMimeRegistry

`Private` _standby

_standby: boolean = true

Accessors

cleared

get cleared(): ISignal<InspectionHandler, void>
A signal emitted when the inspector should clear all items.

Returns ISignal<InspectionHandler, void>
Implementation of IInspectable.cleared
- Defined in packages/inspector/src/handler.ts:30

disposed

get disposed(): ISignal<InspectionHandler, void>
A signal emitted when the handler is disposed.

Returns ISignal<InspectionHandler, void>
Implementation of IInspectable.disposed
- Defined in packages/inspector/src/handler.ts:37

editor

get editor(): null | CodeEditor.IEditor
The editor widget used by the inspection handler.

Returns null | CodeEditor.IEditor
- Defined in packages/inspector/src/handler.ts:51
set editor(newValue): void
Parameters
- newValue: null | CodeEditor.IEditor
Returns void
- Defined in packages/inspector/src/handler.ts:54

inspected

get inspected(): ISignal<InspectionHandler, IInspectorUpdate>
A signal emitted when an inspector value is generated.

Returns ISignal<InspectionHandler, IInspectorUpdate>
Implementation of IInspectable.inspected
- Defined in packages/inspector/src/handler.ts:44

isDisposed

get isDisposed(): boolean
Get whether the inspection handler is disposed.

Notes
This is a read-only property.

Returns boolean
Implementation of IInspectable.isDisposed
- Defined in packages/inspector/src/handler.ts:93

standby

get standby(): boolean
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
Implementation of IInspectable.standby
- Defined in packages/inspector/src/handler.ts:80
set standby(value): void
Indicates whether the inspectable source emits signals.

Notes
The use case for this attribute is to limit the API traffic when no inspector is visible. It can be modified by the consumer of the source.
Parameters
- value: boolean
Returns void
Implementation of IInspectable.standby
- Defined in packages/inspector/src/handler.ts:83

Methods

`Private` _onChange

_onChange(): void
Handle changes to the editor state, debouncing.

Returns void
- Defined in packages/inspector/src/handler.ts:176

dispose

dispose(): void
Dispose of the resources used by the handler.

Returns void
Implementation of IDisposable.dispose
- Defined in packages/inspector/src/handler.ts:100

onEditorChange

onEditorChange(customText?): void
Handle a text changed signal from an editor.

Notes
Update the hints inspector based on a text change.
Parameters
- Optional customText: string
Returns void
Implementation of IInspectable.onEditorChange
- Defined in packages/inspector/src/handler.ts:116