Class LiteBase

Implements a lightweight DOMAdaptor on liteweight HTML elements

Hierarchy (View Summary)

AbstractDOMAdaptor<LiteElement, LiteText, LiteDocument>
- LiteBase
  - LiteAdaptor

Constructors

constructor

new LiteBase(): LiteBase
Returns LiteBase
Overrides AbstractDOMAdaptor.constructor
- Defined in ts/adaptors/liteAdaptor.ts:74

Properties

canMeasureNodes

canMeasureNodes: boolean = true

True when the adaptor can measure DOM node sizes

document

document: LiteDocument

The document in which the HTML nodes will be created

parser

parser: LiteParser

The parser for serialized HTML

window

window: LiteWindow

The window for the document

Methods

addClass

addClass(node: LiteElement, name: string): void
Parameters
- node: LiteElement
- name: string
Returns void
Overrides AbstractDOMAdaptor.addClass
- Defined in ts/adaptors/liteAdaptor.ts:608

allAttributes

allAttributes(node: LiteElement): { name: string; value: string }[]
Parameters
- node: LiteElement
Returns { name: string; value: string }[]
Overrides AbstractDOMAdaptor.allAttributes
- Defined in ts/adaptors/liteAdaptor.ts:596

allClasses

allClasses(node: LiteElement): string[]
Parameters
- node: LiteElement
Returns string[]
Inherited from AbstractDOMAdaptor.allClasses
- Defined in ts/core/DOMAdaptor.ts:720

childIndex

childIndex(node: LiteNode): number
Parameters
- node: LiteNode
  The node whose index is needed
Returns number
The index of the node it its parent's children array
- Defined in ts/adaptors/liteAdaptor.ts:360

childNode

childNode(node: LiteElement, i: number): LiteNode
Parameters
- node: LiteElement
- i: number
Returns LiteNode
Overrides AbstractDOMAdaptor.childNode
- Defined in ts/adaptors/liteAdaptor.ts:492

childNodes

childNodes(node: LiteElement): LiteNode[]
Parameters
- node: LiteElement
Returns LiteNode[]
Overrides AbstractDOMAdaptor.childNodes
- Defined in ts/adaptors/liteAdaptor.ts:485

clone

clone(node: LiteElement, deep?: boolean): LiteElement
Parameters
- node: LiteElement
- deep: boolean = true
Returns LiteElement
Overrides AbstractDOMAdaptor.clone
- Defined in ts/adaptors/liteAdaptor.ts:418

comment

comment(text: string): LiteComment
Parameters
- text: string
  The text of the comment
Returns LiteComment
The comment node
- Defined in ts/adaptors/liteAdaptor.ts:105

contains

contains(container: LiteNode, node: LiteNode): boolean
Parameters
- container: LiteNode
- node: LiteNode
Returns boolean
Overrides AbstractDOMAdaptor.contains
- Defined in ts/adaptors/liteAdaptor.ts:342

`Protected`create

create(kind: string, _ns?: string): LiteElement
Parameters
- kind: string
- _ns: string = null
Returns LiteElement
Overrides AbstractDOMAdaptor.create
- Defined in ts/adaptors/liteAdaptor.ts:90

createDocument

createDocument(): LiteDocument
Returns LiteDocument
A new document element
- Defined in ts/adaptors/liteAdaptor.ts:112

createWorker

createWorker(
listener: (event: any) => void,
options: OptionList,
): Promise<minWorker>
Parameters
- listener: (event: any) => void
- options: OptionList
Returns Promise<minWorker>
Overrides AbstractDOMAdaptor.createWorker
- Defined in ts/adaptors/liteAdaptor.ts:713

cssText

cssText(node: LiteElement): string
Parameters
- node: LiteElement
Returns string
Inherited from AbstractDOMAdaptor.cssText
- Defined in ts/core/DOMAdaptor.ts:754

doctype

