Class HTMLTableElementWrapper

Convenience wrapper for tables in different schemas. While for HTML schemas as used for data view representation in CKEditor 5 high level methods can be used to modify a table (HTMLTableElement), the same convenience cannot be used for <table> elements as retrieved via CoreMedia Rich Text 1.0 data.

This wrapper will provide similar convenience for both, like, for example, creating <tbody> elements, accessing <thead> elements, etc.

Constructors

constructor

new HTMLTableElementWrapper(delegate): HTMLTableElementWrapper
Constructor.
Parameters
- delegate: Element | HTMLTableElement
  element to wrap
Returns HTMLTableElementWrapper
Throws
Error, if the given element is no <table>.
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:55

Accessors

firstChild

get firstChild(): null | Node
Get first child, if any.

Returns null | Node
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:83

firstTBody

get firstTBody(): null | Element | HTMLTableSectionElement
Returns the first existing <tbody> element, if available.

Returns null | Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:141

lastTBody

get lastTBody(): null | Element | HTMLTableSectionElement
Returns the last existing <tbody> element, if available.

Returns null | Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:148

native

get native(): boolean
Signals, if native HTMLTableElement API is used.

Returns boolean
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:69

ownerDocument

get ownerDocument(): Document
Get owner document.

Returns Document
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:76

rows

get rows(): Element[]
Returns all direct rows in the table, either as direct children of <table> or within one of the table sections <thead>, <tbody>, or <tfoot>.

In contrast to HTMLTableElement.rows the result is static.

Returns Element[]
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:112

sections

get sections(): (Element | HTMLTableSectionElement)[]
Returns all existing direct table sections.

Returns (Element | HTMLTableSectionElement)[]
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:122

tBodies

get tBodies(): (Element | HTMLTableSectionElement)[]
Returns all <tbody> elements, which are available as snapshot. Note, that while in HTML a table may have multiple <tbody> elements, CoreMedia RichText 1.0 may have only one element.

Returns (Element | HTMLTableSectionElement)[]
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:131

tFoot

get tFoot(): null | Element | HTMLTableSectionElement
Returns the <thead> element, if available.

Returns null | Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:166

tHead

get tHead(): null | Element | HTMLTableSectionElement
Returns the <thead> element, if available.

Returns null | Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:156

Methods

createTBody

createTBody(): Element | HTMLTableSectionElement
Creates a new <tbody> associated to current table. If multiple <tbody> elements exist, the new one is placed after the existing ones.

Returns Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:178

createTFoot

createTFoot(): Element | HTMLTableSectionElement
If no <tfoot> is existing yet, a <tfoot> will be created. Otherwise, the existing <tfoot> will be returned.

Returns Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:225

createTHead

createTHead(): Element | HTMLTableSectionElement
If no <thead> is existing yet, a <thead> will be created. Otherwise, the existing <thead> will be returned.

Returns Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:206

deleteTFoot

deleteTFoot(): void
Deletes a possibly existing <tfoot>.

Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:259

deleteTHead

deleteTHead(): void
Deletes a possibly existing <thead>.

Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:243

ensureTBody

ensureTBody(): Element | HTMLTableSectionElement
If no <tbody> is existing yet, a <tbody> element will be created. Otherwise, the first existing <tbody> will be returned.

Returns Element | HTMLTableSectionElement
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:192

insertAfter

insertAfter<T>(node, child): T
Type Parameters
- T extends Node
Parameters
- node: T
- child: null | Node
Returns T
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:100

insertBefore

insertBefore<T>(node, child): T
Type Parameters
- T extends Node
Parameters
- node: T
- child: null | Node
Returns T
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:96

mergeAllRowsOfAllSectionsIntoTBody

mergeAllRowsOfAllSectionsIntoTBody(): void
Merges all sections in table into one <tbody> element. Note, that this removes any <thead> and <tfoot> sections. For processing such as in CKEditor 5 data-processing you may want to mark corresponding rows before, that they originally belonged to <thead> or <tfoot> like applying a reserved class.

Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:291

mergeTBodies

mergeTBodies(): void
Merges possibly existing multiple <tbody> into one. Note, that while HTML supports multiple <tbody> elements, CoreMedia Rich Text 1.0 does not.

Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:345

moveRowsWithClassToTFoot

moveRowsWithClassToTFoot(className, remove?): void
Moves all rows containing a given class name to <tfoot> section.
Parameters
- className: string
  class name to select row elements to move
- remove: boolean = true
  if to remove the denoting class name from class list
Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:326

moveRowsWithClassToTHead

moveRowsWithClassToTHead(className, remove?): void
Moves all rows containing a given class name to <thead> section.
Parameters
- className: string
  class name to select row elements to move
- remove: boolean = true
  if to remove the denoting class name from class list
Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:306

querySelectorAllDirectChildrenInSectionsAndSelf

querySelectorAllDirectChildrenInSectionsAndSelf(selectors): Element[]
Retrieve all direct children and direct children of all sections that match the given selectors.
Parameters
- selectors: string
  selectors to match
Returns Element[]
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:365

removeChild

removeChild<T>(child): T
Removes the given child.
Type Parameters
- T extends Node
Parameters
- child: T
  child node to remove
Returns T
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:92

removeEmptySections

removeEmptySections(): void
Removes any table sections, which are possibly empty after processing.

Returns void
- Defined in packages/ckeditor5-dom-support/src/HTMLTableElements.ts:276

Class HTMLTableElementWrapper

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns HTMLTableElementWrapper

Throws

Accessors

firstChild

Returns null | Node

firstTBody

Returns null | Element | HTMLTableSectionElement

lastTBody

Returns null | Element | HTMLTableSectionElement

native

Returns boolean

ownerDocument

Returns Document

rows

Returns Element[]

sections

Returns (Element | HTMLTableSectionElement)[]

tBodies

Returns (Element | HTMLTableSectionElement)[]

tFoot

Returns null | Element | HTMLTableSectionElement

tHead

Returns null | Element | HTMLTableSectionElement

Methods

createTBody

Returns Element | HTMLTableSectionElement

createTFoot

Returns Element | HTMLTableSectionElement

createTHead

Returns Element | HTMLTableSectionElement

deleteTFoot

Returns void

deleteTHead

Returns void

ensureTBody

Returns Element | HTMLTableSectionElement

insertAfter

Type Parameters

Parameters

Returns T

insertBefore

Type Parameters

Parameters

Returns T

mergeAllRowsOfAllSectionsIntoTBody

Returns void

mergeTBodies

Returns void

moveRowsWithClassToTFoot

Parameters

Returns void

moveRowsWithClassToTHead

Parameters

Returns void

querySelectorAllDirectChildrenInSectionsAndSelf

Parameters

Returns Element[]

removeChild

Type Parameters

Parameters

Returns T

removeEmptySections

Returns void

Settings

Member Visibility

Theme

On This Page