Class element

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(element: string, ownerDocument?: document): element

Parameters

  • element: string
  • ownerDocument?: document optional

Returns

element

constructor(element: HTMLElement, ownerDocument?: document): element

Parameters

  • element: HTMLElement
  • ownerDocument?: document optional

Returns

element

Properties

public $: HTMLElement

public type: number

Methods

public addClass(className: string)

Parameters

  • className: string

public append(node: node, toStart?: boolean): node

Parameters

  • node: node
  • toStart?: boolean optional

Returns

node

public append(node: string, toStart?: boolean): node

Parameters

  • node: string
  • toStart?: boolean optional

Returns

node

public appendBogus(force: boolean)

Parameters

  • force: boolean

public appendHtml(html: string)

Parameters

  • html: string

public appendText(text: string): node

Parameters

  • text: string

Returns

node

public appendTo(element: element): element

Parameters

Returns

element

public breakParent(parent: element)

Parameters

public static clearAllMarkers(database: Object): Object

Parameters

  • database: Object

Returns

Object

public clearCustomData()

public static clearMarkers(database: Object, element: Object, removeFromDatabase: Object)

Parameters

  • database: Object
  • element: Object
  • removeFromDatabase: Object

public clone(includeChildren: boolean, cloneId: boolean): node

Parameters

  • includeChildren: boolean
  • cloneId: boolean

Returns

node

public contains(node: node): boolean

Parameters

Returns

boolean

public copyAttributes(dest: element, skipAttributes: Object)

Parameters

  • dest: element
  • skipAttributes: Object

public static createFromHtml(html: string): element

Parameters

  • html: string

Returns

element

public data(name: string): string

Parameters

  • name: string

Returns

string

public data(name: string, value: string)

Parameters

  • name: string
  • value: string

public data(name: string, value: boolean)

Parameters

  • name: string
  • value: boolean

public disableContextMenu()

public equals(object: any): boolean

Parameters

  • object: any

Returns

boolean

public find(selector: string): nodeList

Parameters

  • selector: string

Returns

nodeList

public findOne(selector: string): element

Parameters

  • selector: string

Returns

element

public focus(defer?: boolean)

Parameters

  • defer?: boolean optional

public focusNext(ignoreChildren?: boolean, indexToUse?: number)

Parameters

  • ignoreChildren?: boolean optional
  • indexToUse?: number optional

public focusPrevious(ignoreChildren?: boolean, indexToUse?: number)

Parameters

  • ignoreChildren?: boolean optional
  • indexToUse?: number optional

public forEach(callback: (node: CKEDITOR.dom.node) => void, type?: number, skipRoot?: boolean)

Parameters

  • callback: (node: CKEDITOR.dom.node) => void
  • type?: number optional
  • skipRoot?: boolean optional

public static get(element: string): element

Parameters

  • element: string

Returns

element

public static get(element: any): element

Parameters

  • element: any

Returns

element

public getAddress(normalized: boolean): Array<Object>

Parameters

  • normalized: boolean

Returns

Array<Object>

public getAscendant(reference: string, includeSelf?: boolean): node

Parameters

  • reference: string
  • includeSelf?: boolean optional

Returns

node

public getAttribute(name: string): string

Parameters

  • name: string

Returns

string

public getBogus(): Object

Returns

Object

public getChild(indices: number): node

Parameters

  • indices: number

Returns

node

public getChild(indices: Array<number>): node

Parameters

  • indices: Array<number>

Returns

node

public getChildCount(): number

Returns

number

public getChildren(): nodeList

Returns

nodeList

public getClientRect(): any

Returns

any

public getCommonAncestor(node: Object)

Parameters

  • node: Object

public getComputedStyle(propertyName: string): string

Parameters

  • propertyName: string

Returns

string

public getCustomData(key: string): any

Parameters

  • key: string

Returns

any

public getDirection(useComputed: boolean): string

Parameters

  • useComputed: boolean

Returns

string

public getDocument(): document

Returns

document

public getDocumentPosition(refDocument: document): position

Parameters

Returns

position

public getDtd(): any

Returns

any

public getEditor(): editor

Returns

editor

public getElementsByTag(tagName: string): nodeList

Parameters

  • tagName: string

Returns

nodeList

public getFirst(evaluator?: Function): node

Parameters

  • evaluator?: Function optional

Returns

node

public getFrameDocument(): document

Returns

document

public getHtml(): string

Returns

string

public getId(): string

Returns

string

public getIndex(normalized?: boolean): number

Parameters

  • normalized?: boolean optional

Returns

number

public getKey(): number

Returns

number

public getKeystroke(): number

Returns

number

public getLast(evaluator?: Function): node

Parameters

  • evaluator?: Function optional

Returns

node

public getName(): string

Returns

string

public getNameAtt(): string

Returns

string

public getNext(evaluator?: Function): node

Parameters

  • evaluator?: Function optional

Returns

node

public getNextSourceNode(startFromSibling: Object, nodeType: Object, guard: Object)

Parameters

  • startFromSibling: Object
  • nodeType: Object
  • guard: Object

public getOuterHtml(): string

Returns

string

public getParent(allowFragmentParent?: boolean): element

Parameters

  • allowFragmentParent?: boolean optional

