Class PageFloatLayoutContext`Abstract`

Param: generatingNodePosition

Source NodePosition generating the context. Specify when a column context is generated by a non-root element (for example page floats)

Hierarchy (View Summary)

PageFloatLayoutContext
- UnattachedPageFloatLayoutContext
- ParentPageFloatLayoutContext

Implements

PageFloats.PageFloatLayoutContext

Index

Constructors

`Protected`constructor

new PageFloatLayoutContext(
identity: PageFloatContextIdentity,
state?: PageFloatContextState,
): PageFloatLayoutContext
Parameters
- identity: PageFloatContextIdentity
- Optionalstate: PageFloatContextState
Returns PageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:532

Properties

`Readonly`direction

direction: Val

`Protected` `Readonly`floatReference

floatReference: PageFloats.FloatReference

`Protected` `Readonly`floatStore

floatStore: PageFloatStore

`Readonly`flowName

flowName: string

`Readonly`generatingNodePosition

generatingNodePosition: Vtree.NodePosition

`Protected` `Readonly`outerContext

outerContext: AttachedPageFloatLayoutContext

Reference to the outer column's context for page float area contexts. Used only for getParent() navigation to propagate nested page floats and footnotes to region/page level. Unlike parent, this does NOT affect children registration, isInvalidated() propagation, or getFloatFragmentExclusions(). (Issue #1675)

`Readonly`pageSide

pageSide: PageSide

Null on the root context and on a TOC box, which has no page side.

`Readonly`parent

parent: ParentPageFloatLayoutContext

`Protected` `Readonly`state

state: PageFloatContextState

`Readonly`writingMode

writingMode: Val

Accessors

effectiveParent

