Class BoxBreakPosition

Potential breaking position inside CSS box (between lines).

Param: checkPoints

array of breaking points for breakable block

Hierarchy (View Summary)

AbstractBreakPosition
- BoxBreakPosition

Implements

Layout.BoxBreakPosition

Index

Constructors

Properties

breakNodeContext checkPoints penalty

Methods

breakPositionChosen calculateOffset findAcceptableBreak getMinBreakPenalty getNodeContext

Constructors

constructor

new BoxBreakPosition(
checkPoints: Vtree.NodeContext[],
penalty: number,
): BoxBreakPosition
Parameters
- checkPoints: Vtree.NodeContext[]
- penalty: number
Returns BoxBreakPosition
Overrides AbstractBreakPosition.constructor
- Defined in layout.ts:361

Properties

breakNodeContext

breakNodeContext: Vtree.NodeContext = null

`Readonly`checkPoints

checkPoints: Vtree.NodeContext[]

`Readonly`penalty

penalty: number

Methods

breakPositionChosen

breakPositionChosen(column: Layout.Column): void
Parameters
- column: Layout.Column
Returns void
Implementation of BoxBreakPosition.breakPositionChosen
Inherited from AbstractBreakPosition.breakPositionChosen
- Defined in break-position.ts:46

calculateOffset

calculateOffset(column: any): { current: number; minimum: number }
Parameters
- column: any
Returns { current: number; minimum: number }
Implementation of BoxBreakPosition.calculateOffset
Inherited from AbstractBreakPosition.calculateOffset
- Defined in break-position.ts:38

findAcceptableBreak

findAcceptableBreak(column: Column, penalty: number): Vtree.NodeContext
Parameters
- column: Column
- penalty: number
Returns Vtree.NodeContext
break position, if found
Implementation of BoxBreakPosition.findAcceptableBreak
Overrides AbstractBreakPosition.findAcceptableBreak
- Defined in layout.ts:368

getMinBreakPenalty

getMinBreakPenalty(): number
Returns number
penalty for this break position
Implementation of BoxBreakPosition.getMinBreakPenalty
Overrides AbstractBreakPosition.getMinBreakPenalty
- Defined in layout.ts:383

getNodeContext

getNodeContext(): Vtree.NodeContext
Returns Vtree.NodeContext
Implementation of BoxBreakPosition.getNodeContext
Overrides AbstractBreakPosition.getNodeContext
- Defined in layout.ts:387