doctype(doc?: LiteDocument): string
Parameters
- doc: LiteDocument = ...
Returns string
Overrides AbstractDOMAdaptor.doctype
- Defined in ts/adaptors/liteAdaptor.ts:140

elementById

elementById(node: LiteElement, id: string): LiteElement
Parameters
- node: LiteElement
  The node to be searched
- id: string
  The id of the node to look for
Returns LiteElement
The child node having the given id
- Defined in ts/adaptors/liteAdaptor.ts:183

elementsByAttribute

elementsByAttribute(
    node: LiteElement,
    name: string,
    value: string,
    stop?: number,
): LiteElement[]
Parameters
- node: LiteElement
  The node to be searched
- name: string
  The name of the attribute to find
- value: string
  The value of the attribute to match
- stop: number = null
  Number of elements to collect
Returns LiteElement[]
The nodes with the given attribute
- Defined in ts/adaptors/liteAdaptor.ts:241

elementsByClass

elementsByClass(node: LiteElement, name: string, stop?: number): LiteElement[]
Parameters
- node: LiteElement
  The node to be searched
- name: string
  The name of the class to find
- stop: number = null
  Number of elements to collect
Returns LiteElement[]
The nodes with the given class
- Defined in ts/adaptors/liteAdaptor.ts:207

firstChild

firstChild(node: LiteElement): LiteNode
Parameters
- node: LiteElement
Returns LiteNode
Overrides AbstractDOMAdaptor.firstChild
- Defined in ts/adaptors/liteAdaptor.ts:471

fontFamily

fontFamily(_node: LiteElement): string
Parameters
- _node: LiteElement
Returns string
Overrides AbstractDOMAdaptor.fontFamily
- Defined in ts/adaptors/liteAdaptor.ts:692

getAttribute

getAttribute(node: LiteElement, name: string): any
Parameters
- node: LiteElement
- name: string
Returns any
Overrides AbstractDOMAdaptor.getAttribute
- Defined in ts/adaptors/liteAdaptor.ts:575

getElement

getElement(selector: string, node?: LiteElement | LiteDocument): LiteElement
Parameters
- selector: string
- node: LiteElement | LiteDocument = ...
Returns LiteElement
Overrides AbstractDOMAdaptor.getElement
- Defined in ts/adaptors/liteAdaptor.ts:316

getElements

getElements(
nodes: (string | LiteElement | LiteElement[])[],
document: LiteDocument,
): LiteElement[]
Parameters
- nodes: (string | LiteElement | LiteElement[])[]
- document: LiteDocument
Returns LiteElement[]
Overrides AbstractDOMAdaptor.getElements
- Defined in ts/adaptors/liteAdaptor.ts:272

getProperty

getProperty(node: LiteElement, name: string): any
Parameters
- node: LiteElement
- name: string
Returns any
Inherited from AbstractDOMAdaptor.getProperty
- Defined in ts/core/DOMAdaptor.ts:498

getStyle

getStyle(node: LiteElement, name: string): string
Parameters
- node: LiteElement
- name: string
Returns string
Overrides AbstractDOMAdaptor.getStyle
- Defined in ts/adaptors/liteAdaptor.ts:650

hasAttribute

hasAttribute(node: LiteElement, name: string): boolean
Parameters
- node: LiteElement
- name: string
Returns boolean
Overrides AbstractDOMAdaptor.hasAttribute
- Defined in ts/adaptors/liteAdaptor.ts:589

hasClass

hasClass(node: LiteElement, name: string): boolean
Parameters
- node: LiteElement
- name: string
Returns boolean
Overrides AbstractDOMAdaptor.hasClass
- Defined in ts/adaptors/liteAdaptor.ts:631

head

head(doc?: LiteDocument): LiteElement
Parameters
- doc: LiteDocument = ...
Returns LiteElement
Overrides AbstractDOMAdaptor.head
- Defined in ts/adaptors/liteAdaptor.ts:119

innerHTML

