Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExtMonacoEditorBase<TCfg>

Type parameters

Hierarchy

Index

Properties

cfg

cfg: TCfg

The widget-specific configuration of this widget instance.

id

id: string

jq

jq: JQuery

A reference to the base (container) element of this widget.

jqEl

jqEl: HTMLElement

A reference to the base (container) element of this widget.

jqId

jqId: string

widgetVar

widgetVar: string

The widget variable of this widget instance.

Methods

callBehavior

  • callBehavior(name: string, ...args: unknown[]): void
  • If it exists, calls the behavior with the given name.

    Parameters

    • name: string

      Name of the behavior.

    • Rest ...args: unknown[]

      Additional arguments for the behavior.

    Returns void

destroy

  • destroy(): void
  • Destroys this widget. Called by the PrimeFaces framework.

    Returns void

getEditorContainer

  • getEditorContainer(): JQuery
  • Returns JQuery

    The HTML container element holding the editor. It exists even if the editor was not created yet.

getInput

  • getInput(): JQuery
  • Returns JQuery

    The hidden textarea holding the value of the editor (eg. the code being edited, this is also the value that is sent when the form is submitted).

getJQ

  • getJQ(): JQuery
  • Returns JQuery

    A reference to the base (container) element of this widget.

hasBehavior

  • hasBehavior(name: string): boolean
  • Parameters

    • name: string

      Name of the behavior to check.

    Returns boolean

    Whether any handlers are registered for the given behavior.

init

  • init(configuration: {}): void
  • Initializes this widget. Called by the PrimeFaces framework.

    Parameters

    • configuration: {}

      Configuration as set on the server-side.

      • [key: string]: any

    Returns void

isDetached

  • isDetached(): boolean
  • Whether this widget is attached to the DOM currently.

    Returns boolean

isReady

  • isReady(): boolean
  • Returns boolean

    true when the editor was already loaded and initialized and can be interacted with via getMonaco(), false otherwise.

refresh

  • refresh(configuration: {}): void
  • Refreshes this widget with the given configuration.

    Parameters

    • configuration: {}

      New configuration for this widget.

      • [key: string]: any

    Returns void

removeScriptElement

  • removeScriptElement(clientId: string): void
  • Parameters

    • clientId: string

      Client ID of the script element to remove.

    Returns void

whenReady

  • whenReady(): Promise<this>
  • Returns Promise<this>

    A promise that is resolved once the editor has finished loading and was created successfully.

Generated using TypeDoc