rst.pdfbox.layout.util

Class WordBreakers.AbstractWordBreaker

java.lang.Object

rst.pdfbox.layout.util.WordBreakers.AbstractWordBreaker

All Implemented Interfaces:

WordBreaker

Direct Known Subclasses:

WordBreakers.DefaultWordBreaker

Enclosing class:

WordBreakers

public abstract static class WordBreakers.AbstractWordBreaker
extends Object
implements WordBreaker

Abstract base class for implementing (custom) word breakers. Tries to break the word softly, or - if this is not possible - hard.

Constructor Summary

Constructors

Constructor and Description
AbstractWordBreaker()

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.
protected Pair<String>	breakWordHard(String word, FontDescriptor fontDescriptor, float maxWidth) Breaks the word hard at the outermost position that fits the given max width.
protected abstract Pair<String>	breakWordSoft(String word, FontDescriptor fontDescriptor, float maxWidth) To be implemented by subclasses.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWordBreaker

public AbstractWordBreaker()

Method Detail

breakWord

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

Description copied from interface: WordBreaker

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

Specified by:

breakWord in interface WordBreaker

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

breakWordSoft

protected abstract Pair<String> breakWordSoft(String word,
                                              FontDescriptor fontDescriptor,
                                              float maxWidth)
                                       throws IOException

To be implemented by subclasses. Give your best to break the word softly using your strategy, otherwise return null.

Parameters:

word - the word to break.

fontDescriptor - describing the font's type and size.

maxWidth - the maximum width to obey.

Returns:

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

Throws:

IOException - by pdfbox

breakWordHard

protected Pair<String> breakWordHard(String word,
                                     FontDescriptor fontDescriptor,
                                     float maxWidth)
                              throws IOException

Breaks the word hard at the outermost position that fits the given max width.

Parameters:

word - the word to break.

fontDescriptor - describing the font's type and size.

maxWidth - the maximum width to obey.

Returns:

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

Throws:

IOException - by pdfbox