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

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, VV, DD>
The FontData type
FC extends FontDataClass<CC, VV, DD>
The FontDataClass type

Hierarchy (View Summary)

Linebreaks<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
- LinebreakVisitor

Constructors

constructor

new LinebreakVisitor<
    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, VV, DD>,
    FC extends FontDataClass<CC, VV, DD>,
>(
    factory: Factory<WW, FactoryNodeClass<WW>>,
): LinebreakVisitor<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Create the node handler map by looking for methods with the correct names based on the node kinds available from the factory.
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, VV, DD>
- FC extends FontDataClass<CC, VV, DD>
Parameters
- factory: Factory<WW, FactoryNodeClass<WW>>
  The node factory for the kinds of nodes this visitor handles
Returns LinebreakVisitor<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Inherited from Linebreaks.constructor
- Defined in ts/core/Tree/Visitor.ts:145

Properties

`Protected`FACTORS

FACTORS: {
    [key: string]: (
        p: number,
        mo?: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
    ) => number;
} = ...

Penalties for other factors

`Protected`nodeHandlers

nodeHandlers: Map<string, VisitorFunction<WW>> = ...

Holds the mapping from node kinds to visitor funcitons

`Protected`PENALTY

PENALTY: { [key: string]: (p: number) => number } = ...

Penalty functions for the various linebreak values

`Protected`state

state: StateData<WW>

The state of the linebreaking process

`Protected`TEXCLASS

TEXCLASS: { [key: string]: (p: number) => number } = ...

Penalties for tex classes

Methods

`Protected`addWidth

addWidth(bbox: BBox, w?: number): void
Parameters
- bbox: BBox
  The BBox of the width to be added
- w: number = null
  The width to add (defaults to full width of bbox)
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:356

`Protected`breakLineToWidth

breakLineToWidth(wrapper: WW, i: number): void
Break a line to the given width
Parameters
- wrapper: WW
  The mrow to break
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:340

breakToWidth

breakToWidth(wrapper: WW, W: number): void
Break a line to the given width
Parameters
- wrapper: WW
  The mrow to break
- W: number
  The width to break to
Returns void
Overrides Linebreaks.breakToWidth
- Defined in ts/output/common/LinebreakVisitor.ts:290

`Protected`createState

createState(wrapper: WW): StateData<WW>
Parameters
- wrapper: WW
  The wrapper object
Returns StateData<WW>
The new state object
- Defined in ts/output/common/LinebreakVisitor.ts:319

`Protected`getBorderLR

getBorderLR(wrapper: WW): [number, number]
Parameters
- wrapper: WW
  The node whose border/padding is needed
Returns [number, number]
The left and right border+padding values
- Defined in ts/output/common/LinebreakVisitor.ts:424

`Protected`getFirstToken

getFirstToken(node: MmlNode): MmlNode
Parameters
- node: MmlNode
  The node to find the first token child for
Returns MmlNode
The first token child (at any depth) for the node
- Defined in ts/output/common/LinebreakVisitor.ts:438

`Protected`getLastToken

getLastToken(node: MmlNode): MmlNode
Parameters
- node: MmlNode
  The node to find the last token child for
Returns MmlNode
The last token child (at any depth) for the node
- Defined in ts/output/common/LinebreakVisitor.ts:446

`Protected`getPrevious

getPrevious(mo: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>): MmlNode
Parameters
- mo: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
  The mo whose preceeding mo node is needed
Returns MmlNode
The core mo if it exists
- Defined in ts/output/common/LinebreakVisitor.ts:602

`Protected`moPenalty

moPenalty(mo: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>): number
Parameters
- mo: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
  The mo whose penalty is to be computed
Returns number
The computed penalty
- Defined in ts/output/common/LinebreakVisitor.ts:570

`Protected`mspacePenalty

mspacePenalty(
mspace: CommonMspace<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
): number
Parameters
- mspace: CommonMspace<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
  The mspace whose penalty is to be computed
Returns number
The computed penalty
- Defined in ts/output/common/LinebreakVisitor.ts:649

`Protected`mtextPenalty

mtextPenalty(): number
Returns number
The computed penalty
- Defined in ts/output/common/LinebreakVisitor.ts:715

`Protected`processBreak

processBreak(): void
Mark the breakpoint(s) and get the current width

Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:372

`Protected`pushBreak

pushBreak(wrapper: WW, penalty: number, w: number, ij: [number, number]): void
Update the break list to include this break
Parameters
- wrapper: WW
  The mo/mspace that might be a breakpoint
- penalty: number
  The penalty for that break
- w: number
  The width+indent of the node after the break
