Text_To_FormattedText (SKB Interfaces 0.0.2 API)

All Superinterfaces:

CategoryIs, Function<String,Collection<StrBuilder>>, IsTransformer<String,Collection<StrBuilder>>, Transformer<String,Collection<StrBuilder>>
```
public interface Text_To_FormattedText
extends IsTransformer<String,Collection<StrBuilder>>
```
Swiss army knife for formatting text, with several options for alignments, formats, inserted characters, and variable width.

Since:

v0.0.1

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGN_CENTER` Alignment option for centered text.
`static int`	`ALIGN_JUSTIFIED` Alignment option for justified text.
`static int`	`ALIGN_JUSTIFIED_LEFT` Alignment option for justified text, last line left aligned.
`static int`	`ALIGN_JUSTIFIED_RIGHT` Alignment option for justified text, last line right aligned.
`static int`	`ALIGN_LEFT` Alignment option for left aligned text.
`static int`	`ALIGN_RIGHT` Alignment option for right aligned text.
`static int`	`DEFAULT_CHARS_BETWEEN_DROPCAP_AND_TEXT` Characters to be used between the drop cap and the text, set to 3.
`static IsCollectionStrategy<?,StrBuilder>`	`DEFAULT_COLLECTION_STRATEGY` Default collection strategy for the returned collection, defaults to an array list strategy.
`static int`	`DEFAULT_FIRSTLINE_INDENTATION` Default first line indentation, set to 4.
`static int`	`DEFAULT_HANGING_INDENTATION` Default hanging indent, set to 4.
`static char`	`DEFAULT_INNER_WHITESPACE_CHARACTER` Default white space replacement character, set to ' '.
`static char`	`DEFAULT_LEFT_PADDING_CHARACTER` Default left padding character, set to ' '.
`static int`	`DEFAULT_LINES_AFTER_DROPCAP` Empty lines to be added after the drop cap, set to 1.
`static char`	`DEFAULT_RIGHT_PADDING_CHARACTER` Default right padding character, set to ' '.
`static int`	`DEFAULT_TEXT_WIDTH` The default width, set to 80.
`static int`	`FORMAT_DROPCAP` Format option for text using a dropped capital letter replacing the first character of the first word of the first sentence, requires a special library of those letters.
`static int`	`FORMAT_DROPCAP_WITH_PADDING` Format option for text with a dropped capital letter using a padding.
`static int`	`FORMAT_FIRST_LINE` Format option for text with the first line using an indentation.
`static int`	`FORMAT_FIRSTLINE_AND_HANGINGPARAGRAPH` Format option combining a first line indentation with a hanging paragraph.
`static int`	`FORMAT_HANGING_PARAGRAPH` Format option for text with all lines but the first line using an indentation (hanging paragraph).
`static int`	`FORMAT_NONE` Format option for no special formatting.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Collection<StrBuilder>`	`center(String text, int textWidth)` Transforms text to centered lines.
`static Collection<StrBuilder>`	`center(String text, int textWidth, int format)` Transforms text to centered lines.
`static Collection<StrBuilder>`	`center(String text, int textWidth, int format, Character padding)` Transforms text to centered lines.
`static Collection<StrBuilder>`	`center(String text, int textWidth, int format, Character leftPadding, Character rightPadding)` Transforms text to centered lines.
`static Collection<StrBuilder>`	`center(String text, int textWidth, int format, Character leftPadding, Character rightPadding, Character innerWS)` Transforms text to centered lines.
`static Collection<StrBuilder>`	`center(String text, int textWidth, int format, Character leftPadding, Character rightPadding, Character innerWS, IsCollectionStrategy<?,StrBuilder> strategy)` Transforms text to centered lines.
`static Text_To_FormattedText`	`create(int textWidth, int alignment, int format, Character leftPadding, Character rightPadding, Character innerWS, int hangingIndentation, int firstlineIndentation, String[] dropCap, int charsBetweenDroppcapAndText, int linesAfterDropcap, IsCollectionStrategy<?,StrBuilder> strategy)` Creates a new transformer.
`default int`	`getAlignment()` Returns the required alignment, defaults to `ALIGN_JUSTIFIED_LEFT`.
`default int`	`getCharsBetweenDroppcapAndText()` Returns the number of characters between a dropped capital letter and text lines, default to `DEFAULT_CHARS_BETWEEN_DROPCAP_AND_TEXT`.
`default IsCollectionStrategy<?,StrBuilder>`	`getCollectionStrategy()` Returns the collection strategy, defaults to `DEFAULT_COLLECTION_STRATEGY`.
`String[]`	`getDropCap()` Returns the dropped capital letter used if such format is required.
`default int`	`getFirstlineIndentation()` Returns the first line indentation, defaults to `DEFAULT_FIRSTLINE_INDENTATION`.
`default int`	`getFormat()` Returns the required format, defaults to `FORMAT_NONE`.
`default int`	`getHangingIndentation()` Returns the hanging paragraph indentation, defaults to `DEFAULT_HANGING_INDENTATION`.
`default Character`	`getInnerWsChar()` Returns the in-text whitespace character, defaults to `DEFAULT_INNER_WHITESPACE_CHARACTER`.
`default Character`	`getLeftPaddingChar()` Returns the left padding character, defaults to `DEFAULT_LEFT_PADDING_CHARACTER`.
`default int`	`getLinesAfterDropcap()` Returns the lines added after a dropped capital letter, defaults to `DEFAULT_LINES_AFTER_DROPCAP`.
`default Character`	`getRightPaddingChar()` Returns the right padding character, defaults to `DEFAULT_RIGHT_PADDING_CHARACTER`.
`default int`	`getTextWidth()` Returns the text width, defaults to `DEFAULT_TEXT_WIDTH`.
`static Collection<StrBuilder>`	`justified(String text, int textWidth)` Transforms text to justified lines.
`static Collection<StrBuilder>`	`justified(String text, int textWidth, int format)` Transforms text to justified lines.
`static Collection<StrBuilder>`	`justified(String text, int textWidth, int format, Character innerWS)` Transforms text to justified lines.
`static Collection<StrBuilder>`	`justified(String text, int textWidth, int format, Character innerWS, IsCollectionStrategy<?,StrBuilder> strategy)` Transforms text to justified lines.
`static Collection<StrBuilder>`	`justifiedLeft(String text, int textWidth)` Transforms text to justified lines, last line being left aligned.
`static Collection<StrBuilder>`	`justifiedLeft(String text, int textWidth, int format)` Transforms text to justified lines, last line being left aligned.
`static Collection<StrBuilder>`	`justifiedLeft(String text, int textWidth, int format, Character padding)` Transforms text to justified lines, last line being left aligned.
`static Collection<StrBuilder>`	`justifiedLeft(String text, int textWidth, int format, Character padding, Character innerWS)` Transforms text to justified lines, last line being left aligned.
`static Collection<StrBuilder>`	`justifiedLeft(String text, int textWidth, int format, Character padding, Character innerWS, IsCollectionStrategy<?,StrBuilder> strategy)` Transforms text to justified lines, last line being left aligned.
`static Collection<StrBuilder>`	`justifiedRight(String text, int textWidth)` Transforms text to justified lines, last line being right aligned.
`static Collection<StrBuilder>`	`justifiedRight(String text, int textWidth, int format)` Transforms text to justified lines, last line being right aligned.
`static Collection<StrBuilder>`	`justifiedRight(String text, int textWidth, int format, Character padding)` Transforms text to justified lines, last line being right aligned.
`static Collection<StrBuilder>`	`justifiedRight(String text, int textWidth, int format, Character padding, Character innerWS)` Transforms text to justified lines, last line being right aligned.
`static Collection<StrBuilder>`	`justifiedRight(String text, int textWidth, int format, Character padding, Character innerWS, IsCollectionStrategy<?,StrBuilder> strategy)` Transforms text to justified lines, last line being right aligned.
`static Collection<StrBuilder>`	`left(String text, int textWidth)` Transforms text to left aligned lines.
`static Collection<StrBuilder>`	`left(String text, int textWidth, int format)` Transforms text to left aligned lines.
`static Collection<StrBuilder>`	`left(String text, int textWidth, int format, Character padding)` Transforms text to left aligned lines.
`static Collection<StrBuilder>`	`left(String text, int textWidth, int format, Character padding, Character innerWS)` Transforms text to left aligned lines.
`static Collection<StrBuilder>`	`left(String text, int textWidth, int format, Character padding, Character innerWS, IsCollectionStrategy<?,StrBuilder> strategy)` Transforms text to left aligned lines.
`static Collection<StrBuilder>`	`right(String text, int textWidth)` Transforms text to right aligned lines.
`static Collection<StrBuilder>`	`right(String text, int textWidth, int format)` Transforms text to right aligned lines.
`static Collection<StrBuilder>`	`right(String text, int textWidth, int format, Character padding)` Transforms text to right aligned lines.
`static Collection<StrBuilder>`	`right(String text, int textWidth, int format, Character padding, Character innerWS)` Transforms text to right aligned lines.
`static Collection<StrBuilder>`	`right(String text, int textWidth, int format, Character padding, Character innerWS, IsCollectionStrategy<?,StrBuilder> strategy)` Transforms text to right aligned lines.
`default Collection<StrBuilder>`	`transform(StrBuilder sb)` Transforms a string builder to a collection using the main transform method.
`default Collection<StrBuilder>`	`transform(String s)` Transforms from one representation to another.

