Class PageFloatLayoutContext

Param: generatingNodePosition

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

Implements

PageFloats.PageFloatLayoutContext

Index

Constructors

constructor

new PageFloatLayoutContext(
    parent: PageFloatLayoutContext,
    floatReference: PageFloats.FloatReference,
    container: Vtree.Container,
    flowName: string,
    generatingNodePosition: Vtree.NodePosition,
    writingMode: Val,
    direction: Val,
): PageFloatLayoutContext
Parameters
- parent: PageFloatLayoutContext
- floatReference: PageFloats.FloatReference
- container: Vtree.Container
- flowName: string
- generatingNodePosition: Vtree.NodePosition
- writingMode: Val
- direction: Val
Returns PageFloatLayoutContext
- Defined in page-floats.ts:297

Properties

direction

direction: Val

floatFragments

floatFragments: PageFloatFragment[] = []

`Readonly`flowName

flowName: string

`Readonly`generatingNodePosition

generatingNodePosition: Vtree.NodePosition

`Readonly`parent

parent: PageFloatLayoutContext

writingMode

writingMode: Val

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 page-floats.ts:1734

addPageFloat

addPageFloat(float: PageFloat): void
Parameters
- float: PageFloat
Returns void
Implementation of PageFloatLayoutContext.addPageFloat
- Defined in page-floats.ts:394

addPageFloatFragment

addPageFloatFragment(
floatFragment: PageFloatFragment,
dontInvalidate?: boolean,
): void
Parameters
- floatFragment: PageFloatFragment
- OptionaldontInvalidate: boolean
Returns void
Implementation of PageFloatLayoutContext.addPageFloatFragment
- Defined in page-floats.ts:443

attachChildren

attachChildren(children: PageFloatLayoutContext[]): void
Parameters
- children: PageFloatLayoutContext[]
Returns void
Implementation of PageFloatLayoutContext.attachChildren
- Defined in page-floats.ts:788

checkAndForbidFloatFollowingDeferredFloat

checkAndForbidFloatFollowingDeferredFloat(): boolean
Returns boolean
Implementation of PageFloatLayoutContext.checkAndForbidFloatFollowingDeferredFloat
- Defined in page-floats.ts:681

checkAndForbidNotAllowedFloat

checkAndForbidNotAllowedFloat(): boolean
Returns boolean
Implementation of PageFloatLayoutContext.checkAndForbidNotAllowedFloat
- Defined in page-floats.ts:654

collectPageFloatAnchors

collectPageFloatAnchors(): any
Returns any
Implementation of PageFloatLayoutContext.collectPageFloatAnchors
- Defined in page-floats.ts:519

deferPageFloat

deferPageFloat(continuation: PageFloatContinuation): void
Parameters
- continuation: PageFloatContinuation
Returns void
Implementation of PageFloatLayoutContext.deferPageFloat
- Defined in page-floats.ts:543

detachChildren

detachChildren(): PageFloatLayoutContext[]
Returns PageFloatLayoutContext[]
Implementation of PageFloatLayoutContext.detachChildren
- Defined in page-floats.ts:775

discardStashedFragments

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

findPageFloatByNodePosition

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

findPageFloatFragment

findPageFloatFragment(float: PageFloat): PageFloatFragment
Parameters
- float: PageFloat
Returns PageFloatFragment
Implementation of PageFloatLayoutContext.findPageFloatFragment
- Defined in page-floats.ts:483

finish

finish(): void
Returns void
Implementation of PageFloatLayoutContext.finish
- Defined in page-floats.ts:709

getBlockStartEdgeOfBlockEndFloats

getBlockStartEdgeOfBlockEndFloats(): number
Returns number
Implementation of PageFloatLayoutContext.getBlockStartEdgeOfBlockEndFloats
- Defined in page-floats.ts:1506

getContainer

getContainer(floatReference?: PageFloats.FloatReference): Vtree.Container
Parameters
- OptionalfloatReference: PageFloats.FloatReference
Returns Vtree.Container
Implementation of PageFloatLayoutContext.getContainer
- Defined in page-floats.ts:382

getDeferredPageFloatContinuations

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

getFloatFragmentExclusions

