@vivliostyle/core 2.24.3 → 2.25.0

package/lib/vivliostyle/layout-processor.d.ts

@@ -1,73 +1,73 @@
-import * as Task from "./task";
-import { FormattingContextType, Layout, LayoutProcessor, Vtree } from "./types";
-/**
- * Processor doing some special layout (e.g. table layout)
- */
-export interface LayoutProcessor {
-    /**
-     * Do actual layout in the column starting from given NodeContext.
-     */
-    layout(nodeContext: Vtree.NodeContext, column: Layout.Column, leadingEdge: boolean): Task.Result<Vtree.NodeContext>;
-    /**
-     * Potential edge breaking position.
-     */
-    createEdgeBreakPosition(position: Vtree.NodeContext, breakOnEdge: string | null, overflows: boolean, columnBlockSize: number): Layout.BreakPosition;
-    /**
-     * process nodecontext at the start of a non inline element.
-     * @return return true if you skip the subsequent nodes
-     */
-    startNonInlineElementNode(nodeContext: Vtree.NodeContext): boolean;
-    /**
-     * process nodecontext after a non inline element.
-     * @return return true if you skip the subsequent nodes
-     */
-    afterNonInlineElementNode(nodeContext: Vtree.NodeContext, stopAtOverflow: boolean): boolean;
-    /**
-     * @return holing true
-     */
-    finishBreak(column: Layout.Column, nodeContext: Vtree.NodeContext, forceRemoveSelf: boolean, endOfColumn: boolean): Task.Result<boolean>;
-    clearOverflownViewNodes(column: Layout.Column, parentNodeContext: Vtree.NodeContext, nodeContext: Vtree.NodeContext, removeSelf: boolean): any;
-}
-/**
- * Resolver finding an appropriate LayoutProcessor given a formatting context
- */
-export declare class LayoutProcessorResolver {
-    /**
-     * Find LayoutProcessor corresponding to given formatting context.
-     */
-    find(formattingContext: Vtree.FormattingContext): LayoutProcessor;
-}
-export declare class BlockLayoutProcessor implements LayoutProcessor {
-    /** @override */
-    layout(nodeContext: Vtree.NodeContext, column: Layout.Column, leadingEdge: boolean): Task.Result<Vtree.NodeContext>;
-    /** @override */
-    createEdgeBreakPosition(position: Vtree.NodeContext, breakOnEdge: string | null, overflows: boolean, columnBlockSize: number): Layout.BreakPosition;
-    /** @override */
-    startNonInlineElementNode(nodeContext: Vtree.NodeContext): boolean;
-    /** @override */
-    afterNonInlineElementNode(nodeContext: Vtree.NodeContext, stopAtOverflow: boolean): boolean;
-    /** @override */
-    clearOverflownViewNodes(column: Layout.Column, parentNodeContext: Vtree.NodeContext, nodeContext: Vtree.NodeContext, removeSelf: boolean): void;
-    /**
-     * @return holing true
-     * @override
-     */
-    finishBreak(column: Layout.Column, nodeContext: Vtree.NodeContext, forceRemoveSelf: boolean, endOfColumn: boolean): Task.Result<boolean>;
-}
-export declare class BlockFormattingContext implements LayoutProcessor.BlockFormattingContext {
-    private readonly parent;
-    formattingContextType: FormattingContextType;
-    constructor(parent: Vtree.FormattingContext);
-    /** @override */
-    getName(): string;
-    /** @override */
-    isFirstTime(nodeContext: Vtree.NodeContext, firstTime: boolean): boolean;
-    /** @override */
-    getParent(): Vtree.FormattingContext;
-    /** @override */
-    saveState(): any;
-    /** @override */
-    restoreState(state: any): void;
-}
-export declare const blockLayoutProcessor: BlockLayoutProcessor;
-export declare const isInstanceOfBlockFormattingContext: typeof LayoutProcessor.isInstanceOfBlockFormattingContext;
+import * as Task from "./task";
+import { FormattingContextType, Layout, LayoutProcessor, Vtree } from "./types";
+/**
+ * Processor doing some special layout (e.g. table layout)
+ */
+export interface LayoutProcessor {
+    /**
+     * Do actual layout in the column starting from given NodeContext.
+     */
+    layout(nodeContext: Vtree.NodeContext, column: Layout.Column, leadingEdge: boolean): Task.Result<Vtree.NodeContext>;
+    /**
+     * Potential edge breaking position.
+     */
+    createEdgeBreakPosition(position: Vtree.NodeContext, breakOnEdge: string | null, overflows: boolean, columnBlockSize: number): Layout.BreakPosition;
+    /**
+     * process nodecontext at the start of a non inline element.
+     * @return return true if you skip the subsequent nodes
+     */
+    startNonInlineElementNode(nodeContext: Vtree.NodeContext): boolean;
+    /**
+     * process nodecontext after a non inline element.
+     * @return return true if you skip the subsequent nodes
+     */
+    afterNonInlineElementNode(nodeContext: Vtree.NodeContext, stopAtOverflow: boolean): boolean;
+    /**
+     * @return holing true
+     */
+    finishBreak(column: Layout.Column, nodeContext: Vtree.NodeContext, forceRemoveSelf: boolean, endOfColumn: boolean): Task.Result<boolean>;
+    clearOverflownViewNodes(column: Layout.Column, parentNodeContext: Vtree.NodeContext, nodeContext: Vtree.NodeContext, removeSelf: boolean): any;
+}
+/**
+ * Resolver finding an appropriate LayoutProcessor given a formatting context
+ */
+export declare class LayoutProcessorResolver {
+    /**
+     * Find LayoutProcessor corresponding to given formatting context.
+     */
+    find(formattingContext: Vtree.FormattingContext): LayoutProcessor;
+}
+export declare class BlockLayoutProcessor implements LayoutProcessor {
+    /** @override */
+    layout(nodeContext: Vtree.NodeContext, column: Layout.Column, leadingEdge: boolean): Task.Result<Vtree.NodeContext>;
+    /** @override */
+    createEdgeBreakPosition(position: Vtree.NodeContext, breakOnEdge: string | null, overflows: boolean, columnBlockSize: number): Layout.BreakPosition;
+    /** @override */
+    startNonInlineElementNode(nodeContext: Vtree.NodeContext): boolean;
+    /** @override */
+    afterNonInlineElementNode(nodeContext: Vtree.NodeContext, stopAtOverflow: boolean): boolean;
+    /** @override */
+    clearOverflownViewNodes(column: Layout.Column, parentNodeContext: Vtree.NodeContext, nodeContext: Vtree.NodeContext, removeSelf: boolean): void;
+    /**
+     * @return holing true
+     * @override
+     */
+    finishBreak(column: Layout.Column, nodeContext: Vtree.NodeContext, forceRemoveSelf: boolean, endOfColumn: boolean): Task.Result<boolean>;
+}
+export declare class BlockFormattingContext implements LayoutProcessor.BlockFormattingContext {
+    private readonly parent;
+    formattingContextType: FormattingContextType;
+    constructor(parent: Vtree.FormattingContext);
+    /** @override */
+    getName(): string;
+    /** @override */
+    isFirstTime(nodeContext: Vtree.NodeContext, firstTime: boolean): boolean;
+    /** @override */
+    getParent(): Vtree.FormattingContext;
+    /** @override */
+    saveState(): any;
+    /** @override */
+    restoreState(state: any): void;
+}
+export declare const blockLayoutProcessor: BlockLayoutProcessor;
+export declare const isInstanceOfBlockFormattingContext: typeof LayoutProcessor.isInstanceOfBlockFormattingContext;

