Interface LayoutContext

Styling, creating a single node's view, etc.

interface LayoutContext {
    addEventListener(
        type: string,
        listener: EventListener,
        capture?: boolean,
    ): void;
    applyFootnoteStyle(
        vertical: boolean,
        rtl: boolean,
        target: Element,
    ): boolean;
    applyPseudoelementStyle(
        nodeContext: Vtree.NodeContext,
        pseudoName: string,
        target: Element,
    ): void;
    clone(): Vtree.LayoutContext;
    convertLengthToPx(
        numeric: Numeric,
        viewNode: Node,
        clientLayout: Vtree.ClientLayout,
    ): number | Numeric;
    dispatchEvent(evt: Event): void;
    isSameNodePosition(
        nodePosition1: Vtree.NodePosition,
        nodePosition2: Vtree.NodePosition,
    ): boolean;
    nextInTree(
        nodeContext: Vtree.NodeContext,
        atUnforcedBreak?: boolean,
    ): Result<Vtree.NodeContext>;
    peelOff(
        nodeContext: Vtree.NodeContext,
        nodeOffset: number,
    ): Result<Vtree.NodeContext>;
    processFragmentedBlockEdge(nodeContext: Vtree.NodeContext): any;
    removeEventListener(
        type: string,
        listener: EventListener,
        capture?: boolean,
    ): void;
    setCurrent(
        nodeContext: Vtree.NodeContext,
        firstTime: boolean,
        atUnforcedBreak?: boolean,
    ): Result<boolean>;
    setViewRoot(viewRoot: Element, isFootnote: boolean): any;
}

Index

Methods

addEventListener applyFootnoteStyle applyPseudoelementStyle clone convertLengthToPx dispatchEvent isSameNodePosition nextInTree peelOff processFragmentedBlockEdge removeEventListener setCurrent setViewRoot

Methods

addEventListener

addEventListener(type: string, listener: EventListener, capture?: boolean): void
Parameters
- type: string
- listener: EventListener
- Optionalcapture: boolean
Returns void
- Defined in types.ts:1096

applyFootnoteStyle

applyFootnoteStyle(vertical: boolean, rtl: boolean, target: Element): boolean
Apply styles to footnote container.
Parameters
- vertical: boolean
- rtl: boolean
- target: Element
  element to apply styles to
Returns boolean
vertical
- Defined in types.ts:1067

applyPseudoelementStyle

applyPseudoelementStyle(
    nodeContext: Vtree.NodeContext,
    pseudoName: string,
    target: Element,
): void
Apply pseudo-element styles (if any).
Parameters
- nodeContext: Vtree.NodeContext
- pseudoName: string
- target: Element
  element to apply styles to
Returns void
- Defined in types.ts:1057

clone

clone(): Vtree.LayoutContext
Creates a functionally equivalent, but uninitialized layout context, suitable for building a separate column.

Returns Vtree.LayoutContext
- Defined in types.ts:1027

convertLengthToPx

convertLengthToPx(
    numeric: Numeric,
    viewNode: Node,
    clientLayout: Vtree.ClientLayout,
): number | Numeric
Parameters
- numeric: Numeric
- viewNode: Node
- clientLayout: Vtree.ClientLayout
Returns number | Numeric
- Defined in types.ts:1084

dispatchEvent

dispatchEvent(evt: Event): void
Parameters
- evt: Event
Returns void
- Defined in types.ts:1106

isSameNodePosition

isSameNodePosition(
nodePosition1: Vtree.NodePosition,
nodePosition2: Vtree.NodePosition,
): boolean
Returns if two NodePositions represents the same position in the document.
Parameters
- nodePosition1: Vtree.NodePosition
- nodePosition2: Vtree.NodePosition
Returns boolean
- Defined in types.ts:1092

nextInTree

nextInTree(
nodeContext: Vtree.NodeContext,
atUnforcedBreak?: boolean,
): Result<Vtree.NodeContext>
Moves to the next view node, creating it and appending it to the view tree if needed.
Parameters
- nodeContext: Vtree.NodeContext
- OptionalatUnforcedBreak: boolean
Returns Result<Vtree.NodeContext>
that corresponds to the next view node
- Defined in types.ts:1049

peelOff

peelOff(
nodeContext: Vtree.NodeContext,
nodeOffset: number,
): Result<Vtree.NodeContext>
Peel off innermost first-XXX pseudoelement, create and create view nodes after the end of that pseudoelement.
Parameters
- nodeContext: Vtree.NodeContext
- nodeOffset: number
Returns Result<Vtree.NodeContext>
- Defined in types.ts:1076

processFragmentedBlockEdge

processFragmentedBlockEdge(nodeContext: Vtree.NodeContext): any
Process a block-end edge of a fragmented block.
Parameters
- nodeContext: Vtree.NodeContext
Returns any
- Defined in types.ts:1083

removeEventListener

removeEventListener(
    type: string,
    listener: EventListener,
    capture?: boolean,
): void
Parameters
- type: string
- listener: EventListener
- Optionalcapture: boolean
Returns void
- Defined in types.ts:1101

setCurrent

setCurrent(
    nodeContext: Vtree.NodeContext,
    firstTime: boolean,
    atUnforcedBreak?: boolean,
): Result<boolean>
Set the current source node and create a view. Parameter firstTime is true (and possibly offsetInNode > 0) if node was broken on the previous page.
Parameters
- nodeContext: Vtree.NodeContext
- firstTime: boolean
- OptionalatUnforcedBreak: boolean
Returns Result<boolean>
true if children should be processed as well
- Defined in types.ts:1034

setViewRoot

setViewRoot(viewRoot: Element, isFootnote: boolean): any
Set the container element that holds view elements produced from the source.
Parameters
- viewRoot: Element
- isFootnote: boolean
Returns any
- Defined in types.ts:1043

Interface LayoutContext

Index

Methods

Methods

addEventListener

Parameters

Returns void

applyFootnoteStyle

Parameters

Returns boolean

applyPseudoelementStyle

Parameters

Returns void

clone

Returns Vtree.LayoutContext

convertLengthToPx

Parameters

Returns number | Numeric

dispatchEvent

Parameters

Returns void

isSameNodePosition

Parameters

Returns boolean

nextInTree

Parameters

Returns Result<Vtree.NodeContext>

peelOff

Parameters

Returns Result<Vtree.NodeContext>

processFragmentedBlockEdge

Parameters

Returns any

removeEventListener

Parameters

Returns void

setCurrent

Parameters

Returns Result<boolean>

setViewRoot

Parameters

Returns any

Settings

On This Page