org.spongepowered.api.text.format

Class TextStyle

java.lang.Object

org.spongepowered.api.text.format.TextStyle

All Implemented Interfaces:

TextElement

Direct Known Subclasses:

TextStyle.Base

@CatalogedBy(value=TextStyles.class)
public class TextStyle
extends Object
implements TextElement

Represents an immutable text style of a Text. It is a utility that is not normally present in Minecraft. It can be either empty, a TextStyle.Base with an additional legacy formatting code or a composite.

Combined styles can be created using TextStyles.of(TextStyle...) or using one of the and(TextStyle...), andNot(TextStyle...) or negate() method.

Each individual style within a TextStyle, e.g. bold, italic is not just a boolean, but an Optional<Boolean> since it can be unapplied (or, in Optional terms, "empty"). These styles will hereafter be referred to as properties.
See the OptBool utility class for working with properties.

Implementation note: Absent styles should not appear in the final chat component JSON. Properties that are set to true or false should appear, even if they override inherited properties.

See Also:

TextStyles

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextStyle.Base Represents a TextStyle that is not a composite, for example TextStyles.BOLD.

Field Summary

Fields

Modifier and Type	Field and Description
protected Optional<Boolean>	bold Whether text where this style is applied is bolded.
protected Optional<Boolean>	italic Whether text where this style is applied is italicized.
protected Optional<Boolean>	obfuscated Whether text where this style is applied is obfuscated.
protected Optional<Boolean>	strikethrough Whether text where this style is applied has a strikethrough.
protected Optional<Boolean>	underline Whether text where this style is applied is underlined.

Constructor Summary

Constructors

Constructor and Description
TextStyle(Boolean bold, Boolean italic, Boolean underline, Boolean strikethrough, Boolean obfuscated) Constructs a new TextStyle.

Method Summary

Modifier and Type	Method and Description
TextStyle	and(TextStyle... styles) Composes this TextStyle with the specified text styles.
TextStyle	andNot(TextStyle... styles) Composes this TextStyle with the passed in TextStyles, but negates them before composition.
void	applyTo(Text.Builder builder) Applies this element to the end of the specified builder.
TextStyle	bold(Boolean bold) Returns a new TextStyle with the bold property changed.
boolean	contains(TextStyle... styles) Returns whether the given TextStyle is contained in this TextStyle.
boolean	equals(Object o)
int	hashCode()
Optional<Boolean>	hasStrikethrough() Checks for whether text where this style is applied has a strikethrough.
Optional<Boolean>	hasUnderline() Checks for whether text where this style is applied has an underline.
Optional<Boolean>	isBold() Checks for whether text where this style is applied is bolded.
boolean	isComposite() Returns whether this TextStyle is a composite of multiple text styles.
boolean	isEmpty() Returns whether this TextStyle has no set properties.
Optional<Boolean>	isItalic() Checks for whether text where this style is applied is italicized.
Optional<Boolean>	isObfuscated() Checks for whether text where this style is obfuscated.
TextStyle	italic(Boolean italic) Returns a new TextStyle with the italic property changed.
TextStyle	negate() Negates this TextStyle.
TextStyle	obfuscated(Boolean obfuscated) Returns a new TextStyle with the obfuscated property changed.
TextStyle	strikethrough(Boolean strikethrough) Returns a new TextStyle with the strikethrough property changed.
String	toString()
TextStyle	underline(Boolean underline) Returns a new TextStyle with the underline property changed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

bold

protected final Optional<Boolean> bold

Whether text where this style is applied is bolded.

italic

protected final Optional<Boolean> italic

Whether text where this style is applied is italicized.

underline

protected final Optional<Boolean> underline

Whether text where this style is applied is underlined.

strikethrough

protected final Optional<Boolean> strikethrough

Whether text where this style is applied has a strikethrough.

obfuscated

protected final Optional<Boolean> obfuscated

Whether text where this style is applied is obfuscated.

Constructor Detail

TextStyle