package/lib/vivliostyle/layout-retryers.d.ts

@@ -1,21 +1,21 @@
-import * as Task from "./task";
-import { Layout, Vtree } from "./types";
-/**
- * @abstract
- */
-export declare abstract class AbstractLayoutRetryer {
-    initialBreakPositions: Layout.BreakPosition[];
-    initialStateOfFormattingContext: Vtree.NodeContext;
-    initialPosition: Vtree.NodeContext;
-    initialFragmentLayoutConstraints: Layout.FragmentLayoutConstraint[];
-    layout(nodeContext: Vtree.NodeContext, column: Layout.Column): Task.Result<Vtree.NodeContext>;
-    private tryLayout;
-    /**
-     * @abstract
-     */
-    abstract resolveLayoutMode(nodeContext: Vtree.NodeContext): Layout.LayoutMode;
-    prepareLayout(nodeContext: Vtree.NodeContext, column: Layout.Column): void;
-    clearNodes(initialPosition: Vtree.NodeContext): void;
-    saveState(nodeContext: Vtree.NodeContext, column: Layout.Column): void;
-    restoreState(nodeContext: Vtree.NodeContext, column: Layout.Column): void;
-}
+import * as Task from "./task";
+import { Layout, Vtree } from "./types";
+/**
+ * @abstract
+ */
+export declare abstract class AbstractLayoutRetryer {
+    initialBreakPositions: Layout.BreakPosition[];
+    initialStateOfFormattingContext: Vtree.NodeContext;
+    initialPosition: Vtree.NodeContext;
+    initialFragmentLayoutConstraints: Layout.FragmentLayoutConstraint[];
+    layout(nodeContext: Vtree.NodeContext, column: Layout.Column): Task.Result<Vtree.NodeContext>;
+    private tryLayout;
+    /**
+     * @abstract
+     */
+    abstract resolveLayoutMode(nodeContext: Vtree.NodeContext): Layout.LayoutMode;
+    prepareLayout(nodeContext: Vtree.NodeContext, column: Layout.Column): void;
+    clearNodes(initialPosition: Vtree.NodeContext): void;
+    saveState(nodeContext: Vtree.NodeContext, column: Layout.Column): void;
+    restoreState(nodeContext: Vtree.NodeContext, column: Layout.Column): void;
+}

