org.axsl.text.line

Interface PatientLineBreaker

All Superinterfaces:

LineBreaker

public interface PatientLineBreaker
extends LineBreaker

PatientLineBreaker implementations provide line-breaking logic to clients. "Patient" line-breaking means that no decisions about where line-breaks occur are finalized until all lines in the block/paragraph have been considered. Patient processing will usually be slower but provide better results than eager processing. Patient line-breaking client send all of their input to the text-processing system before processing actually starts.

To use a LineBreaker, first get an instance from TextServer.providePatientLineBreaker(LineBreakControl, LineBreakHandler, FontConsumer).

After obtaining an instance, recursively access the addLineContent, providing the instance with each item that should be included in the block of content to be broken into lines. After this is complete, run getResults(), which performs the computations needed to determine the line breaks and returns the results.

Method Summary

Modifier and Type	Method and Description
void	addLineContent(LineContent contentItem) Provide the line-breaking system with a piece of content.
int	getResults() This method is currently not right, and cannot yet be properly documented.

Method Detail

addLineContent

void addLineContent(LineContent contentItem)
             throws TextException

Provide the line-breaking system with a piece of content.

Parameters:

contentItem - The LineContent implementation that should be laid out.

Throws:

TextException - For errors in line-breaking.

getResults

int getResults()
        throws TextException

This method is currently not right, and cannot yet be properly documented.

Returns:

Some unknown result.

Throws:

TextException - for an error in processing.