Class CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

The OutputWrapperFactory class for creating OutputWrapper nodes

Type Parameters

N
The DOM node type
T
The DOM text node type
D
The DOM document type
JX extends CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>
The OutputJax type
WW extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The Wrapper type
WF extends CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The WrapperFactory type
WC extends CommonWrapperClass<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The WrapperClass type
CC extends CharOptions
The CharOptions type
VV extends VariantData<CC>
The VariantData type
DD extends DelimiterData
The DelimiterData type
FD extends FontData<CC, any, DD>
The FontData type
FC extends FontDataClass<CC, VV, DD>
The FontDataClass type

Hierarchy (View Summary)

AbstractWrapperFactory<MmlNode, MmlNodeClass, WW, WC>
- CommonWrapperFactory
  - ChtmlWrapperFactory
  - SvgWrapperFactory

Index

Constructors

constructor

new CommonWrapperFactory<
    N,
    T,
    D,
    JX extends CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
    WW extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
    WF extends
        CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
    WC extends CommonWrapperClass<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
    CC extends CharOptions,
    VV extends VariantData<CC>,
    DD extends DelimiterData,
    FD extends FontData<CC, any, DD>,
    FC extends FontDataClass<CC, VV, DD>,
>(
    nodes?: { [kind: string]: WC },
): CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Type Parameters
- N
- T
- D
- JX extends CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>
- WW extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
- WF extends CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
- WC extends CommonWrapperClass<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
- CC extends CharOptions
- VV extends VariantData<CC>
- DD extends DelimiterData
- FD extends FontData<CC, any, DD>
- FC extends FontDataClass<CC, VV, DD>
Parameters
- nodes: { [kind: string]: WC } = null
Returns CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Inherited from AbstractWrapperFactory.constructor
- Defined in ts/core/Tree/Factory.ts:149

Properties

defaultKind

defaultKind: string = 'unknown'

The default kind

jax

jax: JX = null

The output jax associated with this factory

`Protected`node

node: { [kind: string]: (...args: any[]) => WW } = {}

An object containing functions for creating the various node kinds

`Protected`nodeMap

nodeMap: Map<string, WC> = ...

The map of node kinds to node classes

`Static`defaultNodes

defaultNodes: {
    [kind: string]: CommonWrapperClass<
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
    >;
} = {}

The default list of wrapper nodes this factory can create (filled in by subclasses)

Accessors

Wrappers

get Wrappers(): object
Returns object
The list of node-creation functions
- Defined in ts/output/common/WrapperFactory.ts:85

Methods

create

create(kind: string, ...args: any[]): WW
Parameters
- kind: string
- ...args: any[]
Returns WW
Inherited from AbstractWrapperFactory.create
- Defined in ts/core/Tree/Factory.ts:161

deleteNodeClass

deleteNodeClass(kind: string): void
Parameters
- kind: string
Returns void
Inherited from AbstractWrapperFactory.deleteNodeClass
- Defined in ts/core/Tree/Factory.ts:186

getKinds

getKinds(): string[]
Returns string[]
Inherited from AbstractWrapperFactory.getKinds
- Defined in ts/core/Tree/Factory.ts:201

getNodeClass

getNodeClass(kind: string): WC
Parameters
- kind: string
Returns WC
Inherited from AbstractWrapperFactory.getNodeClass
- Defined in ts/core/Tree/Factory.ts:179

nodeIsKind

nodeIsKind(node: WW, kind: string): boolean
Parameters
- node: WW
- kind: string
Returns boolean
Inherited from AbstractWrapperFactory.nodeIsKind
- Defined in ts/core/Tree/Factory.ts:194

setNodeClass

setNodeClass(kind: string, nodeClass: WC): void
Parameters
- kind: string
- nodeClass: WC
Returns void
Inherited from AbstractWrapperFactory.setNodeClass
- Defined in ts/core/Tree/Factory.ts:168

wrap

wrap<TT extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC> = WW>(
node: MmlNode,
...args: any[],
): TT
Type Parameters
- TT extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC> = WW
Parameters
- node: MmlNode
- ...args: any[]
Returns TT
Inherited from AbstractWrapperFactory.wrap
- Defined in ts/core/Tree/WrapperFactory.ts:74

Class CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

Properties

defaultKind

jax

Protectednode

ProtectednodeMap

StaticdefaultNodes

Accessors

Wrappers

Returns object

Methods

create

Parameters

Returns WW

deleteNodeClass

Parameters

Returns void

getKinds

Returns string[]

getNodeClass

Parameters

Returns WC

nodeIsKind

Parameters

Returns boolean

setNodeClass

Parameters

Returns void

wrap

Type Parameters

Parameters

Returns TT

Settings

On This Page

`Protected`node

`Protected`nodeMap

`Static`defaultNodes