public TextStyle(@Nullable
                 Boolean bold,
                 @Nullable
                 Boolean italic,
                 @Nullable
                 Boolean underline,
                 @Nullable
                 Boolean strikethrough,
                 @Nullable
                 Boolean obfuscated)

Constructs a new TextStyle.

Parameters:

bold - Whether text where this style is applied is bolded

italic - Whether text where this style is applied is italicized

underline - Whether text where this style is applied is underlined

obfuscated - Whether text where this style is applied is obfuscated

strikethrough - Whether text where this style is applied has a strikethrough

Method Detail

isComposite

public boolean isComposite()

Returns whether this TextStyle is a composite of multiple text styles.

Returns:

true if this text style is a composite

isEmpty

public boolean isEmpty()

Returns whether this TextStyle has no set properties.

Returns:

true if this style is empty

bold

public TextStyle bold(@Nullable
                      Boolean bold)

Returns a new TextStyle with the bold property changed.

Parameters:

bold - Whether text where the new style is applied is bolded

Returns:

The new text style

italic

public TextStyle italic(@Nullable
                        Boolean italic)

Returns a new TextStyle with the italic property changed.

Parameters:

italic - Whether text where the new style is applied is italicized

Returns:

The new text style

underline

public TextStyle underline(@Nullable
                           Boolean underline)

Returns a new TextStyle with the underline property changed.

Parameters:

underline - Whether text where the new style is applied is underline

Returns:

The new text style

strikethrough

public TextStyle strikethrough(@Nullable
                               Boolean strikethrough)

Returns a new TextStyle with the strikethrough property changed.

Parameters:

strikethrough - Whether text where the new style is applied has a strikethrough

Returns:

The new text style

obfuscated

public TextStyle obfuscated(@Nullable
                            Boolean obfuscated)

Returns a new TextStyle with the obfuscated property changed.

Parameters:

obfuscated - Whether text where the new style is applied is obfuscated

Returns:

The new text style

isBold

public Optional<Boolean> isBold()

Checks for whether text where this style is applied is bolded.

Returns:

The value for the bold property, or Optional.empty()

isItalic

public Optional<Boolean> isItalic()

Checks for whether text where this style is applied is italicized.

Returns:

The value for the italic property, or Optional.empty()

hasUnderline

public Optional<Boolean> hasUnderline()

Checks for whether text where this style is applied has an underline.

Returns:

The value for the underline property, or Optional.empty()

hasStrikethrough

public Optional<Boolean> hasStrikethrough()

Checks for whether text where this style is applied has a strikethrough.

Returns:

The value for the strikethrough property, or Optional.empty()

isObfuscated

public Optional<Boolean> isObfuscated()

Checks for whether text where this style is obfuscated.

Returns:

The value for the obfuscated property, or Optional.empty()

contains

public boolean contains(TextStyle... styles)

Returns whether the given TextStyle is contained in this TextStyle.

For example, a TextStyle with bold: true, italic: true} would return true for contains( TextStyles.BOLD) and contains( TextStyles.ITALIC).

If the specified TextStyle is a composite of multiple styles it returns true if this style has at least all of the properties set in the specified style.

Parameters:

styles - The text styles to check

Returns:

true if the given text styles are contained in this text style

negate

public TextStyle negate()

Negates this TextStyle. This is useful for undoing text styles that are inherited from parent messages.

Returns:

The inverse of this text style

and

public TextStyle and(TextStyle... styles)

Composes this TextStyle with the specified text styles.

Parameters:

styles - The text styles to compose this one with

Returns:

A new text style composed out of the given text styles

andNot

public TextStyle andNot(TextStyle... styles)

Composes this TextStyle with the passed in TextStyles, but negates them before composition. This is the same as negating all the passed in TextStyle and then using the and(TextStyle...) method.

Parameters:

styles - The text styles to compose this one with

Returns:

A new text style composed out of the given text styles

applyTo

public void applyTo(Text.Builder builder)

Description copied from interface: TextElement

Applies this element to the end of the specified builder.

Specified by:

applyTo in interface TextElement

Parameters:

builder - Text builder to apply to

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object