Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LeafWriterEditor

Hierarchy

  • Editor
    • LeafWriterEditor

Index

Properties

$: DomQueryConstructor
_beforeUnload: () => void

Type declaration

    • (): void
    • Returns void

_eventDispatcher: EventDispatcher<NativeEventMap>
_mceOldSubmit: any
_nodeChangeDispatcher: NodeChange
_pendingNativeEvents: string[]
_selectionOverrides: SelectionOverrides
_skinLoaded: boolean
annotator: Annotator
baseURI: URI
baseUri: URI
bindPendingEventDelegates: (this: Editor) => void

Type declaration

    • (this: Editor): void
    • Parameters

      • this: Editor

      Returns void

bodyElement: HTMLElement
bookmark: any
callbackLookup: any
composing: boolean
container: HTMLElement
contentAreaContainer: HTMLElement
contentCSS: string[]
contentDocument: Document
contentStyles: string[]
contentWindow: Window
copiedElement?: { element?: Element; selectionType?: any }

Type declaration

  • Optional element?: Element
  • Optional selectionType?: any
copiedEntity?: any
currentBookmark?: Bookmark
currentNode?: Node
delegates: Record<string, (event: any) => void>
destroyed: boolean
documentBaseURI: URI
documentBaseUrl: string
dom: DOMUtils
editorCommands: EditorCommands
editorContainer: HTMLElement
editorManager: EditorManager
editorUpload: EditorUpload
eventRoot?: Element
fire: <K, U>(name: K, args?: U, bubble?: boolean) => EditorEvent<U>

Type declaration

    • <K, U>(name: K, args?: U, bubble?: boolean): EditorEvent<U>
    • Type parameters

      • K: string

      • U: any

      Parameters

      • name: K
      • Optional args: U
      • Optional bubble: boolean

      Returns EditorEvent<U>

formElement: HTMLElement
formEventDelegate: (e: Event) => void

Type declaration

    • (e: Event): void
    • Parameters

      • e: Event

      Returns void

formatter: Formatter
hasEventListeners: (name: string) => boolean

Type declaration

    • (name: string): boolean
    • Parameters

      • name: string

      Returns boolean

hasHiddenInput: boolean
hasVisual: boolean
hidden: boolean
id: string
iframeElement: HTMLIFrameElement
iframeHTML: string
initialized: boolean
inline: boolean
isNotDirty: boolean
lastKeyPress?: string
loadedCSS: Record<string, any>
mode: EditorMode
notificationManager: NotificationManager
off: <K>(name?: K, callback?: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void) => EventDispatcher<EditorEventMap>

Type declaration

    • <K>(name?: K, callback?: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void): EventDispatcher<EditorEventMap>
    • Type parameters

      • K: string

      Parameters

      • Optional name: K
      • Optional callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void
          • (event: EditorEvent<MappedEvent<EditorEventMap, K>>): void
          • Parameters

            • event: EditorEvent<MappedEvent<EditorEventMap, K>>

            Returns void

      Returns EventDispatcher<EditorEventMap>

on: <K>(name: K, callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void, prepend?: boolean) => EventDispatcher<EditorEventMap>

Type declaration

    • <K>(name: K, callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void, prepend?: boolean): EventDispatcher<EditorEventMap>
    • Type parameters

      • K: string

      Parameters

      • name: K
      • callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void
          • (event: EditorEvent<MappedEvent<EditorEventMap, K>>): void
          • Parameters

            • event: EditorEvent<MappedEvent<EditorEventMap, K>>

            Returns void

      • Optional prepend: boolean

      Returns EventDispatcher<EditorEventMap>

once: <K>(name: K, callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void) => EventDispatcher<EditorEventMap>

Type declaration

    • <K>(name: K, callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void): EventDispatcher<EditorEventMap>
    • Type parameters

      • K: string

      Parameters

      • name: K
      • callback: (event: EditorEvent<MappedEvent<EditorEventMap, K>>) => void
          • (event: EditorEvent<MappedEvent<EditorEventMap, K>>): void
          • Parameters

            • event: EditorEvent<MappedEvent<EditorEventMap, K>>

            Returns void

      Returns EventDispatcher<EditorEventMap>

orgDisplay: string
orgVisibility: string
parser: DomParser
plugins: Record<string, Plugin>
quirks: Quirks
readonly: boolean
removed: boolean
schema: Schema
selection: EditorSelection
serializer: DomSerializer
setMode: (mode: string) => void

Type declaration

    • (mode: string): void
    • Parameters

      • mode: string

      Returns void

settings: EditorSettings
shortcuts: Shortcuts
startContent: string
suffix: string
targetElm: HTMLElement
theme: Theme
toggleNativeEvent: (this: Editor, name: string, state: boolean) => any

Type declaration

    • (this: Editor, name: string, state: boolean): any
    • Parameters

      • this: Editor
      • name: string
      • state: boolean

      Returns any

ui: EditorUi
unbindAllNativeEvents: (this: Editor) => void

Type declaration

    • (this: Editor): void
    • Parameters

      • this: Editor

      Returns void

undoManager: UndoManager
validate: boolean
windowManager: WindowManager
writer?: Writer

