Class AbstractDOMAdaptor<N, T, D>`Abstract`

Abstract DOMAdaptor class for creating HTML elements

Type Parameters

N
The HTMLElement node class
T
The Text node class
D
The Document class

Hierarchy (View Summary)

AbstractDOMAdaptor
- HTMLAdaptor
- LiteBase

Implements

DOMAdaptor<N, T, D>

Constructors

constructor

new AbstractDOMAdaptor<N, T, D>(document?: D): AbstractDOMAdaptor<N, T, D>
Type Parameters
- N
  The HTMLElement node class
- T
  The Text node class
- D
  The Document class
Parameters
- document: D = null
  The document in which the nodes will be created
Returns AbstractDOMAdaptor<N, T, D>
- Defined in ts/core/DOMAdaptor.ts:452

Properties

canMeasureNodes

canMeasureNodes: boolean = true

True when the adaptor can measure DOM node sizes

document

document: D

The document in which the HTML nodes will be created

Methods

`Abstract`addClass

addClass(node: N, name: string): void
Parameters
- node: N
- name: string
Returns void
Implementation of DOMAdaptor.addClass
- Defined in ts/core/DOMAdaptor.ts:707

`Abstract`allAttributes

allAttributes(node: N): AttributeData[]
Parameters
- node: N
Returns AttributeData[]
Implementation of DOMAdaptor.allAttributes
- Defined in ts/core/DOMAdaptor.ts:702

allClasses

allClasses(node: N): string[]
Parameters
- node: N
Returns string[]
Implementation of DOMAdaptor.allClasses
- Defined in ts/core/DOMAdaptor.ts:722

`Abstract`allStyles

