net.kyori.text

Class SelectorComponent

java.lang.Object

net.kyori.text.AbstractComponent

net.kyori.text.AbstractBuildableComponent<SelectorComponent,SelectorComponent.Builder>

net.kyori.text.SelectorComponent

All Implemented Interfaces:

BuildableComponent<SelectorComponent,SelectorComponent.Builder>, Component

public class SelectorComponent
extends AbstractBuildableComponent<SelectorComponent,SelectorComponent.Builder>

A scoreboard selector component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectorComponent.Builder A selector component builder.

Nested classes/interfaces inherited from class net.kyori.text.AbstractBuildableComponent

AbstractBuildableComponent.AbstractBuilder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>

Field Summary

Fields inherited from class net.kyori.text.AbstractComponent

bold, children, clickEvent, color, hoverEvent, insertion, italic, obfuscated, strikethrough, underlined

Fields inherited from interface net.kyori.text.Component

EMPTY_COMPONENT_LIST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SelectorComponent(@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, @NonNull java.lang.String pattern)
protected	SelectorComponent(@NonNull SelectorComponent.Builder builder)

Method Summary

Modifier and Type	Method and Description
@NonNull SelectorComponent	append(@NonNull Component component) Appends a component to this component.
static SelectorComponent.Builder	builder() Creates a selector component builder.
static SelectorComponent.Builder	builder(@NonNull java.lang.String pattern) Creates a selector component builder with a pattern.
@NonNull SelectorComponent	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
@NonNull SelectorComponent	color(@Nullable TextColor color) Sets the color of this component.
@NonNull SelectorComponent	copy() Creates a component.
@NonNull SelectorComponent	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
@NonNull SelectorComponent	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration on this component.
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
@NonNull SelectorComponent	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
@NonNull SelectorComponent	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
@NonNull SelectorComponent	mergeColor(@NonNull Component that) Merges the color from another component into this component.
@NonNull SelectorComponent	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
@NonNull SelectorComponent	mergeEvents(@NonNull Component that) Merges the events from another component into this component.
@NonNull SelectorComponent	mergeStyle(@NonNull Component that) Merges styling from another component into this component.
static SelectorComponent	of(@NonNull java.lang.String pattern) Creates a selector component with a pattern.
@NonNull java.lang.String	pattern() Gets the selector pattern.
@NonNull SelectorComponent	pattern(@NonNull java.lang.String pattern) Sets the selector pattern.
protected void	populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)
@NonNull SelectorComponent	resetStyle() Resets all styling on this component.
@NonNull SelectorComponent.Builder	toBuilder() Create a builder from this component.

Methods inherited from class net.kyori.text.AbstractComponent

children, clickEvent, color, decoration, equals, hasStyling, hoverEvent, insertion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.text.Component

children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, of, of, of, of, of, of

Constructor Detail

SelectorComponent

protected SelectorComponent(@NonNull SelectorComponent.Builder builder)

SelectorComponent

protected SelectorComponent(@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,
                            @NonNull java.lang.String pattern)

Method Detail

builder

public static SelectorComponent.Builder builder()

Creates a selector component builder.

Returns:

a builder

builder

public static SelectorComponent.Builder builder(@NonNull java.lang.String pattern)

Creates a selector component builder with a pattern.

Parameters:

pattern - the selector pattern

Returns:

a builder

of

public static SelectorComponent of(@NonNull java.lang.String pattern)

Creates a selector component with a pattern.

Parameters:

pattern - the selector pattern

Returns:

the selector component

pattern

public @NonNull java.lang.String pattern()

Gets the selector pattern.

Returns:

the selector pattern

pattern

public @NonNull SelectorComponent pattern(@NonNull java.lang.String pattern)

Sets the selector pattern.

Parameters:

pattern - the selector pattern

Returns:

a copy of this component

append

public @NonNull SelectorComponent append(@NonNull Component component)

Description copied from interface: Component

Appends a component to this component.

Parameters:

component - the component to append

Returns:

a component with the component added

color

public @NonNull SelectorComponent color(@Nullable TextColor color)

Description copied from interface: Component

Sets the color of this component.

Parameters:

color - the color

Returns:

a component

decoration

public @NonNull SelectorComponent decoration(@NonNull TextDecoration decoration,
                                             boolean flag)

Description copied from interface: Component

Sets the state of a decoration on this component.

Parameters:

decoration - the decoration

flag - true if this component should have the decoration, false if this component should not have the decoration

Returns:

a component

decoration

public @NonNull SelectorComponent decoration(@NonNull TextDecoration decoration,
                                             TextDecoration.State state)

Description copied from interface: Component

Sets the value of a decoration on this component.

Parameters:

decoration - the decoration

state - TextDecoration.State#TRUE if this component should have the decoration, TextDecoration.State#FALSE if this component should not have the decoration, and TextDecoration.State#NOT_SET if the decoration should not have a set value

Returns:

a component

clickEvent

public @NonNull SelectorComponent clickEvent(@Nullable ClickEvent event)

Description copied from interface: Component

Sets the click event of this component.

Parameters:

event - the click event

Returns:

a component

hoverEvent

public @NonNull SelectorComponent hoverEvent(@Nullable HoverEvent event)

Description copied from interface: Component

Sets the hover event of this component.

Parameters:

event - the hover event

Returns:

a component

insertion

public @NonNull SelectorComponent insertion(@Nullable java.lang.String insertion)

Description copied from interface: Component

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

Parameters:

insertion - the insertion string

Returns:

a component

mergeStyle

public @NonNull SelectorComponent mergeStyle(@NonNull Component that)

Description copied from interface: Component

Merges styling from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeColor

public @NonNull SelectorComponent mergeColor(@NonNull Component that)

Description copied from interface: Component

Merges the color from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeDecorations

public @NonNull SelectorComponent mergeDecorations(@NonNull Component that)

Description copied from interface: Component

Merges the decorations from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeEvents

public @NonNull SelectorComponent mergeEvents(@NonNull Component that)

Description copied from interface: Component

Merges the events from another component into this component.

Parameters:

that - the other component

Returns:

a component

resetStyle

public @NonNull SelectorComponent resetStyle()

Description copied from interface: Component

Resets all styling on this component.

Returns:

a component

copy

public @NonNull SelectorComponent copy()

Description copied from interface: Component

Creates a component.

Returns:

a component

equals

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

Overrides:

equals in class AbstractComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractComponent

populateToString

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

Overrides:

populateToString in class AbstractComponent

toBuilder

public @NonNull SelectorComponent.Builder toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Returns:

the builder