getFloatFragmentExclusions(): Shape[]
Returns Shape[]
Implementation of PageFloatLayoutContext.getFloatFragmentExclusions
- Defined in page-floats.ts:1471

getFloatsDeferredToNextInChildContexts

getFloatsDeferredToNextInChildContexts(): PageFloat[]
Returns PageFloat[]
Implementation of PageFloatLayoutContext.getFloatsDeferredToNextInChildContexts
- Defined in page-floats.ts:639

getLastFollowingFloatInFragments

getLastFollowingFloatInFragments(float: PageFloat): PageFloat
Parameters
- float: PageFloat
Returns PageFloat
Implementation of PageFloatLayoutContext.getLastFollowingFloatInFragments
- Defined in page-floats.ts:582

getLayoutConstraints

getLayoutConstraints(): Layout.LayoutConstraint[]
Returns Layout.LayoutConstraint[]
Implementation of PageFloatLayoutContext.getLayoutConstraints
- Defined in page-floats.ts:1729

getMaxBlockSizeOfPageFloats

getMaxBlockSizeOfPageFloats(): number
Returns number
Implementation of PageFloatLayoutContext.getMaxBlockSizeOfPageFloats
- Defined in page-floats.ts:1798

getMaxReachedAfterEdge

getMaxReachedAfterEdge(): number
Returns number
Implementation of PageFloatLayoutContext.getMaxReachedAfterEdge
- Defined in page-floats.ts:1491

getPageFloatClearEdge

getPageFloatClearEdge(clear: string, column: Layout.Column): number
Parameters
- clear: string
- column: Layout.Column
Returns number
Implementation of PageFloatLayoutContext.getPageFloatClearEdge
- Defined in page-floats.ts:1523

getPageFloatContinuationsDeferredToNext

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

getPageFloatLayoutContext

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

getPageFloatPlacementCondition

getPageFloatPlacementCondition(
    float: PageFloat,
    floatSide: string,
    clearSide: string,
): PageFloats.PageFloatPlacementCondition
Parameters
- float: PageFloat
- floatSide: string
- clearSide: string
Returns PageFloats.PageFloatPlacementCondition
Implementation of PageFloatLayoutContext.getPageFloatPlacementCondition
- Defined in page-floats.ts:1615

getStashedFloatFragments

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

hasContinuingFloatFragmentsInFlow

hasContinuingFloatFragmentsInFlow(flowName: string): boolean
Parameters
- flowName: string
Returns boolean
Implementation of PageFloatLayoutContext.hasContinuingFloatFragmentsInFlow
- Defined in page-floats.ts:509

hasFloatFragments

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

hasPrecedingFloatsDeferredToNext

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

hasSameContainerAs

hasSameContainerAs(other: PageFloatLayoutContext): boolean
Parameters
- other: PageFloatLayoutContext
Returns boolean
Implementation of PageFloatLayoutContext.hasSameContainerAs
- Defined in page-floats.ts:736

invalidate

invalidate(): void
Returns void
Implementation of PageFloatLayoutContext.invalidate
- Defined in page-floats.ts:744

isAnchorAlreadyAppeared

isAnchorAlreadyAppeared(floatId: string): boolean
Parameters
- floatId: string
Returns boolean
Implementation of PageFloatLayoutContext.isAnchorAlreadyAppeared
- Defined in page-floats.ts:527

isColumnFullWithPageFloats

isColumnFullWithPageFloats(column: Layout.Column): boolean
Parameters
- column: Layout.Column
Returns boolean
- Defined in page-floats.ts:1748

isForbidden

isForbidden(float: PageFloat): boolean
Parameters
- float: PageFloat
Returns boolean
Implementation of PageFloatLayoutContext.isForbidden
- Defined in page-floats.ts:432

isInvalidated

isInvalidated(): any
Returns any
Implementation of PageFloatLayoutContext.isInvalidated
- Defined in page-floats.ts:795

isLocked

isLocked(): boolean
Returns boolean
Implementation of PageFloatLayoutContext.isLocked
- Defined in page-floats.ts:1824

lock

lock(): void
Returns void
Implementation of PageFloatLayoutContext.lock
- Defined in page-floats.ts:1816