Methods inherited from interface Transformer
apply, transform

Methods inherited from interface Function
andThen, compose, identity

- Field Detail
  - ALIGN_LEFT
```
static final int ALIGN_LEFT
```
    Alignment option for left aligned text.
    
    See Also:
    
    Constant Field Values
  - ALIGN_CENTER
```
static final int ALIGN_CENTER
```
    Alignment option for centered text.
    
    See Also:
    
    Constant Field Values
  - ALIGN_RIGHT
```
static final int ALIGN_RIGHT
```
    Alignment option for right aligned text.
    
    See Also:
    
    Constant Field Values
  - ALIGN_JUSTIFIED
```
static final int ALIGN_JUSTIFIED
```
    Alignment option for justified text.
    
    See Also:
    
    Constant Field Values
  - ALIGN_JUSTIFIED_LEFT
```
static final int ALIGN_JUSTIFIED_LEFT
```
    Alignment option for justified text, last line left aligned.
    
    See Also:
    
    Constant Field Values
  - ALIGN_JUSTIFIED_RIGHT
```
static final int ALIGN_JUSTIFIED_RIGHT
```
    Alignment option for justified text, last line right aligned.
    
    See Also:
    
    Constant Field Values
  - FORMAT_NONE
```
static final int FORMAT_NONE
```
    Format option for no special formatting.
    
    See Also:
    
    Constant Field Values
  - FORMAT_FIRST_LINE