package/lib/vivliostyle/layout-util.d.ts

@@ -1,55 +1,55 @@
-import * as Task from "./task";
-import { Layout, Vtree } from "./types";
-export type LayoutIteratorState = {
-    nodeContext: Vtree.NodeContext;
-    atUnforcedBreak: boolean;
-    break: boolean;
-    leadingEdge?: boolean;
-    breakAtTheEdge?: string | null;
-    onStartEdges?: boolean;
-    leadingEdgeContexts?: Vtree.NodeContext[];
-    lastAfterNodeContext?: Vtree.NodeContext | null;
-};
-export declare class LayoutIteratorStrategy {
-    initialState(initialNodeContext: Vtree.NodeContext): LayoutIteratorState;
-    startNonDisplayableNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    afterNonDisplayableNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    startIgnoredTextNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    afterIgnoredTextNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    startNonElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    afterNonElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    startInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    afterInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    startNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    afterNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    finish(state: LayoutIteratorState): void | Task.Result<boolean>;
-}
-export declare class LayoutIterator {
-    private readonly strategy;
-    private readonly layoutContext;
-    constructor(strategy: LayoutIteratorStrategy, layoutContext: Vtree.LayoutContext);
-    iterate(initialNodeContext: Vtree.NodeContext): Task.Result<Vtree.NodeContext>;
-}
-export declare class EdgeSkipper extends LayoutIteratorStrategy {
-    protected readonly leadingEdge?: boolean;
-    constructor(leadingEdge?: boolean);
-    startNonInlineBox(state: LayoutIteratorState): void | Task.Result<boolean>;
-    endEmptyNonInlineBox(state: LayoutIteratorState): void | Task.Result<boolean>;
-    endNonInlineBox(state: LayoutIteratorState): void | Task.Result<boolean>;
-    initialState(initialNodeContext: Vtree.NodeContext): LayoutIteratorState;
-    /**
-     * @return Returns true if a forced break occurs.
-     */
-    processForcedBreak(state: LayoutIteratorState, column: Layout.Column): boolean;
-    /**
-     * @return Returns true if the node overflows the column.
-     */
-    saveEdgeAndProcessOverflow(state: LayoutIteratorState, column: Layout.Column): boolean;
-    /**
-     * @returns Returns true if the layout constraint is violated.
-     */
-    processLayoutConstraint(state: LayoutIteratorState, layoutConstraint: Layout.LayoutConstraint, column: Layout.Column): boolean;
-    startNonElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    startNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-    afterNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
-}
+import * as Task from "./task";
+import { Layout, Vtree } from "./types";
+export type LayoutIteratorState = {
+    nodeContext: Vtree.NodeContext;
+    atUnforcedBreak: boolean;
+    break: boolean;
+    leadingEdge?: boolean;
+    breakAtTheEdge?: string | null;
+    onStartEdges?: boolean;
+    leadingEdgeContexts?: Vtree.NodeContext[];
+    lastAfterNodeContext?: Vtree.NodeContext | null;
+};
+export declare class LayoutIteratorStrategy {
+    initialState(initialNodeContext: Vtree.NodeContext): LayoutIteratorState;
+    startNonDisplayableNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    afterNonDisplayableNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    startIgnoredTextNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    afterIgnoredTextNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    startNonElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    afterNonElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    startInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    afterInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    startNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    afterNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    finish(state: LayoutIteratorState): void | Task.Result<boolean>;
+}
+export declare class LayoutIterator {
+    private readonly strategy;
+    private readonly layoutContext;
+    constructor(strategy: LayoutIteratorStrategy, layoutContext: Vtree.LayoutContext);
+    iterate(initialNodeContext: Vtree.NodeContext): Task.Result<Vtree.NodeContext>;
+}
+export declare class EdgeSkipper extends LayoutIteratorStrategy {
+    protected readonly leadingEdge?: boolean;
+    constructor(leadingEdge?: boolean);
+    startNonInlineBox(state: LayoutIteratorState): void | Task.Result<boolean>;
+    endEmptyNonInlineBox(state: LayoutIteratorState): void | Task.Result<boolean>;
+    endNonInlineBox(state: LayoutIteratorState): void | Task.Result<boolean>;
+    initialState(initialNodeContext: Vtree.NodeContext): LayoutIteratorState;
+    /**
+     * @return Returns true if a forced break occurs.
+     */
+    processForcedBreak(state: LayoutIteratorState, column: Layout.Column): boolean;
+    /**
+     * @return Returns true if the node overflows the column.
+     */
+    saveEdgeAndProcessOverflow(state: LayoutIteratorState, column: Layout.Column): boolean;
+    /**
+     * @returns Returns true if the layout constraint is violated.
+     */
+    processLayoutConstraint(state: LayoutIteratorState, layoutConstraint: Layout.LayoutConstraint, column: Layout.Column): boolean;
+    startNonElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    startNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+    afterNonInlineElementNode(state: LayoutIteratorState): void | Task.Result<boolean>;
+}