registerPageFloatAnchor

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

removeEndFloatFragments

removeEndFloatFragments(floatSide: string): void
Parameters
- floatSide: string
Returns void
Implementation of PageFloatLayoutContext.removeEndFloatFragments
- Defined in page-floats.ts:878

removePageFloatFragment

removePageFloatFragment(
floatFragment: PageFloatFragment,
dontInvalidate?: boolean,
): void
Parameters
- floatFragment: PageFloatFragment
- OptionaldontInvalidate: boolean
Returns void
Implementation of PageFloatLayoutContext.removePageFloatFragment
- Defined in page-floats.ts:460

restoreStashedFragments

restoreStashedFragments(floatReference: PageFloats.FloatReference): void
Parameters
- floatReference: PageFloats.FloatReference
Returns void
Implementation of PageFloatLayoutContext.restoreStashedFragments
- Defined in page-floats.ts:932

setContainer

setContainer(container: Vtree.Container): void
Parameters
- container: Vtree.Container
Returns void
Implementation of PageFloatLayoutContext.setContainer
- Defined in page-floats.ts:389

setFloatAreaDimensions

setFloatAreaDimensions(
    area: Layout.PageFloatArea,
    floatReference: PageFloats.FloatReference,
    floatSide: string,
    anchorEdge: number,
    init: boolean,
    force: boolean,
    condition: PageFloats.PageFloatPlacementCondition,
): string
Parameters
- area: Layout.PageFloatArea
- floatReference: PageFloats.FloatReference
- floatSide: string
- anchorEdge: number
  Null indicates that the anchor is not in the current container.
- init: boolean
- force: boolean
- condition: PageFloats.PageFloatPlacementCondition
Returns string
Logical float side (snap-block is resolved when init=false). Null indicates that the float area does not fit inside the container
Implementation of PageFloatLayoutContext.setFloatAreaDimensions
- Defined in page-floats.ts:1198

stashEndFloatFragments

stashEndFloatFragments(float: PageFloat): void
Parameters
- float: PageFloat
Returns void
Implementation of PageFloatLayoutContext.stashEndFloatFragments
- Defined in page-floats.ts:896

unlock

unlock(): void
Returns void
Implementation of PageFloatLayoutContext.unlock
- Defined in page-floats.ts:1820

validate

validate(): void
Returns void
Implementation of PageFloatLayoutContext.validate
- Defined in page-floats.ts:799

Class PageFloatLayoutContext

Param: generatingNodePosition

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PageFloatLayoutContext

Properties

direction

floatFragments

ReadonlyflowName

ReadonlygeneratingNodePosition

Readonlyparent

writingMode

Methods

addLayoutConstraint

Parameters

Returns void

addPageFloat

Parameters

Returns void

addPageFloatFragment

Parameters

Returns void

attachChildren

Parameters

Returns void

checkAndForbidFloatFollowingDeferredFloat

Returns boolean

checkAndForbidNotAllowedFloat

Returns boolean

collectPageFloatAnchors

Returns any

deferPageFloat

Parameters

Returns void

detachChildren

Returns PageFloatLayoutContext[]

discardStashedFragments

Parameters

Returns void

findPageFloatByNodePosition

Parameters

Returns PageFloat

findPageFloatFragment

Parameters

Returns PageFloatFragment

finish

Returns void

getBlockStartEdgeOfBlockEndFloats

Returns number

getContainer

Parameters

Returns Vtree.Container

getDeferredPageFloatContinuations

Parameters

Returns PageFloatContinuation[]

getFloatFragmentExclusions

Returns Shape[]

getFloatsDeferredToNextInChildContexts

Returns PageFloat[]

getLastFollowingFloatInFragments

Parameters

Returns PageFloat

getLayoutConstraints

Returns Layout.LayoutConstraint[]

getMaxBlockSizeOfPageFloats

Returns number

getMaxReachedAfterEdge

Returns number

getPageFloatClearEdge

Parameters

Returns number

getPageFloatContinuationsDeferredToNext

Parameters

Returns PageFloatContinuation[]

`Readonly`flowName

`Readonly`generatingNodePosition

`Readonly`parent