Class InlineAutocomplete

This class controls the inline-only autocompletion components and their lifecycle. This is more lightweight than the popup-based autocompletion, as it can only work with exact prefix matches. There is an inline ghost text renderer and an optional command bar tooltip inside.

Constructors

constructor

Properties

$index activated base changeTimer commands completionProvider completions editor inlineRenderer inlineTooltip keyboardHandler startCommand

Methods

$open $showCompletion $updatePrefix blurListener changeListener destroy detach getCompletionProvider getData getIndex getInlineRenderer getInlineTooltip getLength goTo insertMatch isOpen setIndex show updateCompletions updateDocTooltip createInlineTooltip for

Constructors

constructor

Properties

$index

$index: number

activated

activated: boolean

base

base: Anchor

changeTimer

changeTimer: {
    schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
    call(): void;
    cancel(): void;
    delay(timeout?): void;
    isPending(): any;
    (timeout?): void;
}

Type declaration

    • (timeout?): void

    • Parameters

      • Optional timeout: number

      Returns void

  • schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; }
  • call:function
  • cancel:function
  • delay:function
    • delay(timeout?): void

    • Parameters

      • Optional timeout: number

      Returns void

  • isPending:function

commands

commands: {
    [key: string]: Ace.Command;
}

Type declaration

  • [key: string]: Ace.Command

completionProvider

completionProvider: CompletionProvider

completions

completions: FilteredList

editor

editor: Editor

inlineRenderer

inlineRenderer: AceInline

inlineTooltip

inlineTooltip: CommandBarTooltip

keyboardHandler

keyboardHandler: HashHandler

Static startCommand

startCommand: {
    bindKey: {
        mac: string;
        win: string;
    };
    exec: ((editor, options) => void);
    name: string;
}

Type declaration

  • bindKey: {
        mac: string;
        win: string;
    }
    • mac: string
    • win: string
  • exec: ((editor, options) => void)
      • (editor, options): void

      • Parameters

        • editor: any
        • options: any

        Returns void

  • name: string

Methods

$open

$showCompletion

$updatePrefix

blurListener

changeListener

destroy

detach

getCompletionProvider

getData

getIndex

getInlineRenderer

getInlineTooltip

getLength

goTo

insertMatch

isOpen

setIndex

show

  • show(options): void

  • This function is the entry point to the class. This triggers the gathering of the autocompletion and displaying the results;

    Parameters

    • options: CompletionOptions

    Returns void

updateCompletions

updateDocTooltip

Static createInlineTooltip

  • createInlineTooltip(parentEl): CommandBarTooltip

  • Factory method to create a command bar tooltip for inline autocomplete.

    Parameters

    • parentEl: HTMLElement

      The parent element where the tooltip HTML elements will be added.

    Returns CommandBarTooltip

    The command bar tooltip for inline autocomplete

Static for

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc