net.kyori.text.format

Class Style.Builder

java.lang.Object

net.kyori.text.format.Style.Builder

Enclosing class:

Style

public static class Style.Builder
extends java.lang.Object

A style builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()
protected	Builder(@NonNull Component component)
protected	Builder(@NonNull Style style)

Method Summary

Modifier and Type	Method and Description
@NonNull Style	build() Builds the style.
@NonNull Style.Builder	clickEvent(@Nullable ClickEvent event) Sets the click event.
@NonNull Style.Builder	color(@Nullable TextColor color) Sets the color.
@NonNull Style.Builder	colorIfAbsent(@Nullable TextColor color) Sets the color if there isn't one set already.
@NonNull Style.Builder	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this style.
@NonNull Style.Builder	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration.
@NonNull Style.Builder	hoverEvent(@Nullable HoverEvent event) Sets the hover event.
@NonNull Style.Builder	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder()

Builder

protected Builder(@NonNull Component component)

Builder

protected Builder(@NonNull Style style)

Method Detail

color

public @NonNull Style.Builder color(@Nullable TextColor color)

Sets the color.

Parameters:

color - the color

Returns:

this builder

colorIfAbsent

public @NonNull Style.Builder colorIfAbsent(@Nullable TextColor color)

Sets the color if there isn't one set already.

Parameters:

color - the color

Returns:

this builder

decoration

public @NonNull Style.Builder decoration(@NonNull TextDecoration decoration,
                                         boolean flag)

Sets the state of a decoration on this style.

Parameters:

decoration - the decoration

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

Returns:

a style

decoration

public @NonNull Style.Builder decoration(@NonNull TextDecoration decoration,
                                         TextDecoration.State state)

Sets the value of a decoration.

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:

this builder

clickEvent

public @NonNull Style.Builder clickEvent(@Nullable ClickEvent event)

Sets the click event.

Parameters:

event - the click event

Returns:

this builder

hoverEvent

public @NonNull Style.Builder hoverEvent(@Nullable HoverEvent event)

Sets the hover event.

Parameters:

event - the hover event

Returns:

this builder

insertion

public @NonNull Style.Builder insertion(@Nullable java.lang.String insertion)

Sets the string to be inserted.

Parameters:

insertion - the insertion string

Returns:

this builder

build

public @NonNull Style build()

Builds the style.

Returns:

the style