innerHTML(node: LiteElement): string
Parameters
- node: LiteElement
Returns string
Overrides AbstractDOMAdaptor.innerHTML
- Defined in ts/adaptors/liteAdaptor.ts:533

insert

insert(nchild: LiteNode, ochild: LiteNode): void
Parameters
- nchild: LiteNode
- ochild: LiteNode
Returns void
Overrides AbstractDOMAdaptor.insert
- Defined in ts/adaptors/liteAdaptor.ts:379

insertRules

insertRules(node: LiteElement, rules: string[]): void
Parameters
- node: LiteElement
- rules: string[]
Returns void
Overrides AbstractDOMAdaptor.insertRules
- Defined in ts/adaptors/liteAdaptor.ts:671

kind

kind(node: LiteNode): string
Parameters
- node: LiteNode
Returns string
Overrides AbstractDOMAdaptor.kind
- Defined in ts/adaptors/liteAdaptor.ts:499

lastChild

lastChild(node: LiteElement): LiteNode
Parameters
- node: LiteElement
Returns LiteNode
Overrides AbstractDOMAdaptor.lastChild
- Defined in ts/adaptors/liteAdaptor.ts:478

next(node: LiteNode): LiteNode
Parameters
- node: LiteNode
Returns LiteNode
Overrides AbstractDOMAdaptor.next
- Defined in ts/adaptors/liteAdaptor.ts:451

node

node(
    kind: string,
    def?: OptionList,
    children?: (LiteText | LiteElement)[],
    ns?: string,
): LiteElement
Parameters
- kind: string
- def: OptionList = {}
- children: (LiteText | LiteElement)[] = []
- Optionalns: string
Returns LiteElement
Inherited from AbstractDOMAdaptor.node
- Defined in ts/core/DOMAdaptor.ts:462

nodeBBox

nodeBBox(
_node: LiteElement,
): { bottom: number; left: number; right: number; top: number }
Parameters
- _node: LiteElement
Returns { bottom: number; left: number; right: number; top: number }
Overrides AbstractDOMAdaptor.nodeBBox
- Defined in ts/adaptors/liteAdaptor.ts:706

nodeSize

nodeSize(_node: LiteElement, _em?: number, _local?: boolean): [number, number]
Parameters
- _node: LiteElement
- _em: number = 1
- _local: boolean = null
Returns [number, number]
Overrides AbstractDOMAdaptor.nodeSize
- Defined in ts/adaptors/liteAdaptor.ts:699

outerHTML

outerHTML(node: LiteElement): string
Parameters
- node: LiteElement
Returns string
Overrides AbstractDOMAdaptor.outerHTML
- Defined in ts/adaptors/liteAdaptor.ts:540

parent

parent(node: LiteNode): LiteElement
Parameters
- node: LiteNode
Returns LiteElement
Overrides AbstractDOMAdaptor.parent
- Defined in ts/adaptors/liteAdaptor.ts:352

parse

parse(text: string, format?: string): LiteDocument
Parameters
- text: string
- Optionalformat: string
Returns LiteDocument
Overrides AbstractDOMAdaptor.parse
- Defined in ts/adaptors/liteAdaptor.ts:83

previous(node: LiteNode): LiteNode
Parameters
- node: LiteNode
Returns LiteNode
Overrides AbstractDOMAdaptor.previous
- Defined in ts/adaptors/liteAdaptor.ts:461

remove

remove(child: LiteNode): LiteNode
Parameters
- child: LiteNode
Returns LiteNode
Overrides AbstractDOMAdaptor.remove
- Defined in ts/adaptors/liteAdaptor.ts:393

removeAttribute

removeAttribute(node: LiteElement, name: string): void
Parameters
- node: LiteElement
- name: string
Returns void
Overrides AbstractDOMAdaptor.removeAttribute
- Defined in ts/adaptors/liteAdaptor.ts:582

removeClass

removeClass(node: LiteElement, name: string): void
Parameters
- node: LiteElement
- name: string
Returns void
Overrides AbstractDOMAdaptor.removeClass
- Defined in ts/adaptors/liteAdaptor.ts:619

