@vivliostyle/core
    Preparing search index...

    Class Column

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    applyClearance buildDeepElementView buildViewToNextBlockEdge calculateClonedPaddingBorder calculateEdge calculateOffsetInNodeForNodeContext checkOverflowAndSaveEdge checkOverflowAndSaveEdgeAndBreakPosition clear clearOverflownViewNodes collectElementsOffset copyFrom createFloat createFloats createPageFloatArea doFinishBreak doFinishBreakOfFragmentLayoutConstraints doLayout findAcceptableBreakInside findAcceptableBreakPosition findBoxBreakPosition findEdgeBreakPosition findEndOfLine findFirstOverflowingEdgeAndCheckPoint findLinePositions finishBreak getAfterEdge getAfterEdgeOfBlockContainer getBeforeEdge getBottomEdge getBoxDir getBoxSize getComputedInsets getComputedMargin getComputedPaddingBorder getEndEdge getExclusions getInlineDir getInlineSize getInnerRect getInnerShape getInsetAfter getInsetBefore getInsetBottom getInsetEnd getInsetLeft getInsetRight getInsetStart getInsetTop getLeftEdge getMaxBlockSizeOfPageFloats getOuterRect getOuterShape getPaddingRect getRangeBoxes getRightEdge getStartEdge getTopEdge getTrailingMarginEdgeAdjustment hasFixedPositionAncestor hasNonZeroBlockEndInset hasNonZeroBlockStartInset init initGeom isBFC isBreakable isFloatNodeContext isFullWithPageFloats isLoneImage isOverflown isZeroLength killFloats layout layoutBreakableBlock layoutFloat layoutFloatOrFootnote layoutNext layoutPageFloat layoutPageFloatInner layoutSinglePageFloatFragment layoutUnbreakable maybePeelOff nextInTree openAllViews parseComputedLength postLayoutBlock processLineStyling redoLayout resolveFloatReferenceFromColumnSpan resolveTextNodeBreaker saveBoxBreakPosition saveDistanceToBlockEndFloats saveEdgeBreakPosition setBlockPosition setComputedInsets setComputedWidthAndHeight setFloatAnchorViewNode setHorizontalPosition setInlinePosition setupFloatArea setVerticalPosition skipEdges skipTailEdges stopByOverflow updateMaxReachedAfterEdge

    Constructors

    Properties

    afterEdge: number = 0
    bands: Band[] = null
    beforeEdge: number = 0
    blockDistanceToBlockEndFloats: number = NaN
    borderBottom: number = 0
    borderBoxSizing: boolean = false
    borderLeft: number = 0
    borderRight: number = 0
    borderTop: number = 0
    bottommostFloatTop: number = 0

    bottom of the bottommost right float

    box: Rect = null
    breakAtTheEdgeBeforeFloat: string = null
    breakPositions: Layout.BreakPosition[] = null
    chunkPositions: Vtree.ChunkPosition[] = null
    clientLayout: Vtree.ClientLayout
    computedBlockSize: number = 0
    element: HTMLElement
    endEdge: number = 0
    exclusions: Shape[] = null
    flowRootFormattingContext: Vtree.FormattingContext = null
    footnoteEdge: number = 0
    forceNonfitting: boolean = true
    fragmentLayoutConstraints: Layout.FragmentLayoutConstraint[] = []
    height: number = 0
    innerShape: Shape = null
    isFloat: boolean = false
    isFootnote: boolean = false
    isNonFirstColumn: boolean = false
    last: Node
    lastAfterPosition: Vtree.NodePosition = null
    lastLineStride: number = 0
    layoutConstraint: Layout.LayoutConstraint
    layoutContext: Vtree.LayoutContext
    left: number = 0
    leftFloatEdge: number = 0
    marginBottom: number = 0
    marginLeft: number = 0
    marginRight: number = 0
    marginTop: number = 0
    nodeContextOverflowingDueToRepetitiveElements: Vtree.NodeContext = null
    originX: number = 0
    originY: number = 0
    overflown: boolean = false
    paddingBottom: number = 0
    paddingLeft: number = 0
    paddingRight: number = 0
    paddingTop: number = 0
    pageBreakType: string = null
    pageFloatLayoutContext: PageFloatLayoutContext
    pseudoParent: Column = null
    rightFloatEdge: number = 0

    bottom of the bottommost left float

    rtl: boolean = false
    snapHeight: number = 0
    snapOffsetX: number = 0
    snapOffsetY: number = 0
    snapWidth: number = 0
    startEdge: number = 0
    stopAtOverflow: boolean = true

    Top of the bottommost float

    top: number = 0
    vertical: boolean = false
    viewDocument: Document
    width: number = 0

    Methods

    • Create a single floating element (for exclusion areas).

      Parameters

      • ref: Node

        container's child to insert float before (can be null).

      • side: string

        float side ("left" or "right").

      • width: number

        float inline dimension.

      • height: number

        float box progression dimension.

      Returns Element

      newly created float element.

    • Reads element's computed CSS insets(margins + border + padding or margins : depends on box-sizing)

      Parameters

      • element: Element

      Returns Insets

    • Check if the nodeContext has a position:fixed ancestor in the view tree. Used to detect text inside running elements (position:running() rendered as position:fixed). (Issue #1833)

      Parameters

      Returns boolean

    • Check if element has non-zero block-end inset (padding + border). Handles both horizontal and vertical writing modes.

      Parameters

      • style: CSSStyleDeclaration

      Returns boolean

    • Check if element has non-zero block-start inset (padding + border). Handles both horizontal and vertical writing modes.

      Parameters

      • style: CSSStyleDeclaration

      Returns boolean

    • Determines if a CSS length value is empty or zero.

      Parameters

      • val: string

      Returns boolean

    • Parse CSS computed length (in pixels)

      Parameters

      • val: string

        CSS length in "px"

      Returns number

      parsed and adjusted length value in pixels or 0 if not parsable

    • Save the potential breaking position at the edge. Should, in general, save "after" position but only after skipping all of the "before" ones and getting to the non-empty content (to get breakAtEdge right).

      Parameters

      Returns void