Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEditorViewer<T>

Interface for a text editor viewer to register itself with the text editor extension points.

Type parameters

  • T: Widget

Hierarchy

Index

Properties

Optional isEnabled

isEnabled: (widget: T) => boolean

An additional function that determines whether the extender is enabled. By default it is considered enabled if the application active widget is contained in the tracker. If this is also provided, the criterion is equivalent to tracker.has(widget) && extender.isEnabled(widget)

Type declaration

    • (widget: T): boolean
    • Parameters

      • widget: T

      Returns boolean

Optional lineNumbersToggled

lineNumbersToggled: (widget: T) => boolean

Whether line numbers are toggled.

Type declaration

    • (widget: T): boolean
    • Parameters

      • widget: T

      Returns boolean

Optional matchBracketsToggled

matchBracketsToggled: (widget: T) => boolean

Whether match brackets is toggled.

Type declaration

    • (widget: T): boolean
    • Parameters

      • widget: T

      Returns boolean

Optional toggleLineNumbers

toggleLineNumbers: (widget: T) => void

Whether to show line numbers in the editor.

Type declaration

    • (widget: T): void
    • Parameters

      • widget: T

      Returns void

Optional toggleMatchBrackets

toggleMatchBrackets: (widget: T) => void

Whether to match brackets in the editor.

Type declaration

    • (widget: T): void
    • Parameters

      • widget: T

      Returns void

Optional toggleWordWrap

toggleWordWrap: (widget: T) => void

Whether to word-wrap the editor.

Type declaration

    • (widget: T): void
    • Parameters

      • widget: T

      Returns void

tracker

tracker: IWidgetTracker<T>

A widget tracker for identifying the appropriate extender.

Optional wordWrapToggled

wordWrapToggled: (widget: T) => boolean

Whether word wrap is toggled.

Type declaration

    • (widget: T): boolean
    • Parameters

      • widget: T

      Returns boolean

Generated using TypeDoc