Class command

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(editor: editor, commandDefinition: commandDefinition): command

Parameters

Returns

command

Properties

public contextSensitive: boolean

public editorFocus: boolean

public modes: any

public previousState: number

public state: number

public uiItems: Array<any>

public useCapture: boolean

Methods

public capture()

public checkAllowed(noCache: boolean): boolean

Parameters

  • noCache: boolean

Returns

boolean

public define(name: string, meta: Object)

Parameters

  • name: string
  • meta: Object

public disable()

public enable()

public exec(data?: Object): boolean

Parameters

  • data?: Object optional

Returns

boolean

public fire(eventName: string, data?: Object, editor?: editor): any

Parameters

  • eventName: string
  • data?: Object optional
  • editor?: editor optional

Returns

any

public fireOnce(eventName: string, data?: Object, editor?: editor): any

Parameters

  • eventName: string
  • data?: Object optional
  • editor?: editor optional

Returns

any

public hasListeners(eventName: string): boolean

Parameters

  • eventName: string

Returns

boolean

public on(eventName: string, listenerFunction: (eventInfo: CKEDITOR.eventInfo) => void, scopeObj?: Object, listenerData?: Object, priority?: number)

Parameters

  • eventName: string
  • listenerFunction: (eventInfo: CKEDITOR.eventInfo) => void
  • scopeObj?: Object optional
  • listenerData?: Object optional
  • priority?: number optional

public once(eventName: string, listenerFunction: (eventInfo: CKEDITOR.eventInfo) => void, scopeObj?: Object, listenerData?: Object, priority?: number)

Parameters

  • eventName: string
  • listenerFunction: (eventInfo: CKEDITOR.eventInfo) => void
  • scopeObj?: Object optional
  • listenerData?: Object optional
  • priority?: number optional

public refresh(editor: editor, path: elementPath)

Parameters

public removeAllListeners()

public removeListener(eventName: string, listenerFunction: (eventInfo: CKEDITOR.eventInfo) => void)

Parameters

  • eventName: string
  • listenerFunction: (eventInfo: CKEDITOR.eventInfo) => void

public setState(newState: number): boolean

Parameters

  • newState: number

Returns

boolean

public toggleState()