Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonacoOutlineContribution

Hierarchy

  • MonacoOutlineContribution

Implements

  • FrontendApplicationContribution

Index

Constructors

constructor

Properties

Protected canUpdateOutline

canUpdateOutline: boolean = true

Protected Readonly editorManager

editorManager: EditorManager

Protected Readonly outlineViewService

outlineViewService: OutlineViewService

Protected roots

Protected Readonly toDisposeOnEditor

toDisposeOnEditor: DisposableCollection = ...

Protected tokenSource

tokenSource: CancellationTokenSource = ...

Methods

Protected applySelection

Protected asRange

  • asRange(range: IRange): Range

Protected createId

  • createId(name: string, ids: Map<string, number>): string

Protected createNode

Protected createNodes

Protected createRoots

Protected getDetail

  • getDetail(symbol: DocumentSymbol): string

Protected getFullRange

  • 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

Protected getName

  • getName(symbol: DocumentSymbol): string

Protected getNameRange

  • getNameRange(documentSymbol: DocumentSymbol): Range

Protected handleCurrentEditorChanged

  • handleCurrentEditorChanged(): void

onStart

  • onStart(app: FrontendApplication): void

Protected orderByPosition

  • orderByPosition(symbol: DocumentSymbol, symbol2: DocumentSymbol): number

Protected parentContains

  • 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

Protected selectInEditor

Protected shouldExpand

  • shouldExpand(symbol: DocumentSymbol): boolean

Protected updateOutline

  • updateOutline(editorSelection?: Range): Promise<void>