@vivliostyle/core
    Preparing search index...

    Interface PageFloatLayoutContext

    interface PageFloatLayoutContext {
        direction: Val;
        floatFragments: PageFloats.PageFloatFragment[];
        flowName: string;
        generatingNodePosition: Vtree.NodePosition;
        parent: PageFloats.PageFloatLayoutContext;
        writingMode: Val;
        addLayoutConstraint(
            layoutConstraint: Layout.LayoutConstraint,
            floatReference: PageFloats.FloatReference,
        ): void;
        addPageFloat(float: PageFloats.PageFloat): void;
        addPageFloatFragment(
            floatFragment: PageFloats.PageFloatFragment,
            dontInvalidate?: boolean,
        ): void;
        attachChildren(children: PageFloats.PageFloatLayoutContext[]): void;
        checkAndForbidFloatFollowingDeferredFloat(): boolean;
        checkAndForbidNotAllowedFloat(): boolean;
        collectPageFloatAnchors(): any;
        deferPageFloat(continuation: PageFloats.PageFloatContinuation): void;
        detachChildren(): PageFloats.PageFloatLayoutContext[];
        discardStashedFragments(floatReference: PageFloats.FloatReference): void;
        findPageFloatByNodePosition(
            nodePosition: Vtree.NodePosition,
        ): PageFloats.PageFloat;
        findPageFloatFragment(
            float: PageFloats.PageFloat,
        ): PageFloats.PageFloatFragment;
        finish(): void;
        getBlockStartEdgeOfBlockEndFloats(): number;
        getContainer(floatReference?: PageFloats.FloatReference): Vtree.Container;
        getDeferredPageFloatContinuations(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getFloatFragmentExclusions(): Shape[];
        getFloatsDeferredToNextInChildContexts(): PageFloats.PageFloat[];
        getLastFollowingFloatInFragments(
            float: PageFloats.PageFloat,
        ): 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.PageFloatLayoutContext;
        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.PageFloatLayoutContext): boolean;
        invalidate(): void;
        isAnchorAlreadyAppeared(floatId: string): boolean;
        isForbidden(float: PageFloats.PageFloat): boolean;
        isInvalidated(): boolean;
        isLocked(): boolean;
        lock(): void;
        registerPageFloatAnchor(
            float: PageFloats.PageFloat,
            anchorViewNode: Node,
        ): void;
        removeEndFloatFragments(floatSide: string): void;
        removePageFloatFragment(
            floatFragment: PageFloats.PageFloatFragment,
            dontInvalidate?: boolean,
        ): void;
        restoreStashedFragments(floatReference: PageFloats.FloatReference): void;
        setContainer(container: Vtree.Container): any;
        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;
    }

    Implemented by

    Index

    Properties

    direction floatFragments flowName generatingNodePosition parent writingMode

    Methods

    addLayoutConstraint addPageFloat addPageFloatFragment attachChildren checkAndForbidFloatFollowingDeferredFloat checkAndForbidNotAllowedFloat collectPageFloatAnchors deferPageFloat detachChildren discardStashedFragments findPageFloatByNodePosition findPageFloatFragment finish getBlockStartEdgeOfBlockEndFloats getContainer getDeferredPageFloatContinuations getFloatFragmentExclusions getFloatsDeferredToNextInChildContexts getLastFollowingFloatInFragments getLayoutConstraints getMaxBlockSizeOfPageFloats getMaxReachedAfterEdge getPageFloatClearEdge getPageFloatContinuationsDeferredToNext getPageFloatLayoutContext getPageFloatPlacementCondition getStashedFloatFragments hasContinuingFloatFragmentsInFlow hasFloatFragments hasPrecedingFloatsDeferredToNext hasSameContainerAs invalidate isAnchorAlreadyAppeared isForbidden isInvalidated isLocked lock registerPageFloatAnchor removeEndFloatFragments removePageFloatFragment restoreStashedFragments setContainer setFloatAreaDimensions stashEndFloatFragments unlock validate

    Properties

    direction: Val
    floatFragments: PageFloats.PageFloatFragment[]
    flowName: string
    generatingNodePosition: Vtree.NodePosition
    parent: PageFloats.PageFloatLayoutContext
    writingMode: Val

    Methods

    • Returns boolean

    • Returns boolean

    • Returns any

    • Returns number

    • Returns number

    • Returns number

    • Parameters

      • flowName: string

      Returns boolean

    • Parameters

      • floatId: string

      Returns boolean

    • Returns boolean

    • Parameters

      • floatSide: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addLayoutConstraintaddPageFloataddPageFloatFragmentattachChildrencheckAndForbidFloatFollowingDeferredFloatcheckAndForbidNotAllowedFloatcollectPageFloatAnchorsdeferPageFloatdetachChildrendiscardStashedFragmentsfindPageFloatByNodePositionfindPageFloatFragmentfinishgetBlockStartEdgeOfBlockEndFloatsgetContainergetDeferredPageFloatContinuationsgetFloatFragmentExclusionsgetFloatsDeferredToNextInChildContextsgetLastFollowingFloatInFragmentsgetLayoutConstraintsgetMaxBlockSizeOfPageFloatsgetMaxReachedAfterEdgegetPageFloatClearEdgegetPageFloatContinuationsDeferredToNextgetPageFloatLayoutContextgetPageFloatPlacementConditiongetStashedFloatFragmentshasContinuingFloatFragmentsInFlowhasFloatFragmentshasPrecedingFloatsDeferredToNexthasSameContainerAsinvalidateisAnchorAlreadyAppearedisForbiddenisInvalidatedisLockedlockregisterPageFloatAnchorremoveEndFloatFragmentsremovePageFloatFragmentrestoreStashedFragmentssetContainersetFloatAreaDimensionsstashEndFloatFragmentsunlockvalidate