Class ViewFactory

constructor

• new ViewFactory(
      flowName: string,
      context: Context,
      viewport: Viewport,
      styler: Styler,
      regionIds: string[],
      xmldoc: XmlDoc.XMLDocHolder,
      docFaces: DocumentFaces,
      footnoteStyle: ElementStyle,
      stylerProducer: StylerProducer,
      page: Page,
      customRenderer: CustomRenderer,
      fallbackMap: { [key: string]: string },
      documentURLTransformer: DocumentURLTransformer,
  ): ViewFactory

  Parameters

  • flowName: string
  • context: Context
  • viewport: Viewport
  • styler: Styler
  • regionIds: string[]
  • xmldoc: XmlDoc.XMLDocHolder
  • docFaces: DocumentFaces
  • footnoteStyle: ElementStyle
  • stylerProducer: StylerProducer
  • page: Page
  • customRenderer: CustomRenderer
  • fallbackMap: { [key: string]: string }
  • documentURLTransformer: DocumentURLTransformer

  Returns ViewFactory

Readonlycontext

ReadonlycustomRenderer

ReadonlydocFaces

document

ReadonlydocumentURLTransformer

exprContentListener

ReadonlyfallbackMap

ReadonlyflowName

ReadonlyfootnoteStyle

isFootnote

nodeContext

offsetInNode

Readonlypage

ReadonlyregionIds

sourceNode

Readonlystyler

ReadonlystylerProducer

viewNode

Readonlyviewport

viewRoot

Readonlyxmldoc

addImageFetchers

• addImageFetchers(bg: Val): void

  Parameters

  • bg: Val

  Returns void

applyComputedStyles

• applyComputedStyles(
      target: Element,
      computedStyle: { [key: string]: Val },
  ): void

  Parameters

  • target: Element
  • computedStyle: { [key: string]: Val }

  Returns void

applyFootnoteStyle

• applyFootnoteStyle(vertical: boolean, rtl: boolean, target: Element): boolean

  Parameters

  • vertical: boolean
  • rtl: boolean
  • target: Element

  Returns boolean

applyPseudoelementStyle

• applyPseudoelementStyle(
      nodeContext: NodeContext,
      pseudoName: string,
      target: Element,
  ): void

  Parameters

  • nodeContext: NodeContext
  • pseudoName: string
  • target: Element

  Returns void

clone

• clone(): Vtree.LayoutContext

  Returns Vtree.LayoutContext

computeStyle

• computeStyle(
      vertical: boolean,
      rtl: boolean,
      style: ElementStyle,
      computedStyle: { [key: string]: Val },
  ): boolean

  Parameters

  • vertical: boolean
  • rtl: boolean
  • style: ElementStyle
  • computedStyle: { [key: string]: Val }

  Returns boolean

  vertical

convertLengthToPx

• convertLengthToPx(
      numeric: Numeric,
      viewNode: Node,
      clientLayout: Vtree.ClientLayout,
  ): number | Numeric

  Parameters

  • numeric: Numeric
  • viewNode: Node
  • clientLayout: Vtree.ClientLayout

  Returns number | Numeric

createElement

• createElement(ns: string, tag: string): Element

  Parameters

  • ns: string
  • tag: string

  Returns Element

createNodeView

• createNodeView(firstTime: boolean, atUnforcedBreak: boolean): Result<boolean>

  Parameters

  • firstTime: boolean
  • atUnforcedBreak: boolean

  Returns Result<boolean>

  holding true if children should be processed

createPseudoelementShadow

• createPseudoelementShadow(
      element: Element,
      isRoot: boolean,
      cascStyle: ElementStyle,
      computedStyle: { [key: string]: Val },
      styler: AbstractStyler,
      context: Context,
      parentShadow: ShadowContext,
      subShadow: ShadowContext,
  ): ShadowContext

  Parameters

  • element: Element
  • isRoot: boolean
  • cascStyle: ElementStyle
  • computedStyle: { [key: string]: Val }
  • styler: AbstractStyler
  • context: Context
  • parentShadow: ShadowContext
  • subShadow: ShadowContext

  Returns ShadowContext

createRefShadow

• createRefShadow(
      href: string,
      type: Vtree.ShadowType,
      element: Element,
      parentShadow: ShadowContext,
      subShadow: ShadowContext,
  ): Result<ShadowContext>

  Parameters

  • href: string
  • type: Vtree.ShadowType
  • element: Element
  • parentShadow: ShadowContext
  • subShadow: ShadowContext

  Returns Result<ShadowContext>

createShadows