Methods

  • _scanForImages(): Promise<BlobInfoImagePair[]>
  • Returns Promise<BlobInfoImagePair[]>

  • addButton(): void
  • Returns void

  • addCommand(name: string, callback: EditorCommandCallback, scope?: object): void
  • Parameters

    • name: string
    • callback: EditorCommandCallback
    • Optional scope: object

    Returns void

  • addContextToolbar(): void
  • Returns void

  • addMenuItem(): void
  • Returns void

  • addQueryStateHandler(name: string, callback: () => boolean, scope?: any): void
  • Parameters

    • name: string
    • callback: () => boolean
        • (): boolean
        • Returns boolean

    • Optional scope: any

    Returns void

  • addQueryValueHandler(name: string, callback: () => string, scope?: any): void
  • Parameters

    • name: string
    • callback: () => string
        • (): string
        • Returns string

    • Optional scope: any

    Returns void

  • addShortcut(pattern: string, desc: string, cmdFunc: string | [string, boolean, any] | (() => void), scope?: any): void
  • Parameters

    • pattern: string
    • desc: string
    • cmdFunc: string | [string, boolean, any] | (() => void)
    • Optional scope: any

    Returns void

  • addSidebar(): void
  • Returns void

  • addVisual(elm?: HTMLElement): void
  • Parameters

    • Optional elm: HTMLElement

    Returns void

  • convertURL(url: string, name: string, elm?: any): string
  • Parameters

    • url: string
    • name: string
    • Optional elm: any

    Returns string

  • destroy(automatic?: boolean): void
  • Parameters

    • Optional automatic: boolean

    Returns void

  • execCallback(name: string, ...x: any[]): any
  • Parameters

    • name: string
    • Rest ...x: any[]

    Returns any

  • execCommand(cmd: string, ui?: boolean, value?: any, args?: any): boolean
  • Parameters

    • cmd: string
    • Optional ui: boolean
    • Optional value: any
    • Optional args: any

    Returns boolean

  • focus(skipFocus?: boolean): void
  • Parameters

    • Optional skipFocus: boolean

    Returns void

  • getBody(): HTMLElement
  • Returns HTMLElement

  • getContainer(): HTMLElement
  • Returns HTMLElement

  • getContent(args: { format: "tree" } & GetContentArgs): AstNode
  • getContent(args?: GetContentArgs): string
  • Parameters

    • args: { format: "tree" } & GetContentArgs

    Returns AstNode

  • Parameters

    • Optional args: GetContentArgs

    Returns string

  • getContentAreaContainer(): HTMLElement
  • Returns HTMLElement

  • getDoc(): Document
  • Returns Document

  • getElement(): HTMLElement
  • Returns HTMLElement

  • getParam<K>(name: string, defaultVal: ParamTypeMap[K], type: K): ParamTypeMap[K]
  • getParam<K>(name: K, defaultVal?: EditorSettings[K], type?: string): EditorSettings[K]
  • getParam<T>(name: string, defaultVal: T, type?: string): T
  • Type parameters

    • K: keyof ParamTypeMap

    Parameters

    • name: string
    • defaultVal: ParamTypeMap[K]
    • type: K

    Returns ParamTypeMap[K]

  • Type parameters

    • K: keyof EditorSettings

    Parameters

    • name: K
    • Optional defaultVal: EditorSettings[K]
    • Optional type: string

    Returns EditorSettings[K]

  • Type parameters

    • T

    Parameters

    • name: string
    • defaultVal: T
    • Optional type: string

    Returns T

  • getWin(): Window
  • Returns Window

  • hasFocus(): boolean
  • Returns boolean

  • hasPlugin(name: string, loaded?: boolean): boolean
  • Parameters

    • name: string
    • Optional loaded: boolean

    Returns boolean

  • hide(): void
  • Returns void

  • insertContent(content: string, args?: any): void
  • Parameters

    • content: string
    • Optional args: any

    Returns void

  • isDirty(): boolean
  • Returns boolean

  • isHidden(): boolean
  • Returns boolean

  • load(args?: any): string
  • Parameters

    • Optional args: any

    Returns string

  • nodeChanged(args?: any): void
  • Parameters

    • Optional args: any

    Returns void

  • queryCommandState(cmd: string): boolean
  • Parameters

    • cmd: string

    Returns boolean

  • queryCommandSupported(cmd: string): boolean
  • Parameters

    • cmd: string

    Returns boolean

  • queryCommandValue(cmd: string): string
  • Parameters

    • cmd: string

    Returns string

  • remove(): void
  • Returns void

  • render(): void
  • Returns void

  • resetContent(initialContent?: string): void
  • Parameters

    • Optional initialContent: string

    Returns void

  • save(args?: any): string
  • Parameters

    • Optional args: any

    Returns string

  • setContent(content: string, args?: SetContentArgs): string
  • setContent(content: AstNode, args?: SetContentArgs): AstNode
  • setContent(content: Content, args?: SetContentArgs): Content
  • Parameters

    • content: string
    • Optional args: SetContentArgs

    Returns string

  • Parameters

    • content: AstNode
    • Optional args: SetContentArgs

    Returns AstNode

  • Parameters

    • content: Content
    • Optional args: SetContentArgs

    Returns Content

  • setDirty(state: boolean): void
  • Parameters

    • state: boolean

    Returns void

  • setProgressState(state: boolean, time?: number): void
  • Parameters

    • state: boolean
    • Optional time: number

    Returns void

  • show(): void
  • Returns void

  • translate(text: Untranslated): string
  • Parameters

    • text: Untranslated

    Returns string

  • uploadImages(callback?: UploadCallback): Promise<UploadResult$1[]>
  • Parameters

    • Optional callback: UploadCallback

    Returns Promise<UploadResult$1[]>

Generated using TypeDoc