```
static final int FORMAT_FIRST_LINE
```
    Format option for text with the first line using an indentation.
    
    See Also:
    
    Constant Field Values
  - FORMAT_HANGING_PARAGRAPH
```
static final int FORMAT_HANGING_PARAGRAPH
```
    Format option for text with all lines but the first line using an indentation (hanging paragraph).
    
    See Also:
    
    Constant Field Values
  - FORMAT_FIRSTLINE_AND_HANGINGPARAGRAPH
```
static final int FORMAT_FIRSTLINE_AND_HANGINGPARAGRAPH
```
    Format option combining a first line indentation with a hanging paragraph.
    
    See Also:
    
    Constant Field Values
  - FORMAT_DROPCAP
```
static final int FORMAT_DROPCAP
```
    Format option for text using a dropped capital letter replacing the first character of the first word of the first sentence, requires a special library of those letters.
    
    See Also:
    
    Constant Field Values
  - FORMAT_DROPCAP_WITH_PADDING
```
static final int FORMAT_DROPCAP_WITH_PADDING
```
    Format option for text with a dropped capital letter using a padding.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TEXT_WIDTH
```
static final int DEFAULT_TEXT_WIDTH
```
    The default width, set to 80.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LEFT_PADDING_CHARACTER
```
static final char DEFAULT_LEFT_PADDING_CHARACTER
```
    Default left padding character, set to ' '.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RIGHT_PADDING_CHARACTER