get effectiveParent(): PageFloatLayoutContext
Returns the effective parent context for hierarchy traversal. For normal contexts, returns parent. For page float area contexts (where parent is null), falls back to outerContext. (Issue #1675)

Returns PageFloatLayoutContext
Implementation of PageFloatLayoutContext.effectiveParent
- Defined in src/vivliostyle/page-floats.ts:732

floatFragments

get floatFragments(): PageFloatFragment[]
Returns PageFloatFragment[]
Implementation of PageFloatLayoutContext.floatFragments
- Defined in src/vivliostyle/page-floats.ts:707

footnoteMaxBlockSize

get footnoteMaxBlockSize(): number
Returns number
- Defined in src/vivliostyle/page-floats.ts:711
set footnoteMaxBlockSize(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vivliostyle/page-floats.ts:715

ignoreFootnoteAreaMaxHeight

get ignoreFootnoteAreaMaxHeight(): boolean
Returns boolean
Implementation of PageFloatLayoutContext.ignoreFootnoteAreaMaxHeight
- Defined in src/vivliostyle/page-floats.ts:719
set ignoreFootnoteAreaMaxHeight(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of PageFloatLayoutContext.ignoreFootnoteAreaMaxHeight
- Defined in src/vivliostyle/page-floats.ts:723

Methods

addLayoutConstraint

addLayoutConstraint(
layoutConstraint: Layout.LayoutConstraint,
floatReference: PageFloats.FloatReference,
): void
Parameters
- layoutConstraint: Layout.LayoutConstraint
- floatReference: PageFloats.FloatReference
Returns void
Implementation of PageFloatLayoutContext.addLayoutConstraint
- Defined in src/vivliostyle/page-floats.ts:1068

addPageFloat

addPageFloat(float: PageFloat): void
Parameters
- float: PageFloat
Returns void
Implementation of PageFloatLayoutContext.addPageFloat
- Defined in src/vivliostyle/page-floats.ts:770

deferPageFloat

deferPageFloat(continuation: PageFloatContinuation): void
Parameters
- continuation: PageFloatContinuation
Returns void
Implementation of PageFloatLayoutContext.deferPageFloat
- Defined in src/vivliostyle/page-floats.ts:890

discardStashedFragments

discardStashedFragments(floatReference: PageFloats.FloatReference): void
Parameters
- floatReference: PageFloats.FloatReference
Returns void
Implementation of PageFloatLayoutContext.discardStashedFragments
- Defined in src/vivliostyle/page-floats.ts:1030

findPageFloatByNodePosition

findPageFloatByNodePosition(nodePosition: Vtree.NodePosition): PageFloat
Parameters
- nodePosition: Vtree.NodePosition
Returns PageFloat
Implementation of PageFloatLayoutContext.findPageFloatByNodePosition
- Defined in src/vivliostyle/page-floats.ts:785

findPageFloatFragment

findPageFloatFragment(float: PageFloat): PageFloatFragment
Parameters
- float: PageFloat
Returns PageFloatFragment
Implementation of PageFloatLayoutContext.findPageFloatFragment
- Defined in src/vivliostyle/page-floats.ts:802

getDeferredPageFloatContinuations

getDeferredPageFloatContinuations(flowName?: string): PageFloatContinuation[]
Parameters
- OptionalflowName: string
Returns PageFloatContinuation[]
Implementation of PageFloatLayoutContext.getDeferredPageFloatContinuations
- Defined in src/vivliostyle/page-floats.ts:965

getFloatFragmentExclusions

getFloatFragmentExclusions(): Shape[]
Returns Shape[]
Implementation of PageFloatLayoutContext.getFloatFragmentExclusions
- Defined in src/vivliostyle/page-floats.ts:1052

getLastFollowingFloatInFragments

getLastFollowingFloatInFragments(float: PageFloat): PageFloat
Parameters
- float: PageFloat
Returns PageFloat
- Defined in src/vivliostyle/page-floats.ts:939

getLayoutConstraints

getLayoutConstraints(): Layout.LayoutConstraint[]
Returns Layout.LayoutConstraint[]
Implementation of PageFloatLayoutContext.getLayoutConstraints
- Defined in src/vivliostyle/page-floats.ts:1063

getPageFloatContinuationsDeferredToNext

getPageFloatContinuationsDeferredToNext(
flowName?: string,
): PageFloatContinuation[]
Parameters
- OptionalflowName: string
Returns PageFloatContinuation[]
Implementation of PageFloatLayoutContext.getPageFloatContinuationsDeferredToNext
- Defined in src/vivliostyle/page-floats.ts:980

getPageFloatLayoutContext

getPageFloatLayoutContext(
floatReference: PageFloats.FloatReference,
): PageFloatLayoutContext
Parameters
- floatReference: PageFloats.FloatReference
Returns PageFloatLayoutContext
Implementation of PageFloatLayoutContext.getPageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:774

`Protected`getParent

getParent(floatReference: PageFloats.FloatReference): PageFloatLayoutContext
Parameters
- floatReference: PageFloats.FloatReference
Returns PageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:736

`Protected`getPreviousSibling

getPreviousSibling(): AttachedPageFloatLayoutContext
Returns AttachedPageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:750

getStashedFloatFragments

getStashedFloatFragments(
floatReference: PageFloats.FloatReference,
): PageFloatFragment[]
Parameters
- floatReference: PageFloats.FloatReference
Returns PageFloatFragment[]
Implementation of PageFloatLayoutContext.getStashedFloatFragments
- Defined in src/vivliostyle/page-floats.ts:1038

hasContinuingFloatFragmentsInFlow

hasContinuingFloatFragmentsInFlow(flowName: string): boolean
Parameters
- flowName: string
Returns boolean
Implementation of PageFloatLayoutContext.hasContinuingFloatFragmentsInFlow
- Defined in src/vivliostyle/page-floats.ts:828

hasFloatFragments

hasFloatFragments(condition?: (p1: PageFloatFragment) => boolean): boolean
Parameters
- Optionalcondition: (p1: PageFloatFragment) => boolean
Returns boolean
Implementation of PageFloatLayoutContext.hasFloatFragments
- Defined in src/vivliostyle/page-floats.ts:815

hasInvalidatedForLineFootnote

hasInvalidatedForLineFootnote(float: PageFloat): boolean
Whether this footnote-policy: line footnote has already triggered invalidation (body reflow) at the current retry size. (Issue #2024, #2026)
Parameters
- float: PageFloat
Returns boolean
- Defined in src/vivliostyle/page-floats.ts:860

hasPrecedingFloatsDeferredToNext

hasPrecedingFloatsDeferredToNext(
float: PageFloat,
ignoreReference?: boolean,
): boolean
Parameters
- float: PageFloat
- OptionalignoreReference: boolean
Returns boolean
Implementation of PageFloatLayoutContext.hasPrecedingFloatsDeferredToNext
- Defined in src/vivliostyle/page-floats.ts:916

`Protected`identity

identity(): PageFloatContextIdentity
Returns PageFloatContextIdentity
- Defined in src/vivliostyle/page-floats.ts:693

isForbidden

isForbidden(float: PageFloat): boolean
Parameters
- float: PageFloat
Returns boolean
Implementation of PageFloatLayoutContext.isForbidden
- Defined in src/vivliostyle/page-floats.ts:791

isInvalidated

isInvalidated(): any
Returns any
Implementation of PageFloatLayoutContext.isInvalidated
- Defined in src/vivliostyle/page-floats.ts:1008

isLocked

isLocked(): boolean
Returns boolean
Implementation of PageFloatLayoutContext.isLocked
- Defined in src/vivliostyle/page-floats.ts:1090

lock

lock(): void
Returns void
Implementation of PageFloatLayoutContext.lock
- Defined in src/vivliostyle/page-floats.ts:1082

markInvalidatedForLineFootnote

markInvalidatedForLineFootnote(float: PageFloat): void
Mark that this footnote-policy: line footnote has triggered invalidation at the current retry size, so subsequent placements suppress redundant invalidation. (Issue #2024, #2026)
Parameters
- float: PageFloat
Returns void
- Defined in src/vivliostyle/page-floats.ts:877

markPageFloatAnchorSeen

markPageFloatAnchorSeen(float: PageFloat): void
Parameters
- float: PageFloat
Returns void
Implementation of PageFloatLayoutContext.markPageFloatAnchorSeen
- Defined in src/vivliostyle/page-floats.ts:837

registerPageFloatAnchor

registerPageFloatAnchor(float: PageFloat, anchorViewNode: Node): void
Parameters
- float: PageFloat
- anchorViewNode: Node
Returns void
Implementation of PageFloatLayoutContext.registerPageFloatAnchor
- Defined in src/vivliostyle/page-floats.ts:848

removeFloatDeferredToNext

removeFloatDeferredToNext(float: PageFloat): void
Parameters
- float: PageFloat
Returns void
Implementation of PageFloatLayoutContext.removeFloatDeferredToNext
- Defined in src/vivliostyle/page-floats.ts:907

`Protected`toLogical

toLogical(side: string): string
Parameters
- side: string
Returns string
- Defined in src/vivliostyle/page-floats.ts:1018

`Protected`toLogicalFloatSides

toLogicalFloatSides(floatSide: string): string[]
Parameters
- floatSide: string
Returns string[]
- Defined in src/vivliostyle/page-floats.ts:1026

`Protected`toPhysical

toPhysical(side: string): string
Parameters
- side: string
Returns string
- Defined in src/vivliostyle/page-floats.ts:1022

`Protected`trySetFootnoteRetryMaxBlockSize

trySetFootnoteRetryMaxBlockSize(currentOuter: number): boolean
Parameters
- currentOuter: number
Returns boolean
- Defined in src/vivliostyle/page-floats.ts:996

unlock

unlock(): void
Returns void
Implementation of PageFloatLayoutContext.unlock
- Defined in src/vivliostyle/page-floats.ts:1086

validate

validate(): void
Returns void
Implementation of PageFloatLayoutContext.validate
- Defined in src/vivliostyle/page-floats.ts:1014

`Protected` `Static`buildIdentity

buildIdentity(
    parent: ParentPageFloatLayoutContext,
    floatReference: PageFloats.FloatReference,
    flowName: string,
    generatingNodePosition: Vtree.NodePosition,
    writingMode: Val,
    direction: Val,
    outerContext: AttachedPageFloatLayoutContext,
    pageSide: PageSide,
): PageFloatContextIdentity
Parameters
- parent: ParentPageFloatLayoutContext
- floatReference: PageFloats.FloatReference
- flowName: string
- generatingNodePosition: Vtree.NodePosition
- writingMode: Val
- direction: Val
- outerContext: AttachedPageFloatLayoutContext
- pageSide: PageSide
Returns PageFloatContextIdentity
- Defined in src/vivliostyle/page-floats.ts:548

`Static`create

create(
    parent: ParentPageFloatLayoutContext,
    floatReference: PageFloats.FloatReference,
    flowName: string,
    generatingNodePosition: Vtree.NodePosition,
    writingMode: Val,
    direction: Val,
    outerContext?: AttachedPageFloatLayoutContext,
    pageSide?: PageSide,
): UnattachedPageFloatLayoutContext
Parameters
- parent: ParentPageFloatLayoutContext
- floatReference: PageFloats.FloatReference
- flowName: string
- generatingNodePosition: Vtree.NodePosition
- writingMode: Val
- direction: Val
- outerContext: AttachedPageFloatLayoutContext = null
- pageSide: PageSide = null
Returns UnattachedPageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:627

`Static`createDetached

createDetached(
    outerContext: AttachedPageFloatLayoutContext,
    floatReference: PageFloats.FloatReference,
    flowName: string,
    generatingNodePosition: Vtree.NodePosition,
): UnattachedPageFloatLayoutContext
A page float area takes no part in invalidation or exclusions, and reaches its surroundings through its column instead. (Issue #1675)
Parameters
- outerContext: AttachedPageFloatLayoutContext
- floatReference: PageFloats.FloatReference
- flowName: string
- generatingNodePosition: Vtree.NodePosition
Returns UnattachedPageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:607

`Static`createWithContainer

createWithContainer(
    container: Vtree.Container,
    parent: ParentPageFloatLayoutContext,
    floatReference: PageFloats.FloatReference,
    flowName: string,
    generatingNodePosition: Vtree.NodePosition,
    writingMode: Val,
    direction: Val,
    outerContext?: AttachedPageFloatLayoutContext,
    pageSide?: PageSide,
): AttachedPageFloatLayoutContext
Parameters
- container: Vtree.Container
- parent: ParentPageFloatLayoutContext
- floatReference: PageFloats.FloatReference
- flowName: string
- generatingNodePosition: Vtree.NodePosition
- writingMode: Val
- direction: Val
- outerContext: AttachedPageFloatLayoutContext = null
- pageSide: PageSide = null
Returns AttachedPageFloatLayoutContext
- Defined in src/vivliostyle/page-floats.ts:650

`Protected` `Static`register

register(
parent: ParentPageFloatLayoutContext,
next: AttachedPageFloatLayoutContext,
): void
Parameters
- parent: ParentPageFloatLayoutContext
- next: AttachedPageFloatLayoutContext
Returns void
- Defined in src/vivliostyle/page-floats.ts:674

Class PageFloatLayoutContextAbstract

Param: generatingNodePosition

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns PageFloatLayoutContext

Properties

Readonlydirection

Protected ReadonlyfloatReference

Protected ReadonlyfloatStore

ReadonlyflowName

ReadonlygeneratingNodePosition

Protected ReadonlyouterContext

ReadonlypageSide

Readonlyparent

Protected Readonlystate

ReadonlywritingMode

Accessors

effectiveParent

Returns PageFloatLayoutContext

floatFragments

Returns PageFloatFragment[]

footnoteMaxBlockSize

Returns number

Parameters

Returns void

ignoreFootnoteAreaMaxHeight

Returns boolean

Parameters

Returns void

Methods

addLayoutConstraint

Parameters

Returns void

addPageFloat

Parameters

Returns void

deferPageFloat

Parameters

Returns void

discardStashedFragments

Parameters

Returns void

findPageFloatByNodePosition

Parameters

Returns PageFloat

findPageFloatFragment

Parameters

Returns PageFloatFragment

getDeferredPageFloatContinuations

Parameters

Returns PageFloatContinuation[]

getFloatFragmentExclusions

Returns Shape[]

getLastFollowingFloatInFragments

Parameters

Returns PageFloat

getLayoutConstraints

Returns Layout.LayoutConstraint[]

getPageFloatContinuationsDeferredToNext

Parameters

Returns PageFloatContinuation[]

getPageFloatLayoutContext

Parameters

Returns PageFloatLayoutContext

ProtectedgetParent

Parameters

Returns PageFloatLayoutContext

ProtectedgetPreviousSibling

Returns AttachedPageFloatLayoutContext

getStashedFloatFragments

Parameters

Returns PageFloatFragment[]

Class PageFloatLayoutContext`Abstract`

`Protected`constructor

`Readonly`direction

`Protected` `Readonly`floatReference

`Protected` `Readonly`floatStore

`Readonly`flowName

`Readonly`generatingNodePosition

`Protected` `Readonly`outerContext

`Readonly`pageSide

`Readonly`parent

`Protected` `Readonly`state

`Readonly`writingMode

`Protected`getParent

`Protected`getPreviousSibling

`Protected`identity

`Protected`toLogical

`Protected`toLogicalFloatSides

`Protected`toPhysical

`Protected`trySetFootnoteRetryMaxBlockSize

`Protected` `Static`buildIdentity

`Static`create

`Static`createDetached

`Static`createWithContainer

`Protected` `Static`register