net.kyori.text

Class KeybindComponent

java.lang.Object

net.kyori.text.AbstractComponent

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

net.kyori.text.KeybindComponent

All Implemented Interfaces:

BuildableComponent<KeybindComponent,KeybindComponent.Builder>, Component

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeybindComponent.Builder A keybind 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	KeybindComponent(@NonNull KeybindComponent.Builder builder)
protected	KeybindComponent(@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 keybind)

Method Summary

Modifier and Type	Method and Description
@NonNull KeybindComponent	append(@NonNull Component component) Appends a component to this component.
static KeybindComponent.Builder	builder() Creates a keybind component builder.
static KeybindComponent.Builder	builder(@NonNull java.lang.String keybind) Creates a keybind component builder with a keybind.
@NonNull KeybindComponent	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
@NonNull KeybindComponent	color(@Nullable TextColor color) Sets the color of this component.
@NonNull KeybindComponent	copy() Creates a component.
@NonNull KeybindComponent	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
@NonNull KeybindComponent	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 KeybindComponent	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
@NonNull KeybindComponent	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
@NonNull java.lang.String	keybind() Gets the keybind.
@NonNull KeybindComponent	keybind(@NonNull java.lang.String keybind) Sets the keybind.
static KeybindComponent	make(@NonNull java.util.function.Consumer<KeybindComponent.Builder> consumer) Creates a keybind component by applying configuration from consumer.
static KeybindComponent	make(@NonNull java.lang.String keybind, @NonNull java.util.function.Consumer<KeybindComponent.Builder> consumer) Creates a keybind component by applying configuration from consumer.
@NonNull KeybindComponent	mergeColor(@NonNull Component that) Merges the color from another component into this component.
@NonNull KeybindComponent	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
@NonNull KeybindComponent	mergeEvents(@NonNull Component that) Merges the events from another component into this component.
@NonNull KeybindComponent	mergeStyle(@NonNull Component that) Merges styling from another component into this component.
static KeybindComponent	of(@NonNull java.lang.String keybind) Creates a keybind component with a keybind.
static KeybindComponent	of(@NonNull java.lang.String keybind, @Nullable TextColor color) Creates a keybind component with content, and optional color.
static KeybindComponent	of(@NonNull java.lang.String keybind, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations) Creates a keybind component with content, and optional color and decorations.
protected void	populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)
@NonNull KeybindComponent	resetStyle() Resets all styling on this component.
@NonNull KeybindComponent.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

KeybindComponent

protected KeybindComponent(@NonNull KeybindComponent.Builder builder)

KeybindComponent

protected KeybindComponent(@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 keybind)

Method Detail

builder

public static KeybindComponent.Builder builder()

Creates a keybind component builder.

Returns:

a builder

builder

public static KeybindComponent.Builder builder(@NonNull java.lang.String keybind)

Creates a keybind component builder with a keybind.

Parameters:

keybind - the keybind

Returns:

a builder

of

public static KeybindComponent of(@NonNull java.lang.String keybind)

Creates a keybind component with a keybind.

Parameters:

keybind - the keybind

Returns:

the keybind component

of

public static KeybindComponent of(@NonNull java.lang.String keybind,
                                  @Nullable TextColor color)

Creates a keybind component with content, and optional color.

Parameters:

keybind - the keybind

color - the color

Returns:

the keybind component

of

public static KeybindComponent of(@NonNull java.lang.String keybind,
                                  @Nullable TextColor color,
                                  @NonNull java.util.Set<TextDecoration> decorations)

Creates a keybind component with content, and optional color and decorations.

Parameters:

keybind - the keybind

color - the color

decorations - the decorations

Returns:

the keybind component

make

public static KeybindComponent make(@NonNull java.util.function.Consumer<KeybindComponent.Builder> consumer)

Creates a keybind component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the keybind component

make

public static KeybindComponent make(@NonNull java.lang.String keybind,
                                    @NonNull java.util.function.Consumer<KeybindComponent.Builder> consumer)

Creates a keybind component by applying configuration from consumer.

Parameters:

keybind - the keybind

consumer - the builder configurator

Returns:

the keybind component

keybind

public @NonNull java.lang.String keybind()

Gets the keybind.

Returns:

the keybind

keybind

public @NonNull KeybindComponent keybind(@NonNull java.lang.String keybind)

Sets the keybind.

Parameters:

keybind - the keybind

Returns:

a copy of this component

append

public @NonNull KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent 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 KeybindComponent resetStyle()

Description copied from interface: Component

Resets all styling on this component.

Returns:

a component

copy

public @NonNull KeybindComponent 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 KeybindComponent.Builder toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Returns:

the builder