```
static final char DEFAULT_RIGHT_PADDING_CHARACTER
```
    Default right padding character, set to ' '.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INNER_WHITESPACE_CHARACTER
```
static final char DEFAULT_INNER_WHITESPACE_CHARACTER
```
    Default white space replacement character, set to ' '.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HANGING_INDENTATION
```
static final int DEFAULT_HANGING_INDENTATION
```
    Default hanging indent, set to 4.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FIRSTLINE_INDENTATION
```
static final int DEFAULT_FIRSTLINE_INDENTATION
```
    Default first line indentation, set to 4.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CHARS_BETWEEN_DROPCAP_AND_TEXT
```
static final int DEFAULT_CHARS_BETWEEN_DROPCAP_AND_TEXT
```
    Characters to be used between the drop cap and the text, set to 3.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LINES_AFTER_DROPCAP
```
static final int DEFAULT_LINES_AFTER_DROPCAP
```
    Empty lines to be added after the drop cap, set to 1.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COLLECTION_STRATEGY
```
static final IsCollectionStrategy<?,StrBuilder> DEFAULT_COLLECTION_STRATEGY
```
    Default collection strategy for the returned collection, defaults to an array list strategy.
- Method Detail
  - getAlignment
```
default int getAlignment()
```
    Returns the required alignment, defaults to ALIGN_JUSTIFIED_LEFT.
    
    Returns:
    
    alignment
  - getFormat
```
default int getFormat()
```
    Returns the required format, defaults to FORMAT_NONE.
    
    Returns:
    
    format
  - getInnerWsChar
```
default Character getInnerWsChar()
```
    Returns the in-text whitespace character, defaults to DEFAULT_INNER_WHITESPACE_CHARACTER.
    
    Returns:
    
    in-text whitespace character
  - getLeftPaddingChar
```
default Character getLeftPaddingChar()
```
    Returns the left padding character, defaults to DEFAULT_LEFT_PADDING_CHARACTER.
    
    Returns:
    
    left padding character
  - getRightPaddingChar
```
default Character getRightPaddingChar()
```
    Returns the right padding character, defaults to DEFAULT_RIGHT_PADDING_CHARACTER.
    
    Returns:
    
    right padding character
  - getTextWidth
```
default int getTextWidth()
```
    Returns the text width, defaults to DEFAULT_TEXT_WIDTH.
    
    Returns:
    
    text width
  - getCollectionStrategy
```
default IsCollectionStrategy<?,StrBuilder> getCollectionStrategy()
```
    Returns the collection strategy, defaults to DEFAULT_COLLECTION_STRATEGY.
    
    Returns:
    
    collection strategy
  - getHangingIndentation
```
default int getHangingIndentation()
```
    Returns the hanging paragraph indentation, defaults to DEFAULT_HANGING_INDENTATION.
    
    Returns:
    
    hanging paragraph indentation
  - getFirstlineIndentation
```
default int getFirstlineIndentation()
```
    Returns the first line indentation, defaults to DEFAULT_FIRSTLINE_INDENTATION.
    
    Returns:
    
    first line indentation
  - getCharsBetweenDroppcapAndText
```
default int getCharsBetweenDroppcapAndText()
```
    Returns the number of characters between a dropped capital letter and text lines, default to DEFAULT_CHARS_BETWEEN_DROPCAP_AND_TEXT.
    
    Returns:
    
    characters between a dropped capital letter and text lines
  - getLinesAfterDropcap
```
default int getLinesAfterDropcap()
```
    Returns the lines added after a dropped capital letter, defaults to DEFAULT_LINES_AFTER_DROPCAP.
    
    Returns:
    
    lines added after a dropped capital letter
  - transform
```
default Collection<StrBuilder> transform(StrBuilder sb)
```
    Transforms a string builder to a collection using the main transform method.
    
    Parameters:
    
    sb - input string builder, cannot be null
    
    Returns:
    
    formatted text as a collection of string builders
  - getDropCap