• createShadows(
      element: Element,
      isRoot: any,
      cascStyle: ElementStyle,
      computedStyle: { [key: string]: Val },
      styler: AbstractStyler,
      context: Context,
      shadowContext: ShadowContext,
  ): Result<ShadowContext>

  Parameters

  • element: Element
  • isRoot: any
  • cascStyle: ElementStyle
  • computedStyle: { [key: string]: Val }
  • styler: AbstractStyler
  • context: Context
  • shadowContext: ShadowContext

  Returns Result<ShadowContext>

getPseudoMap

• getPseudoMap(
      cascStyle: ElementStyle,
      regionIds: string[],
      isFootnote: boolean,
      nodeContext: NodeContext,
      context: Context,
  ): ElementStyleMap

  Parameters

  • cascStyle: ElementStyle
  • regionIds: string[]
  • isFootnote: boolean
  • nodeContext: NodeContext
  • context: Context

  Returns ElementStyleMap

inheritLangAttribute

• inheritLangAttribute(): void

  Returns void

isPseudoelement

• isPseudoelement(elem: any): boolean

  Parameters

  • elem: any

  Returns boolean

isSameNodePosition

• isSameNodePosition(
      nodePosition1: Vtree.NodePosition,
      nodePosition2: Vtree.NodePosition,
  ): boolean

  Parameters

  • nodePosition1: Vtree.NodePosition
  • nodePosition2: Vtree.NodePosition

  Returns boolean

isSameNodePositionStep

• isSameNodePositionStep(
      step1: Vtree.NodePositionStep,
      step2: Vtree.NodePositionStep,
  ): boolean

  Returns if two NodePositionStep are equivalent.

  Parameters

  • step1: Vtree.NodePositionStep
  • step2: Vtree.NodePositionStep

  Returns boolean

isSVGUrlAttribute

• isSVGUrlAttribute(attributeName: string): boolean

  Parameters

  • attributeName: string

  Returns boolean

isTransclusion

• isTransclusion(
      element: Element,
      elementStyle: ElementStyle,
      transclusionType: string,
  ): boolean

  Parameters

  • element: Element
  • elementStyle: ElementStyle
  • transclusionType: string

  Returns boolean

modifyElemDimensionWithImageResolution

• modifyElemDimensionWithImageResolution(
      images: {
          element: HTMLElement;
          fetcher: Fetcher<string>;
          image: HTMLElement;
      }[],
      imageResolution: number,
      computedStyle: { [key: string]: Val },
      isVertical: boolean,
  ): void

  Parameters

  • images: { element: HTMLElement; fetcher: Fetcher<string>; image: HTMLElement }[]
  • imageResolution: number
  • computedStyle: { [key: string]: Val }
  • isVertical: boolean

  Returns void

nextInTree

• nextInTree(
      position: NodeContext,
      atUnforcedBreak?: boolean,
  ): Result<NodeContext>

  Parameters

  • position: NodeContext
  • OptionalatUnforcedBreak: boolean

  Returns Result<NodeContext>

peelOff

• peelOff(nodeContext: NodeContext, nodeOffset: number): Result<NodeContext>

  Parameters

  • nodeContext: NodeContext
  • nodeOffset: number

  Returns Result<NodeContext>

processFragmentedBlockEdge

• processFragmentedBlockEdge(nodeContext: NodeContext): void

  Parameters

  • nodeContext: NodeContext

  Returns void

processShadowContent

• processShadowContent(pos: NodeContext): NodeContext

  Parameters

  • pos: NodeContext

  Returns NodeContext

resolveFormattingContext

• resolveFormattingContext(
      nodeContext: NodeContext,
      firstTime: boolean,
      display: Val,
      position: Ident,
      float: Val,
      isRoot: boolean,
  ): void

  Parameters

  • nodeContext: NodeContext
  • firstTime: boolean
  • display: Val
  • position: Ident
  • float: Val
  • isRoot: boolean

  Returns void

resolveURL

• resolveURL(url: string): string

  Parameters

  • url: string

  Returns string

setCurrent

• setCurrent(
      nodeContext: NodeContext,
      firstTime: boolean,
      atUnforcedBreak?: boolean,
  ): Result<boolean>

  Parameters

  • nodeContext: NodeContext
  • firstTime: boolean
  • OptionalatUnforcedBreak: boolean

  Returns Result<boolean>

setViewRoot

• setViewRoot(viewRoot: Element, isFootnote: boolean): void

  Parameters

  • viewRoot: Element
  • isFootnote: boolean

  Returns void

transferPolyfilledInheritedProps

• transferPolyfilledInheritedProps(computedStyle: { [key: string]: Val }): void

  Parameters

  • computedStyle: { [key: string]: Val }

  Returns void