rst.pdfbox.layout.util

Interface WordBreaker

All Known Implementing Classes:

WordBreakers.AbstractWordBreaker, WordBreakers.DefaultWordBreaker, WordBreakers.NonBreakingWordBreaker

public interface WordBreaker

This interface may be used to implement different strategies on how to break a word, if it does not fit into a line.

Method Summary

Modifier and Type	Method and Description
Pair<String>	breakWord(String word, FontDescriptor fontDescriptor, float maxWidth, boolean breakHardIfNecessary) Breaks the word in order to fit the given maximum width.

Method Detail

breakWord

Pair<String> breakWord(String word,
                       FontDescriptor fontDescriptor,
                       float maxWidth,
                       boolean breakHardIfNecessary)
                throws IOException

Breaks the word in order to fit the given maximum width.

Parameters:

word - the word to break.

fontDescriptor - describing the font's type and size.

maxWidth - the maximum width to obey.

breakHardIfNecessary - indicates if the word should be broken hard to fit the width, in case there is no suitable position for breaking it adequately.

Returns:

the broken word, or null if it cannot be broken.

Throws:

IOException - by pdfbox