Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonacoOutlineContribution

Hierarchy

  • MonacoOutlineContribution

Implements

  • FrontendApplicationContribution

Index

Constructors

Properties

canUpdateOutline: boolean = true
editorManager: EditorManager
outlineViewService: OutlineViewService
toDisposeOnEditor: DisposableCollection = ...
tokenSource: CancellationTokenSource = ...

Methods

  • asRange(range: IRange): Range
  • createId(name: string, ids: Map<string, number>): string
  • getDetail(symbol: DocumentSymbol): string
  • getFullRange(documentSymbol: DocumentSymbol): Range
  • Returns with a range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI. This allows to obtain the range including the associated comments.

    See: DocumentSymbol#range for more details.

    Parameters

    • documentSymbol: DocumentSymbol

    Returns Range

  • getName(symbol: DocumentSymbol): string
  • getNameRange(documentSymbol: DocumentSymbol): Range
  • handleCurrentEditorChanged(): void
  • onStart(app: FrontendApplication): void
  • orderByPosition(symbol: DocumentSymbol, symbol2: DocumentSymbol): number
  • parentContains(candidate: Range | DocumentSymbol, parent: Range | DocumentSymbol, rangeBased: boolean): boolean
  • Returns true if candidate is strictly contained inside parent

    If the argument is a DocumentSymbol, then getFullRange will be used to retrieve the range of the underlying symbol.

    Parameters

    • candidate: Range | DocumentSymbol
    • parent: Range | DocumentSymbol
    • rangeBased: boolean

    Returns boolean

  • shouldExpand(symbol: DocumentSymbol): boolean
  • updateOutline(editorSelection?: Range): Promise<void>