Class BalanceNonLastColumnBalancer

Hierarchy (View Summary)

ColumnBalancer
- BalanceNonLastColumnBalancer

Index

Constructors

Properties

columnGenerator layoutContainer originalContainerBlockSize regionPageFloatLayoutContext

Methods

balanceColumns calculatePenalty hasNextCandidate postBalance preBalance savePageFloatLayoutContexts updateCondition

Constructors

constructor

new BalanceNonLastColumnBalancer(
    columnGenerator: ColumnGenerator,
    regionPageFloatLayoutContext: any,
    layoutContainer: Container,
): BalanceNonLastColumnBalancer
Parameters
- columnGenerator: ColumnGenerator
- regionPageFloatLayoutContext: any
- layoutContainer: Container
Returns BalanceNonLastColumnBalancer
Overrides ColumnBalancer.constructor
- Defined in columns.ts:313

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>
Inherited from ColumnBalancer.balanceColumns
- Defined in columns.ts:70

calculatePenalty

calculatePenalty(layoutResult: ColumnLayoutResult): number
Parameters
- layoutResult: ColumnLayoutResult
Returns number
Overrides ColumnBalancer.calculatePenalty
- Defined in columns.ts:321

hasNextCandidate

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

`Protected`postBalance

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

`Protected`preBalance

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

savePageFloatLayoutContexts

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

updateCondition

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