Class ColumnBalancer`Abstract`

Hierarchy (View Summary)

ColumnBalancer
- BalanceLastColumnBalancer
- BalanceNonLastColumnBalancer

Index

Constructors

Properties

columnGenerator layoutContainer originalContainerBlockSize regionPageFloatLayoutContext

Methods

balanceColumns calculatePenalty hasNextCandidate postBalance preBalance savePageFloatLayoutContexts updateCondition

Constructors

constructor

new ColumnBalancer(
    layoutContainer: Container,
    columnGenerator: ColumnGenerator,
    regionPageFloatLayoutContext: PageFloatLayoutContext,
): ColumnBalancer
Parameters
- layoutContainer: Container
- columnGenerator: ColumnGenerator
- regionPageFloatLayoutContext: PageFloatLayoutContext
Returns ColumnBalancer
- Defined in columns.ts:62

Properties

`Readonly`columnGenerator

columnGenerator: ColumnGenerator

`Readonly`layoutContainer

layoutContainer: Container

originalContainerBlockSize

originalContainerBlockSize: number

`Readonly`regionPageFloatLayoutContext

regionPageFloatLayoutContext: PageFloatLayoutContext

Methods

balanceColumns

balanceColumns(layoutResult: ColumnLayoutResult): Result<ColumnLayoutResult>
Parameters
- layoutResult: ColumnLayoutResult
Returns Result<ColumnLayoutResult>
- Defined in columns.ts:70

`Protected` `Abstract`calculatePenalty

calculatePenalty(layoutResult: ColumnLayoutResult): number
Parameters
- layoutResult: ColumnLayoutResult
Returns number
- Defined in columns.ts:119

`Protected` `Abstract`hasNextCandidate

hasNextCandidate(candidates: ColumnBalancingTrialResult[]): boolean
Parameters
- candidates: ColumnBalancingTrialResult[]
Returns boolean
- Defined in columns.ts:121

`Protected`postBalance

postBalance(): void
Returns void
- Defined in columns.ts:129

`Protected`preBalance

preBalance(layoutResult: ColumnLayoutResult): void
Parameters
- layoutResult: ColumnLayoutResult
Returns void
- Defined in columns.ts:117

savePageFloatLayoutContexts

savePageFloatLayoutContexts(layoutResult: ColumnLayoutResult): void
Parameters
- layoutResult: ColumnLayoutResult
Returns void
- Defined in columns.ts:133

`Protected` `Abstract`updateCondition

updateCondition(candidates: ColumnBalancingTrialResult[]): void
Parameters
- candidates: ColumnBalancingTrialResult[]
Returns void
- Defined in columns.ts:125