Returns

element

public getParents(closerFirst?: boolean): node[]

Parameters

  • closerFirst?: boolean optional

Returns

node[]

public getPhase(): number

Returns

number

public getPhaseOffset(): position

Returns

position

public getPosition(otherNode: Object)

Parameters

  • otherNode: Object

public getPositionedAncestor(): element

Returns

element

public getPrevious(evaluator?: Function): node

Parameters

  • evaluator?: Function optional

Returns

node

public getPreviousSourceNode(startFromSibling: Object, nodeType: Object, guard: Object)

Parameters

  • startFromSibling: Object
  • nodeType: Object
  • guard: Object

public getPrivate(): any

Returns

any

public getSize(type: string, isBorderBox: boolean)

Parameters

  • type: string
  • isBorderBox: boolean

public getStyle(name: string): string

Parameters

  • name: string

Returns

string

public getTabIndex(): number

Returns

number

public getTarget(): node

Returns

node

public getText(): string

Returns

string

public getUniqueId(): number

Returns

number

public getValue(): string

Returns

string

public getWindow(): window

Returns

window

public hasAscendant(name: Object, includeSelf: any): boolean

Parameters

  • name: Object
  • includeSelf: any

Returns

boolean

public hasAttribute(name: string): boolean

Parameters

  • name: string

Returns

boolean

public hasAttributes(): boolean

Returns

boolean

public hasClass(className: string): boolean

Parameters

  • className: string

Returns

boolean

public hasNext(): boolean

Returns

boolean

public hasPrevious(): boolean

Returns

boolean

public hide()

public insertAfter(node: node): node

Parameters

Returns

node

public insertBefore(node: node): node

Parameters

Returns

node

public insertBeforeMe(node: node): node

Parameters

Returns

node

public is(name?: Array<string>): boolean

Parameters

  • name?: Array<string> optional

Returns

boolean

public is(name: any): boolean

Parameters

  • name: any

Returns

boolean

public isBlockBoundary(customNodeNames: Object): boolean

Parameters

  • customNodeNames: Object

Returns

boolean

public isEditable(textCursor?: boolean): boolean

Parameters

  • textCursor?: boolean optional

Returns

boolean

public isEmptyInlineRemoveable(): boolean

Returns

boolean

public isIdentical(otherElement: element): boolean

Parameters

Returns

boolean

public isReadOnly(): boolean

Returns

boolean

public isVisible(): boolean

Returns

boolean

public ltrim()

public mergeSiblings(inlineOnly?: boolean)

Parameters

  • inlineOnly?: boolean optional

public move(preserveChildren?: boolean): node

Parameters

  • preserveChildren?: boolean optional

Returns

node

public moveChildren(target: element, toStart?: boolean)

Parameters

  • target: element
  • toStart?: boolean optional

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

Parameters

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

Returns

Object

public preventDefault(stopPropagation: boolean)

Parameters

  • stopPropagation: boolean

public removeAllListeners()

public removeAttribute(name: string)

Parameters

  • name: string

public removeAttributes(attributes?: Array<string>)

Parameters

  • attributes?: Array<string> optional

public removeClass(className: string)

Parameters

  • className: string

public removeCustomData(key: string): Object

Parameters

  • key: string

Returns

Object

public removeStyle(name: string)

Parameters

  • name: string

public renameNode(newTag: string)

Parameters

  • newTag: string

public replace(nodeToReplace: node)

Parameters

  • nodeToReplace: node

public rtrim()

public scrollIntoParent(parent: element, alignToTop: boolean, hscroll: boolean)

Parameters

  • parent: element
  • alignToTop: boolean
  • hscroll: boolean

public scrollIntoParent(parent: window, alignToTop: boolean, hscroll: boolean)

Parameters

  • parent: window
  • alignToTop: boolean
  • hscroll: boolean

public scrollIntoView(alignToTop?: boolean)

Parameters

  • alignToTop?: boolean optional

public setAttribute(name: string, value: string): element

Parameters

  • name: string
  • value: string

Returns

element

public setAttributes(attributesPairs: Object): element

Parameters

  • attributesPairs: Object

Returns

element

public setCustomData(key: string, value: Object): domObject

Parameters

  • key: string
  • value: Object

Returns

domObject

public setHtml(html: string): string

Parameters

  • html: string

Returns

string

public static setMarker(database: Object, element: Object, name: Object, value: Object): domObject

Parameters

  • database: Object
  • element: Object
  • name: Object
  • value: Object

Returns

domObject

public setOpacity(opacity: number)

Parameters

  • opacity: number

public setSize(type: string, size: number, isBorderBox: boolean)

Parameters

  • type: string
  • size: number
  • isBorderBox: boolean

public setState(state: number, base?: Object, useAria?: Object)

Parameters

  • state: number
  • base?: Object optional
  • useAria?: Object optional

public setStyle(name: string, value: string): element

Parameters

  • name: string
  • value: string

Returns

element

public setStyles(stylesPair: Object): element

Parameters

  • stylesPair: Object

Returns

element

public setText(text: string): string

Parameters

  • text: string

Returns

string

public setValue(value: string): element

Parameters

  • value: string

Returns

element

public show()

public stopPropagation()

public trim()

public unselectable()