```
String[] getDropCap()
```
    Returns the dropped capital letter used if such format is required.
    
    Returns:
    
    dropped capital letter, cannot be null or have null elements, each line in array must have same length
  - transform
```
default Collection<StrBuilder> transform(String s)
```
    Description copied from interface: Transformer
    
    Transforms from one representation to another.
    
    Specified by:
    
    transform in interface Transformer<String,Collection<StrBuilder>>
    
    Parameters:
    
    s - input representation
    
    Returns:
    
    output representation or null if input was null or unexpected class
  - create
```
static Text_To_FormattedText create(int textWidth,
                                    int alignment,
                                    int format,
                                    Character leftPadding,
                                    Character rightPadding,
                                    Character innerWS,
                                    int hangingIndentation,
                                    int firstlineIndentation,
                                    String[] dropCap,
                                    int charsBetweenDroppcapAndText,
                                    int linesAfterDropcap,
                                    IsCollectionStrategy<?,StrBuilder> strategy)
```
    Creates a new transformer.
    
    Parameters:
    
    textWidth - the text width (width of each line in the returned collection), should not be less than 1
    
    alignment - the option for text alignment, must be a valid option
    
    format - the option for text formatting, must be a valid option
    
    leftPadding - character for padding on the left side of a line, can be null (then default is used)
    
    rightPadding - character for padding on the right side of a line, can be null (then default is used)
    
    innerWS - character for replacing whitespaces within a line (between first and last word), can be null (then default is used)
    
    hangingIndentation - indentation for a hanging paragraph format, 0 will result in default being used
    
    firstlineIndentation - indentation for the first line in the first line format, 0 will result in default being used
    
    dropCap - a dropped capital letter for dropped capital formats, should not be null if relevant format is set
    
    charsBetweenDroppcapAndText - characters between the dropped capital letter and text, 0 will result in default being used
    
    linesAfterDropcap - lines added after the dropped capital letter with same indentation, 0 will result in default being used
    
    strategy - the collection strategy for the returned collection, null means use default
    
    Returns:
    
    new transformer
  - left
```
static Collection<StrBuilder> left(String text,
                                   int textWidth)
```
    Transforms text to left aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    Returns:
    
    transformed text
  - left
```
static Collection<StrBuilder> left(String text,
                                   int textWidth,
                                   int format)
```
    Transforms text to left aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    Returns:
    
    transformed text
  - left
```
static Collection<StrBuilder> left(String text,
                                   int textWidth,
                                   int format,
                                   Character padding)
```
    Transforms text to left aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding on the right side
    
    Returns:
    
    transformed text
  - left
```
static Collection<StrBuilder> left(String text,
                                   int textWidth,
                                   int format,
                                   Character padding,
                                   Character innerWS)
```
    Transforms text to left aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding on the right side
    
    innerWS - character for replacing whitespaces in the text
    
    Returns:
    
    transformed text
  - left
```
static Collection<StrBuilder> left(String text,
                                   int textWidth,
                                   int format,
                                   Character padding,
                                   Character innerWS,
                                   IsCollectionStrategy<?,StrBuilder> strategy)
```
    Transforms text to left aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding on the right side
    
    innerWS - character for replacing whitespaces in the text
    
    strategy - the strategy for the returned collection
    
    Returns:
    
    transformed text
  - center
```
static Collection<StrBuilder> center(String text,
                                     int textWidth)
```
    Transforms text to centered lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    Returns:
    
    transformed text
  - center
```
static Collection<StrBuilder> center(String text,
                                     int textWidth,
                                     int format)
```
    Transforms text to centered lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    Returns:
    
    transformed text
  - center
```
static Collection<StrBuilder> center(String text,
                                     int textWidth,
                                     int format,
                                     Character padding)
```
    Transforms text to centered lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - left and right padding character
    
    Returns:
    
    transformed text
  - center
```
static Collection<StrBuilder> center(String text,
                                     int textWidth,
                                     int format,
                                     Character leftPadding,
                                     Character rightPadding)
```
    Transforms text to centered lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    leftPadding - left padding character
    
    rightPadding - right padding character
    
    Returns:
    
    transformed text
  - center
