@vivliostyle/core
    Preparing search index...

    Interface AttachedPageFloatLayoutContext

    Where a float goes can only be asked of a context bound to a container.

    interface AttachedPageFloatLayoutContext {
        children: readonly PageFloats.AttachedPageFloatLayoutContext[];
        container: Vtree.Container;
        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;
        addPageFloatFragment(
            floatFragment: PageFloats.PageFloatFragment,
            dontInvalidate?: boolean,
        ): 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;
        finish(): void;
        getBlockEndEdgeOfBlockStartFloats(inlinePos?: number): number;
        getBlockStartEdgeOfBlockEndFloats(inlinePos?: number): number;
        getDeferredPageFloatContinuations(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getFloatFragmentExclusions(): Shape[];
        getFloatsDeferredToNextInChildContexts(): PageFloats.PageFloat[];
        getLayoutConstraints(): Layout.LayoutConstraint[];
        getMaxBlockSizeOfPageFloats(): number;
        getMaxReachedAfterEdge(): number;
        getPageFloatClearEdge(clear: string, column: Layout.Column): number;
        getPageFloatContinuationsDeferredToNext(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getPageFloatLayoutContext(
            floatReference: PageFloats.FloatReference,
        ): PageFloats.AttachedPageFloatLayoutContext;
        getPageFloatPlacementCondition(
            float: PageFloats.PageFloat,
            floatSide: string,
            clearSide: string,
        ): PageFloats.PageFloatPlacementCondition;
        getStashedFloatFragments(
            floatReference: PageFloats.FloatReference,
        ): PageFloats.PageFloatFragment[];
        hasContinuingFloatFragmentsInFlow(flowName: string): boolean;
        hasFloatFragments(
            condition?: (p1: PageFloats.PageFloatFragment) => boolean,
        ): boolean;
        hasPrecedingFloatsDeferredToNext(
            float: PageFloats.PageFloat,
            ignoreReference?: boolean,
        ): boolean;
        hasSameContainerAs(
            other: PageFloats.AttachedPageFloatLayoutContext,
        ): boolean;
        initFootnoteRetryFromEmptyFragment(
            float: PageFloats.PageFloat,
            area: Layout.PageFloatArea,
        ): boolean;
        invalidate(): void;
        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;
        removePageFloatFragment(
            floatFragment: PageFloats.PageFloatFragment,
            dontInvalidate?: boolean,
        ): void;
        restoreStashedFragments(floatReference: PageFloats.FloatReference): void;
        setFloatAreaDimensions(
            area: Layout.PageFloatArea,
            floatReference: PageFloats.FloatReference,
            floatSide: string,
            anchorEdge: number,
            init: boolean,
            force: boolean,
            condition: PageFloats.PageFloatPlacementCondition,
        ): string;
        stashEndFloatFragments(float: PageFloats.PageFloat): void;
        unlock(): void;
        validate(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    children container direction effectiveParent floatFragments flowName generatingNodePosition ignoreFootnoteAreaMaxHeight parent

    Methods

    addLayoutConstraint addPageFloat addPageFloatFragment attachChildren collectPageFloatAnchors deferPageFloat detachChildren discardStashedFragments findPageFloatByNodePosition findPageFloatFragment finish getBlockEndEdgeOfBlockStartFloats getBlockStartEdgeOfBlockEndFloats getDeferredPageFloatContinuations getFloatFragmentExclusions getFloatsDeferredToNextInChildContexts getLayoutConstraints getMaxBlockSizeOfPageFloats getMaxReachedAfterEdge getPageFloatClearEdge getPageFloatContinuationsDeferredToNext getPageFloatLayoutContext getPageFloatPlacementCondition getStashedFloatFragments hasContinuingFloatFragmentsInFlow hasFloatFragments hasPrecedingFloatsDeferredToNext hasSameContainerAs initFootnoteRetryFromEmptyFragment invalidate isForbidden isInvalidated isLocked lock markPageFloatAnchorSeen registerPageFloatAnchor removeFloatDeferredToNext removePageFloatFragment restoreStashedFragments setFloatAreaDimensions stashEndFloatFragments unlock validate

    Properties

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

    Methods

    • Parameters

      • OptionalinlinePos: number

      Returns number

    • Parameters

      • OptionalinlinePos: number

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addLayoutConstraintaddPageFloataddPageFloatFragmentattachChildrencollectPageFloatAnchorsdeferPageFloatdetachChildrendiscardStashedFragmentsfindPageFloatByNodePositionfindPageFloatFragmentfinishgetBlockEndEdgeOfBlockStartFloatsgetBlockStartEdgeOfBlockEndFloatsgetDeferredPageFloatContinuationsgetFloatFragmentExclusionsgetFloatsDeferredToNextInChildContextsgetLayoutConstraintsgetMaxBlockSizeOfPageFloatsgetMaxReachedAfterEdgegetPageFloatClearEdgegetPageFloatContinuationsDeferredToNextgetPageFloatLayoutContextgetPageFloatPlacementConditiongetStashedFloatFragmentshasContinuingFloatFragmentsInFlowhasFloatFragmentshasPrecedingFloatsDeferredToNexthasSameContainerAsinitFootnoteRetryFromEmptyFragmentinvalidateisForbiddenisInvalidatedisLockedlockmarkPageFloatAnchorSeenregisterPageFloatAnchorremoveFloatDeferredToNextremovePageFloatFragmentrestoreStashedFragmentssetFloatAreaDimensionsstashEndFloatFragmentsunlockvalidate