- ij: [number, number]
  The child and character index, or null
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:399

removeNodeHandler

removeNodeHandler(kind: string): void
Parameters
- kind: string
Returns void
Inherited from Linebreaks.removeNodeHandler
- Defined in ts/core/Tree/Visitor.ts:192

setNodeHandler

setNodeHandler(kind: string, handler: VisitorFunction<WW>): void
Parameters
- kind: string
- handler: VisitorFunction<WW>
Returns void
Inherited from Linebreaks.setNodeHandler
- Defined in ts/core/Tree/Visitor.ts:185

visitDefault

visitDefault(wrapper: WW, i: number): void
Parameters
- wrapper: WW
- i: number
Returns void
Overrides Linebreaks.visitDefault
- Defined in ts/output/common/LinebreakVisitor.ts:471

visitInferredMrowNode

visitInferredMrowNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlInferredMrow wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:745

visitMactionNode

visitMactionNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMaction wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:920

visitMfencedNode

visitMfencedNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMfenced wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:898

visitMfracNode

visitMfracNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMFrac wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:757

visitMmultiscriptsNode

visitMmultiscriptsNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMmultiscripts wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:863

visitMoNode

visitMoNode(wrapper: WW, _i: number): void
Parameters
- wrapper: WW
  The MmlMo wrapper
- _i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:530

visitMrootNode

visitMrootNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMroot wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:795

visitMrowNode

visitMrowNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMrow wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:726

visitMspaceNode

visitMspaceNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMspace wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:624

visitMsqrtNode

visitMsqrtNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMsqrt wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:778

visitMsubNode

visitMsubNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMsub wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:805

visitMsubsupNode

visitMsubsupNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMsubsup wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:843

visitMsupNode

visitMsupNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMsup wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:824

visitMtextNode

visitMtextNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
  The MmlMspace wrapper
- i: number
  The line within that node to break
Returns void
- Defined in ts/output/common/LinebreakVisitor.ts:669

visitNode

visitNode(wrapper: WW, i: number): void
Parameters
- wrapper: WW
- i: number
Returns void
Overrides Linebreaks.visitNode
- Defined in ts/output/common/LinebreakVisitor.ts:457

visitTree

visitTree(tree: WW, ...args: any[]): any
Parameters
- tree: WW
- ...args: any[]
Returns any
Inherited from Linebreaks.visitTree
- Defined in ts/core/Tree/Visitor.ts:159

`Protected` `Static`methodName

methodName(kind: string): string
Visitor functions are named "visitKindNode" where "Kind" is replaced by the node kind; e.g., visitTextNode for kind = text.
Parameters
- kind: string
  The node kind whose method name is needed
Returns string
The name of the visitor method for the given node kind
Inherited from Linebreaks.methodName
- Defined in ts/core/Tree/Visitor.ts:127

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

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

ProtectedFACTORS

ProtectednodeHandlers

ProtectedPENALTY

Protectedstate

ProtectedTEXCLASS

Methods

ProtectedaddWidth

Parameters

Returns void

ProtectedbreakLineToWidth

Parameters

Returns void

breakToWidth

Parameters

Returns void

ProtectedcreateState

Parameters

Returns StateData<WW>

ProtectedgetBorderLR

Parameters

Returns [number, number]

ProtectedgetFirstToken

Parameters

Returns MmlNode

ProtectedgetLastToken

Parameters

Returns MmlNode

ProtectedgetPrevious

Parameters

Returns MmlNode

ProtectedmoPenalty

Parameters

Returns number

ProtectedmspacePenalty

Parameters

Returns number

ProtectedmtextPenalty

Returns number

ProtectedprocessBreak

Returns void

ProtectedpushBreak

Parameters

Returns void

removeNodeHandler

Parameters

Returns void

setNodeHandler

Parameters

Returns void

visitDefault

Parameters

Returns void

visitInferredMrowNode

Parameters

Returns void

visitMactionNode

Parameters

Returns void

visitMfencedNode

Parameters

Returns void

visitMfracNode

Parameters

Returns void

visitMmultiscriptsNode

Parameters

Returns void

`Protected`FACTORS

`Protected`nodeHandlers

`Protected`PENALTY

`Protected`state

`Protected`TEXCLASS

`Protected`addWidth

`Protected`breakLineToWidth

`Protected`createState

`Protected`getBorderLR

`Protected`getFirstToken

`Protected`getLastToken

`Protected`getPrevious

`Protected`moPenalty

`Protected`mspacePenalty

`Protected`mtextPenalty

`Protected`processBreak

`Protected`pushBreak

`Protected` `Static`methodName