net.kyori.text

Class AbstractComponent

java.lang.Object

net.kyori.text.AbstractComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbstractBuildableComponent

public abstract class AbstractComponent
extends java.lang.Object
implements Component

An abstract implementation of a text component.

Field Summary

Fields

Modifier and Type	Field and Description
protected TextDecoration.State	bold If this component should have the bold decoration.
protected @NonNull java.util.List<Component>	children The list of children.
protected @Nullable ClickEvent	clickEvent The click event to apply to this component.
protected @Nullable TextColor	color The color of this component.
protected @Nullable HoverEvent	hoverEvent The hover event to apply to this component.
protected @Nullable java.lang.String	insertion The string to insert when this component is shift-clicked in chat.
protected TextDecoration.State	italic If this component should have the italic decoration.
protected TextDecoration.State	obfuscated If this component should have the obfuscated decoration.
protected TextDecoration.State	strikethrough If this component should have the strikethrough decoration.
protected TextDecoration.State	underlined If this component should have the underlined decoration.

Fields inherited from interface net.kyori.text.Component

EMPTY_COMPONENT_LIST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractComponent(@NonNull java.util.List<Component> children, @Nullable TextColor color, TextDecoration.State obfuscated, TextDecoration.State bold, TextDecoration.State strikethrough, TextDecoration.State underlined, TextDecoration.State italic, @Nullable ClickEvent clickEvent, @Nullable HoverEvent hoverEvent, @Nullable java.lang.String insertion)

Method Summary

Modifier and Type	Method and Description
@NonNull java.util.List<Component>	children() Gets the unmodifiable list of children.
@Nullable ClickEvent	clickEvent() Gets the click event of this component.
@Nullable TextColor	color() Gets the color of this component.
TextDecoration.State	decoration(@NonNull TextDecoration decoration) Gets the state of a decoration on this component.
protected boolean	equals(@NonNull AbstractComponent that)
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
boolean	hasStyling() Tests if this component has any styling.
@Nullable HoverEvent	hoverEvent() Gets the hover event of this component.
@Nullable java.lang.String	insertion() Gets the string to be inserted when this component is shift-clicked.
protected void	populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)
@NonNull java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.text.Component

append, clickEvent, color, contains, copy, decoration, decoration, decorations, decorations, detectCycle, hasDecoration, hoverEvent, insertion, mergeColor, mergeDecorations, mergeEvents, mergeStyle, of, of, of, of, of, of, resetStyle

Field Detail

children

protected final @NonNull java.util.List<Component> children

The list of children.

color

protected final @Nullable TextColor color

The color of this component.

obfuscated

protected final TextDecoration.State obfuscated

If this component should have the obfuscated decoration.

bold

protected final TextDecoration.State bold

If this component should have the bold decoration.

strikethrough

protected final TextDecoration.State strikethrough

If this component should have the strikethrough decoration.

underlined

protected final TextDecoration.State underlined

If this component should have the underlined decoration.

italic

protected final TextDecoration.State italic

If this component should have the italic decoration.

clickEvent

protected final @Nullable ClickEvent clickEvent

The click event to apply to this component.

hoverEvent

protected final @Nullable HoverEvent hoverEvent

The hover event to apply to this component.

insertion

protected final @Nullable java.lang.String insertion

The string to insert when this component is shift-clicked in chat.

Constructor Detail

AbstractComponent

protected AbstractComponent(@NonNull java.util.List<Component> children,
                            @Nullable TextColor color,
                            TextDecoration.State obfuscated,
                            TextDecoration.State bold,
                            TextDecoration.State strikethrough,
                            TextDecoration.State underlined,
                            TextDecoration.State italic,
                            @Nullable ClickEvent clickEvent,
                            @Nullable HoverEvent hoverEvent,
                            @Nullable java.lang.String insertion)

Method Detail

children

public @NonNull java.util.List<Component> children()

Description copied from interface: Component

Gets the unmodifiable list of children.

Specified by:

children in interface Component

Returns:

the unmodifiable list of children

color

public @Nullable TextColor color()

Description copied from interface: Component

Gets the color of this component.

Specified by:

color in interface Component

Returns:

the color of this component

decoration

public TextDecoration.State decoration(@NonNull TextDecoration decoration)

Description copied from interface: Component

Gets the state of a decoration on this component.

Specified by:

decoration in interface Component

Parameters:

decoration - the decoration

Returns:

TextDecoration.State#TRUE if this component has the decoration, TextDecoration.State#FALSE if this component does not have the decoration, and TextDecoration.State#NOT_SET if not set

clickEvent

public @Nullable ClickEvent clickEvent()

Description copied from interface: Component

Gets the click event of this component.

Specified by:

clickEvent in interface Component

Returns:

the click event

hoverEvent

public @Nullable HoverEvent hoverEvent()

Description copied from interface: Component

Gets the hover event of this component.

Specified by:

hoverEvent in interface Component

Returns:

the hover event

insertion

public @Nullable java.lang.String insertion()

Description copied from interface: Component

Gets the string to be inserted when this component is shift-clicked.

Specified by:

insertion in interface Component

Returns:

the insertion string

hasStyling

public boolean hasStyling()

Description copied from interface: Component

Tests if this component has any styling.

Specified by:

hasStyling in interface Component

Returns:

true if this component has any styling, false if this component does not have any styling

equals

public boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

equals

protected boolean equals(@NonNull AbstractComponent that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public @NonNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

populateToString

protected void populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)