allStyles(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.allStyles
- Defined in ts/core/DOMAdaptor.ts:746

`Abstract`append

append(node: N, child: N | T): N | T
Parameters
- node: N
- child: N | T
Returns N | T
Implementation of DOMAdaptor.append
- Defined in ts/core/DOMAdaptor.ts:581

`Abstract`body

body(doc?: D): N
Parameters
- Optionaldoc: D
Returns N
Implementation of DOMAdaptor.body
- Defined in ts/core/DOMAdaptor.ts:541

childNode

childNode(node: N, i: number): N | T
Parameters
- node: N
- i: number
Returns N | T
Implementation of DOMAdaptor.childNode
- Defined in ts/core/DOMAdaptor.ts:640

`Abstract`childNodes

childNodes(node: N): (N | T)[]
Parameters
- node: N
Returns (N | T)[]
Implementation of DOMAdaptor.childNodes
- Defined in ts/core/DOMAdaptor.ts:635

`Abstract`clone

clone(node: N, deep: boolean): N
Parameters
- node: N
- deep: boolean
Returns N
Implementation of DOMAdaptor.clone
- Defined in ts/core/DOMAdaptor.ts:605

`Abstract`contains

contains(container: N, node: N | T): boolean
Parameters
- container: N
- node: N | T
Returns boolean
Implementation of DOMAdaptor.contains
- Defined in ts/core/DOMAdaptor.ts:571

`Protected` `Abstract`create

create(kind: string, ns?: string): N
Parameters
- kind: string
  The type of the node to create
- Optionalns: string
  The optional namespace in which to create the node
Returns N
The created node
- Defined in ts/core/DOMAdaptor.ts:483

`Abstract`createWorker

createWorker(
listener: (event: any) => void,
options: OptionList,
): Promise<minWorker>
Parameters
- listener: (event: any) => void
- options: OptionList
Returns Promise<minWorker>
Implementation of DOMAdaptor.createWorker
- Defined in ts/core/DOMAdaptor.ts:787

cssText

cssText(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.cssText
- Defined in ts/core/DOMAdaptor.ts:756

`Abstract`doctype

doctype(doc?: D): string
Parameters
- Optionaldoc: D
Returns string
Implementation of DOMAdaptor.doctype
- Defined in ts/core/DOMAdaptor.ts:551

`Abstract`firstChild

firstChild(node: N): N | T
Parameters
- node: N
Returns N | T
Implementation of DOMAdaptor.firstChild
- Defined in ts/core/DOMAdaptor.ts:625

`Abstract`fontFamily

fontFamily(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.fontFamily
- Defined in ts/core/DOMAdaptor.ts:768

`Abstract`fontSize

fontSize(node: N): number
Parameters
- node: N
Returns number
Implementation of DOMAdaptor.fontSize
- Defined in ts/core/DOMAdaptor.ts:763

`Abstract`getAttribute

getAttribute(node: N, name: string): string
Parameters
- node: N
- name: string
Returns string
Implementation of DOMAdaptor.getAttribute
- Defined in ts/core/DOMAdaptor.ts:687

`Abstract`getElement

getElement(selector: string, node?: N | D): N
Parameters
- selector: string
- Optionalnode: N | D
Returns N
Implementation of DOMAdaptor.getElement
- Defined in ts/core/DOMAdaptor.ts:566

`Abstract`getElements

getElements(nodes: (string | N | N[])[], document: D): N[]
Parameters
- nodes: (string | N | N[])[]
- document: D
Returns N[]
Implementation of DOMAdaptor.getElements
- Defined in ts/core/DOMAdaptor.ts:561

getProperty

getProperty(node: N, name: string): any
Parameters
- node: N
- name: string
Returns any
Implementation of DOMAdaptor.getProperty
- Defined in ts/core/DOMAdaptor.ts:500

`Abstract`getStyle

getStyle(node: N, name: string): string
Parameters
- node: N
- name: string
Returns string
Implementation of DOMAdaptor.getStyle
- Defined in ts/core/DOMAdaptor.ts:741

`Abstract`hasAttribute

hasAttribute(node: N, name: string): boolean
Parameters
- node: N
- name: string
Returns boolean
Implementation of DOMAdaptor.hasAttribute
- Defined in ts/core/DOMAdaptor.ts:697

`Abstract`hasClass

hasClass(node: N, name: string): boolean
Parameters
- node: N
- name: string
Returns boolean
Implementation of DOMAdaptor.hasClass
- Defined in ts/core/DOMAdaptor.ts:717

`Abstract`head

head(doc?: D): N
Parameters
- Optionaldoc: D
Returns N
Implementation of DOMAdaptor.head
- Defined in ts/core/DOMAdaptor.ts:536

`Abstract`innerHTML

innerHTML(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.innerHTML
- Defined in ts/core/DOMAdaptor.ts:662

`Abstract`insert

insert(nchild: N | T, ochild: N | T): void
Parameters
- nchild: N | T
- ochild: N | T
Returns void
Implementation of DOMAdaptor.insert
- Defined in ts/core/DOMAdaptor.ts:586

`Abstract`insertRules

insertRules(node: N, rules: string[]): void
Parameters
- node: N
- rules: string[]
Returns void
Implementation of DOMAdaptor.insertRules
- Defined in ts/core/DOMAdaptor.ts:751

`Abstract`kind

kind(node: N | T): string
Parameters
- node: N | T
Returns string
Implementation of DOMAdaptor.kind
- Defined in ts/core/DOMAdaptor.ts:647

`Abstract`lastChild

lastChild(node: N): N | T
Parameters
- node: N
Returns N | T
Implementation of DOMAdaptor.lastChild
- Defined in ts/core/DOMAdaptor.ts:630

`Abstract`next

next(node: N | T): N | T
Parameters
- node: N | T
Returns N | T
Implementation of DOMAdaptor.next
- Defined in ts/core/DOMAdaptor.ts:615

node

node(kind: string, def?: OptionList, children?: (N | T)[], ns?: string): N
Parameters
- kind: string
- def: OptionList = {}
- children: (N | T)[] = []
- Optionalns: string
Returns N
Implementation of DOMAdaptor.node
- Defined in ts/core/DOMAdaptor.ts:464

`Abstract`nodeBBox

nodeBBox(node: N): PageBBox
Parameters
- node: N
Returns PageBBox
Implementation of DOMAdaptor.nodeBBox
- Defined in ts/core/DOMAdaptor.ts:782

`Abstract`nodeSize

nodeSize(node: N, em?: number, local?: boolean): [number, number]
Parameters
- node: N
- Optionalem: number
- Optionallocal: boolean
Returns [number, number]
Implementation of DOMAdaptor.nodeSize
- Defined in ts/core/DOMAdaptor.ts:773

`Abstract`outerHTML

outerHTML(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.outerHTML
- Defined in ts/core/DOMAdaptor.ts:667

`Abstract`parent

parent(node: N | T): N
Parameters
- node: N | T
Returns N
Implementation of DOMAdaptor.parent
- Defined in ts/core/DOMAdaptor.ts:576

`Abstract`parse

parse(text: string, format?: string): D
Parameters
- text: string
- Optionalformat: string
Returns D
Implementation of DOMAdaptor.parse
- Defined in ts/core/DOMAdaptor.ts:459

`Abstract`previous

previous(node: N | T): N | T
Parameters
- node: N | T
Returns N | T
Implementation of DOMAdaptor.previous
- Defined in ts/core/DOMAdaptor.ts:620

`Abstract`remove

remove(child: N | T): N | T
Parameters
- child: N | T
Returns N | T
Implementation of DOMAdaptor.remove
- Defined in ts/core/DOMAdaptor.ts:591

`Abstract`removeAttribute

removeAttribute(node: N, name: string): void
Parameters
- node: N
- name: string
Returns void
Implementation of DOMAdaptor.removeAttribute
- Defined in ts/core/DOMAdaptor.ts:692

`Abstract`removeClass

removeClass(node: N, name: string): void
Parameters
- node: N
- name: string
Returns void
Implementation of DOMAdaptor.removeClass
- Defined in ts/core/DOMAdaptor.ts:712

replace

replace(nnode: N | T, onode: N | T): N | T
Parameters
- nnode: N | T
- onode: N | T
Returns N | T
Implementation of DOMAdaptor.replace
- Defined in ts/core/DOMAdaptor.ts:596

`Abstract`root

root(doc?: D): N
Parameters
- Optionaldoc: D
Returns N
Implementation of DOMAdaptor.root
- Defined in ts/core/DOMAdaptor.ts:546

`Abstract`serializeXML

serializeXML(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.serializeXML
- Defined in ts/core/DOMAdaptor.ts:672

`Abstract`setAttribute

setAttribute(node: N, name: string, value: string, ns?: string): void
Parameters
- node: N
- name: string
- value: string
- Optionalns: string
Returns void
Implementation of DOMAdaptor.setAttribute
- Defined in ts/core/DOMAdaptor.ts:677

setAttributes

setAttributes(node: N, def: OptionList): void
Parameters
- node: N
  The HTML element whose attributes are to be set
- def: OptionList
  The attributes to set on that node
Returns void
Implementation of DOMAdaptor.setAttributes
- Defined in ts/core/DOMAdaptor.ts:508

setProperty

setProperty(node: N, name: string, value: any): void
Parameters
- node: N
- name: string
- value: any
Returns void
Implementation of DOMAdaptor.setProperty
- Defined in ts/core/DOMAdaptor.ts:493

`Abstract`setStyle

setStyle(node: N, name: string, value: string): void
Parameters
- node: N
- name: string
- value: string
Returns void
Implementation of DOMAdaptor.setStyle
- Defined in ts/core/DOMAdaptor.ts:736

`Abstract`split

split(node: T, n: number): T
Parameters
- node: T
- n: number
Returns T
Implementation of DOMAdaptor.split
- Defined in ts/core/DOMAdaptor.ts:610

`Abstract`tags

tags(node: N, name: string, ns?: string): N[]
Parameters
- node: N
- name: string
- Optionalns: string
Returns N[]
Implementation of DOMAdaptor.tags
- Defined in ts/core/DOMAdaptor.ts:556

`Abstract`text

text(text: string): T
Parameters
- text: string
Returns T
Implementation of DOMAdaptor.text
- Defined in ts/core/DOMAdaptor.ts:488

`Abstract`textContent

textContent(node: N): string
Parameters
- node: N
Returns string
Implementation of DOMAdaptor.textContent
- Defined in ts/core/DOMAdaptor.ts:657

`Abstract`value

value(node: N | T): string
Parameters
- node: N | T
Returns string
Implementation of DOMAdaptor.value
- Defined in ts/core/DOMAdaptor.ts:652