```
static Collection<StrBuilder> center(String text,
                                     int textWidth,
                                     int format,
                                     Character leftPadding,
                                     Character rightPadding,
                                     Character innerWS)
```
    Transforms text to centered lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    leftPadding - left padding character
    
    rightPadding - right padding character
    
    innerWS - character for replacing whitespaces in the text
    
    Returns:
    
    transformed text
  - center
```
static Collection<StrBuilder> center(String text,
                                     int textWidth,
                                     int format,
                                     Character leftPadding,
                                     Character rightPadding,
                                     Character innerWS,
                                     IsCollectionStrategy<?,StrBuilder> strategy)
```
    Transforms text to centered lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    leftPadding - left padding character
    
    rightPadding - right padding character
    
    innerWS - character for replacing whitespaces in the text
    
    strategy - the strategy for the returned collection
    
    Returns:
    
    transformed text
  - right
```
static Collection<StrBuilder> right(String text,
                                    int textWidth)
```
    Transforms text to right aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    Returns:
    
    transformed text
  - right
```
static Collection<StrBuilder> right(String text,
                                    int textWidth,
                                    int format)
```
    Transforms text to right aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    Returns:
    
    transformed text
  - right
```
static Collection<StrBuilder> right(String text,
                                    int textWidth,
                                    int format,
                                    Character padding)
```
    Transforms text to right aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding on the left side of each line
    
    Returns:
    
    transformed text
  - right
```
static Collection<StrBuilder> right(String text,
                                    int textWidth,
                                    int format,
                                    Character padding,
                                    Character innerWS)
```
    Transforms text to right aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding on the left side of each line
    
    innerWS - character for replacing whitespaces in the text
    
    Returns:
    
    transformed text
  - right
```
static Collection<StrBuilder> right(String text,
                                    int textWidth,
                                    int format,
                                    Character padding,
                                    Character innerWS,
                                    IsCollectionStrategy<?,StrBuilder> strategy)
```
    Transforms text to right aligned lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding on the left side of each line
    
    innerWS - character for replacing whitespaces in the text
    
    strategy - the strategy for the returned collection
    
    Returns:
    
    transformed text
  - justified
```
static Collection<StrBuilder> justified(String text,
                                        int textWidth)
```
    Transforms text to justified lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    Returns:
    
    transformed text
  - justified
```
static Collection<StrBuilder> justified(String text,
                                        int textWidth,
                                        int format)
```
    Transforms text to justified lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    Returns:
    
    transformed text
  - justified
```
static Collection<StrBuilder> justified(String text,
                                        int textWidth,
                                        int format,
                                        Character innerWS)
```
    Transforms text to justified lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    innerWS - character for replacing whitespaces in the text
    
    Returns:
    
    transformed text
  - justified
```
static Collection<StrBuilder> justified(String text,
                                        int textWidth,
                                        int format,
                                        Character innerWS,
                                        IsCollectionStrategy<?,StrBuilder> strategy)
```
    Transforms text to justified lines.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    innerWS - character for replacing whitespaces in the text
    
    strategy - the strategy for the returned collection
    
    Returns:
    
    transformed text
  - justifiedLeft
```
static Collection<StrBuilder> justifiedLeft(String text,
                                            int textWidth)
```
    Transforms text to justified lines, last line being left aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    Returns:
    
    transformed text
  - justifiedLeft
```
static Collection<StrBuilder> justifiedLeft(String text,
                                            int textWidth,
                                            int format)
```
    Transforms text to justified lines, last line being left aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    Returns:
    
    transformed text
  - justifiedLeft
```
static Collection<StrBuilder> justifiedLeft(String text,
                                            int textWidth,
                                            int format,
                                            Character padding)
```
    Transforms text to justified lines, last line being left aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding for the last line
    
    Returns:
    
    transformed text
  - justifiedLeft
