com.io7m.jpita.core

Class JPJustifierBasic

java.lang.Object

com.io7m.jpita.core.JPJustifierBasic

All Implemented Interfaces:

JPAlignerType

public final class JPJustifierBasic
extends Object
implements JPAlignerType

An basic aligner that fully justifies text. The algorithm used is a simple greedy formatter that avoids the O(n²) performance of a full dynamic programming approach.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JPJustifierBasic.SpaceTextDecisionType A function that, when evaluated, yields true iff a line with the given number of space and text characters should be justified.

Field Summary

Fields

Modifier and Type	Field and Description
static JPJustifierBasic.SpaceTextDecisionType	JUSTIFY_ALWAYS An instance of the JPJustifierBasic.SpaceTextDecisionType that always justifies lines.
static JPJustifierBasic.SpaceTextDecisionType	JUSTIFY_UNDER_HALF An instance of the JPJustifierBasic.SpaceTextDecisionType that avoids justifying lines if more than half of the line would be space.

Method Summary

Modifier and Type	Method and Description
void	addWord(String w) Add a word to the current layout.
void	breakLine() Insert a hard line break.
static JPAlignerType	create(JPOverflowBehaviour in_overflow, JPJustifierBasic.SpaceTextDecisionType in_decider, int in_width) Construct a new justifier.
List<String>	finish() Finish the current layout, effectively resetting it to a blank canvas.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JUSTIFY_UNDER_HALF

public static final JPJustifierBasic.SpaceTextDecisionType JUSTIFY_UNDER_HALF

An instance of the JPJustifierBasic.SpaceTextDecisionType that avoids justifying lines if more than half of the line would be space.

JUSTIFY_ALWAYS

public static final JPJustifierBasic.SpaceTextDecisionType JUSTIFY_ALWAYS

An instance of the JPJustifierBasic.SpaceTextDecisionType that always justifies lines.

Method Detail

create

public static JPAlignerType create(JPOverflowBehaviour in_overflow,
                                   JPJustifierBasic.SpaceTextDecisionType in_decider,
                                   int in_width)

Construct a new justifier.

Parameters:

in_overflow - The behaviour for words that are of a greater length than the maximum width and therefore cannot fit even when placed on an otherwise blank line

in_decider - A function that decides whether or not lines should be justified

in_width - The maximum width in characters

Returns:

A new justifier

addWord

public void addWord(String w)

Description copied from interface: JPAlignerType

Add a word to the current layout.

Specified by:

addWord in interface JPAlignerType

Parameters:

w - A word

breakLine

public void breakLine()

Description copied from interface: JPAlignerType

Insert a hard line break.

Specified by:

breakLine in interface JPAlignerType

finish

public List<String> finish()

Description copied from interface: JPAlignerType

Finish the current layout, effectively resetting it to a blank canvas.

Specified by:

finish in interface JPAlignerType

Returns:

A list of formatted lines