net.md_5.bungee.api.chat

Class TextComponent

java.lang.Object

net.md_5.bungee.api.chat.BaseComponent

net.md_5.bungee.api.chat.TextComponent

public final class TextComponent
extends BaseComponent

Constructor Summary

Constructors

Constructor and Description
TextComponent() Creates a TextComponent with blank text.
TextComponent(BaseComponent... extras) Creates a TextComponent with blank text and the extras set to the passed array
TextComponent(TextComponent textComponent) Creates a TextComponent with formatting and text from the passed component

Method Summary

Modifier and Type	Method and Description
BaseComponent	duplicate() Creates a duplicate of this TextComponent.
static BaseComponent[]	fromLegacyText(java.lang.String message) Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.
static BaseComponent[]	fromLegacyText(java.lang.String message, ChatColor defaultColor) Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.
protected void	toLegacyText(java.lang.StringBuilder builder)
protected void	toPlainText(java.lang.StringBuilder builder)
java.lang.String	toString()

Methods inherited from class net.md_5.bungee.api.chat.BaseComponent

addExtra, addExtra, copyFormatting, copyFormatting, copyFormatting, duplicateWithoutFormatting, getColor, getColorRaw, hasFormatting, isBold, isBoldRaw, isItalic, isItalicRaw, isObfuscated, isObfuscatedRaw, isStrikethrough, isStrikethroughRaw, isUnderlined, isUnderlinedRaw, retain, setExtra, toLegacyText, toLegacyText, toPlainText, toPlainText

Methods inherited from class java.lang.Object

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

Constructor Detail

TextComponent

public TextComponent()

Creates a TextComponent with blank text.

TextComponent

public TextComponent(TextComponent textComponent)

Creates a TextComponent with formatting and text from the passed component

Parameters:

textComponent - the component to copy from

TextComponent

public TextComponent(BaseComponent... extras)

Creates a TextComponent with blank text and the extras set to the passed array

Parameters:

extras - the extras to set

Method Detail

fromLegacyText

public static BaseComponent[] fromLegacyText(java.lang.String message)

Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.

Parameters:

message - the text to convert

Returns:

the components needed to print the message to the client

fromLegacyText

public static BaseComponent[] fromLegacyText(java.lang.String message,
                                             ChatColor defaultColor)

Converts the old formatting system that used ChatColor.COLOR_CHAR into the new json based system.

Parameters:

message - the text to convert

defaultColor - color to use when no formatting is to be applied (i.e. after ChatColor.RESET).

Returns:

the components needed to print the message to the client

duplicate

public BaseComponent duplicate()

Creates a duplicate of this TextComponent.

Specified by:

duplicate in class BaseComponent

Returns:

the duplicate of this TextComponent.

toPlainText

protected void toPlainText(java.lang.StringBuilder builder)

toLegacyText

protected void toLegacyText(java.lang.StringBuilder builder)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object