```
static Collection<StrBuilder> justifiedLeft(String text,
                                            int textWidth,
                                            int format,
                                            Character padding,
                                            Character innerWS)
```
    Transforms text to justified lines, last line being left aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding for the last line
    
    innerWS - character for replacing whitespaces in the text
    
    Returns:
    
    transformed text
  - justifiedLeft
```
static Collection<StrBuilder> justifiedLeft(String text,
                                            int textWidth,
                                            int format,
                                            Character padding,
                                            Character innerWS,
                                            IsCollectionStrategy<?,StrBuilder> strategy)
```
    Transforms text to justified lines, last line being left aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding for the last line
    
    innerWS - character for replacing whitespaces in the text
    
    strategy - the strategy for the returned collection
    
    Returns:
    
    transformed text
  - justifiedRight
```
static Collection<StrBuilder> justifiedRight(String text,
                                             int textWidth)
```
    Transforms text to justified lines, last line being right aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    Returns:
    
    transformed text
  - justifiedRight
```
static Collection<StrBuilder> justifiedRight(String text,
                                             int textWidth,
                                             int format)
```
    Transforms text to justified lines, last line being right aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    Returns:
    
    transformed text
  - justifiedRight
```
static Collection<StrBuilder> justifiedRight(String text,
                                             int textWidth,
                                             int format,
                                             Character padding)
```
    Transforms text to justified lines, last line being right aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding for the last line
    
    Returns:
    
    transformed text
  - justifiedRight
```
static Collection<StrBuilder> justifiedRight(String text,
                                             int textWidth,
                                             int format,
                                             Character padding,
                                             Character innerWS)
```
    Transforms text to justified lines, last line being right aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding for the last line
    
    innerWS - character for replacing whitespaces in the text
    
    Returns:
    
    transformed text
  - justifiedRight
```
static Collection<StrBuilder> justifiedRight(String text,
                                             int textWidth,
                                             int format,
                                             Character padding,
                                             Character innerWS,
                                             IsCollectionStrategy<?,StrBuilder> strategy)
```
    Transforms text to justified lines, last line being right aligned.
    
    Parameters:
    
    text - the input text
    
    textWidth - the width of each line
    
    format - a format for the text
    
    padding - character for padding for the last line
    
    innerWS - character for replacing whitespaces in the text
    
    strategy - the strategy for the returned collection
    
    Returns:
    
    transformed text

Interface Text_To_FormattedText

Field Summary

Method Summary

Methods inherited from interface Transformer

Methods inherited from interface Function

Field Detail

ALIGN_LEFT

ALIGN_CENTER

ALIGN_RIGHT

ALIGN_JUSTIFIED

ALIGN_JUSTIFIED_LEFT

ALIGN_JUSTIFIED_RIGHT

FORMAT_NONE

FORMAT_FIRST_LINE

FORMAT_HANGING_PARAGRAPH

FORMAT_FIRSTLINE_AND_HANGINGPARAGRAPH

FORMAT_DROPCAP

FORMAT_DROPCAP_WITH_PADDING

DEFAULT_TEXT_WIDTH

DEFAULT_LEFT_PADDING_CHARACTER

DEFAULT_RIGHT_PADDING_CHARACTER

DEFAULT_INNER_WHITESPACE_CHARACTER

DEFAULT_HANGING_INDENTATION

DEFAULT_FIRSTLINE_INDENTATION

DEFAULT_CHARS_BETWEEN_DROPCAP_AND_TEXT

DEFAULT_LINES_AFTER_DROPCAP

DEFAULT_COLLECTION_STRATEGY

Method Detail

getAlignment

getFormat

getInnerWsChar

getLeftPaddingChar

getRightPaddingChar

getTextWidth

getCollectionStrategy

getHangingIndentation

getFirstlineIndentation

getCharsBetweenDroppcapAndText

getLinesAfterDropcap

transform

getDropCap

transform

create

left

left

left

left

left

center

center

center

center

center

center

right

right

right

right

right

justified

justified

justified

justified

justifiedLeft

justifiedLeft

justifiedLeft

justifiedLeft

justifiedLeft

justifiedRight

justifiedRight

justifiedRight

justifiedRight

justifiedRight