@vivliostyle/core
    Preparing search index...

    Interface ParentPageFloatLayoutContext

    Only the root and an attached context can be one, and only these hold children.

    interface ParentPageFloatLayoutContext {
        children: readonly PageFloats.AttachedPageFloatLayoutContext[];
        direction: Val;
        effectiveParent: PageFloats.PageFloatLayoutContext;
        floatFragments: PageFloats.PageFloatFragment[];
        flowName: string;
        generatingNodePosition: Vtree.NodePosition;
        ignoreFootnoteAreaMaxHeight: boolean;
        parent: PageFloats.PageFloatLayoutContext;
        addLayoutConstraint(
            layoutConstraint: Layout.LayoutConstraint,
            floatReference: PageFloats.FloatReference,
        ): void;
        addPageFloat(float: PageFloats.PageFloat): void;
        attachChildren(children: PageFloats.AttachedPageFloatLayoutContext[]): void;
        collectPageFloatAnchors(): any;
        deferPageFloat(continuation: PageFloats.PageFloatContinuation): void;
        detachChildren(): PageFloats.AttachedPageFloatLayoutContext[];
        discardStashedFragments(floatReference: PageFloats.FloatReference): void;
        findPageFloatByNodePosition(
            nodePosition: Vtree.NodePosition,
        ): PageFloats.PageFloat;
        findPageFloatFragment(
            float: PageFloats.PageFloat,
        ): PageFloats.PageFloatFragment;
        getDeferredPageFloatContinuations(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getFloatFragmentExclusions(): Shape[];
        getFloatsDeferredToNextInChildContexts(): PageFloats.PageFloat[];
        getLayoutConstraints(): Layout.LayoutConstraint[];
        getPageFloatContinuationsDeferredToNext(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getPageFloatLayoutContext(
            floatReference: PageFloats.FloatReference,
        ): PageFloats.PageFloatLayoutContext;
        getStashedFloatFragments(
            floatReference: PageFloats.FloatReference,
        ): PageFloats.PageFloatFragment[];
        hasContinuingFloatFragmentsInFlow(flowName: string): boolean;
        hasFloatFragments(
            condition?: (p1: PageFloats.PageFloatFragment) => boolean,
        ): boolean;
        hasPrecedingFloatsDeferredToNext(
            float: PageFloats.PageFloat,
            ignoreReference?: boolean,
        ): boolean;
        isForbidden(float: PageFloats.PageFloat): boolean;
        isInvalidated(): boolean;
        isLocked(): boolean;
        lock(): void;
        markPageFloatAnchorSeen(float: PageFloats.PageFloat): void;
        registerPageFloatAnchor(
            float: PageFloats.PageFloat,
            anchorViewNode: Node,
        ): void;
        removeFloatDeferredToNext(float: PageFloats.PageFloat): void;
        unlock(): void;
        validate(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    children direction effectiveParent floatFragments flowName generatingNodePosition ignoreFootnoteAreaMaxHeight parent

    Methods

    addLayoutConstraint addPageFloat attachChildren collectPageFloatAnchors deferPageFloat detachChildren discardStashedFragments findPageFloatByNodePosition findPageFloatFragment getDeferredPageFloatContinuations getFloatFragmentExclusions getFloatsDeferredToNextInChildContexts getLayoutConstraints getPageFloatContinuationsDeferredToNext getPageFloatLayoutContext getStashedFloatFragments hasContinuingFloatFragmentsInFlow hasFloatFragments hasPrecedingFloatsDeferredToNext isForbidden isInvalidated isLocked lock markPageFloatAnchorSeen registerPageFloatAnchor removeFloatDeferredToNext unlock validate

    Properties

    children: readonly PageFloats.AttachedPageFloatLayoutContext[]
    direction: Val
    effectiveParent: PageFloats.PageFloatLayoutContext
    floatFragments: PageFloats.PageFloatFragment[]
    flowName: string
    generatingNodePosition: Vtree.NodePosition
    ignoreFootnoteAreaMaxHeight: boolean
    parent: PageFloats.PageFloatLayoutContext

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods