Package com.nomagic.text.builders

Class ColoredRichTextBuilder<T extends ColoredRichTextBuilder>

java.lang.Object

com.nomagic.text.builders.AbstractTextBuilder<T>

com.nomagic.text.builders.RichTextBuilder<T>

com.nomagic.text.builders.ColoredRichTextBuilder<T>

All Implemented Interfaces:

TextBuilder<T>

@OpenApiAll
public class ColoredRichTextBuilder<T extends ColoredRichTextBuilder>
extends RichTextBuilder<T>

A builder used for rich text building. Colored fragments are supported.

Field Summary

Fields

Modifier and Type	Field	Description
private com.nomagic.text.builders.ColorBuilder	colorBuilder

Constructor Summary

Constructors

Constructor	Description
ColoredRichTextBuilder()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	appendColor(java.lang.String text)
void	compress(int textLength)	Compress current text to the given length.
boolean	isColorSupported()
protected java.lang.String	prependColor(java.lang.String text)
T	setColor(java.awt.Color color)	Set color of the text which will be added later.
void	setText(java.lang.CharSequence text)	Replace current text with the given one
java.lang.String	toString()

Methods inherited from class com.nomagic.text.builders.RichTextBuilder

toAppendableText, toPlainText

Methods inherited from class com.nomagic.text.builders.AbstractTextBuilder

append, appendToText, isTextAdded, prepend, prependToText, replaceText, textLength

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.text.builders.TextBuilder

append, appendWithNoWrap, isPlainTextEmpty, prepend, prependWithNoWrap, setText

Field Detail

colorBuilder

private final com.nomagic.text.builders.ColorBuilder colorBuilder

Constructor Detail

ColoredRichTextBuilder

public ColoredRichTextBuilder()

Method Detail

setColor

public T setColor(@CheckForNull
                  java.awt.Color color)

Description copied from interface: TextBuilder

Set color of the text which will be added later. Not every implementation supports that, so color can be ignored.

Parameters:

color - color to set. Null is used to reset previously set color

Returns:

this builder

compress

public void compress(int textLength)

Description copied from interface: TextBuilder

Compress current text to the given length. This function is not supported in every implementation, so it can be ignored.

Specified by:

compress in interface TextBuilder<T extends ColoredRichTextBuilder>

Overrides:

compress in class RichTextBuilder<T extends ColoredRichTextBuilder>

Parameters:

textLength - text length

appendColor

protected java.lang.String appendColor(java.lang.String text)

Overrides:

appendColor in class AbstractTextBuilder<T extends ColoredRichTextBuilder>

prependColor

protected java.lang.String prependColor(java.lang.String text)

Overrides:

prependColor in class AbstractTextBuilder<T extends ColoredRichTextBuilder>

setText

public void setText(java.lang.CharSequence text)

Description copied from interface: TextBuilder

Replace current text with the given one

Specified by:

setText in interface TextBuilder<T extends ColoredRichTextBuilder>

Overrides:

setText in class AbstractTextBuilder<T extends ColoredRichTextBuilder>

Parameters:

text - text

toString

public java.lang.String toString()

Specified by:

toString in interface TextBuilder<T extends ColoredRichTextBuilder>

Overrides:

toString in class AbstractTextBuilder<T extends ColoredRichTextBuilder>

Returns:

result string

isColorSupported

public boolean isColorSupported()

Returns:

true if builder supports color