replace

replace(nnode: LiteNode, onode: LiteNode): LiteNode
Parameters
- nnode: LiteNode
- onode: LiteNode
Returns LiteNode
Overrides AbstractDOMAdaptor.replace
- Defined in ts/adaptors/liteAdaptor.ts:405

root

root(doc?: LiteDocument): LiteElement
Parameters
- doc: LiteDocument = ...
Returns LiteElement
Overrides AbstractDOMAdaptor.root
- Defined in ts/adaptors/liteAdaptor.ts:133

serializeXML

serializeXML(node: LiteElement): string
Parameters
- node: LiteElement
Returns string
Overrides AbstractDOMAdaptor.serializeXML
- Defined in ts/adaptors/liteAdaptor.ts:547

setAttribute

setAttribute(
    node: LiteElement,
    name: string,
    value: string | number,
    ns?: string,
): void
Parameters
- node: LiteElement
- name: string
- value: string | number
- ns: string = null
Returns void
Overrides AbstractDOMAdaptor.setAttribute
- Defined in ts/adaptors/liteAdaptor.ts:554

setAttributes

setAttributes(node: LiteElement, def: OptionList): void
Parameters
- node: LiteElement
  The HTML element whose attributes are to be set
- def: OptionList
  The attributes to set on that node
Returns void
Inherited from AbstractDOMAdaptor.setAttributes
- Defined in ts/core/DOMAdaptor.ts:506

setProperty

setProperty(node: LiteElement, name: string, value: any): void
Parameters
- node: LiteElement
- name: string
- value: any
Returns void
Inherited from AbstractDOMAdaptor.setProperty
- Defined in ts/core/DOMAdaptor.ts:491

setStyle

setStyle(node: LiteElement, name: string, value: string): void
Parameters
- node: LiteElement
- name: string
- value: string
Returns void
Overrides AbstractDOMAdaptor.setStyle
- Defined in ts/adaptors/liteAdaptor.ts:639

split

split(node: LiteText, n: number): LiteText
Parameters
- node: LiteText
- n: number
Returns LiteText
Overrides AbstractDOMAdaptor.split
- Defined in ts/adaptors/liteAdaptor.ts:440

text

text(text: string): LiteText
Parameters
- text: string
Returns LiteText
Overrides AbstractDOMAdaptor.text
- Defined in ts/adaptors/liteAdaptor.ts:97

textContent

textContent(node: LiteElement): string
Parameters
- node: LiteElement
Returns string
Overrides AbstractDOMAdaptor.textContent
- Defined in ts/adaptors/liteAdaptor.ts:517

value

value(node: LiteNode): string
Parameters
- node: LiteNode
Returns string
Overrides AbstractDOMAdaptor.value
- Defined in ts/adaptors/liteAdaptor.ts:506

Class LiteBase

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LiteBase

Properties

canMeasureNodes

document

parser

window

Methods

addClass

Parameters

Returns void

allAttributes

Parameters

Returns { name: string; value: string }[]

allClasses

Parameters

Returns string[]

allStyles

Parameters

Returns any

append

Parameters

Returns LiteNode

body

Parameters

Returns LiteElement

childIndex

Parameters

Returns number

childNode

Parameters

Returns LiteNode

childNodes

Parameters

Returns LiteNode[]

clone

Parameters

Returns LiteElement

comment

Parameters

Returns LiteComment

contains

Parameters

Returns boolean

Protectedcreate

Parameters

Returns LiteElement

createDocument

Returns LiteDocument

createWorker

Parameters

Returns Promise<minWorker>

cssText

Parameters

Returns string

doctype

Parameters

Returns string

elementById

Parameters

Returns LiteElement

elementsByAttribute

Parameters

Returns LiteElement[]

elementsByClass

Parameters

Returns LiteElement[]

firstChild

Parameters

Returns LiteNode

fontFamily

Parameters

Returns string

`Protected`create