All Superinterfaces:: AbstractBuilder<Style>, MutableStyleSetter<Style.Builder>, StyleSetter<Style.Builder>

Enclosing interface:: Style

public static sealed interface Style.Builder extends AbstractBuilder<Style>, MutableStyleSetter<Style.Builder>

A style builder.

Since:: 4.0.0

Method Summary

Modifier and Type

Method

Description

default Style.Builder

apply(StyleBuilderApplicable applicable)

Applies applicable to this builder.

Style

build()

Builds the style.

Style.Builder

clickEvent(@Nullable ClickEvent<?> event)

Sets the click event.

Style.Builder

color(@Nullable TextColor color)

Sets the color.

Style.Builder

colorIfAbsent(@Nullable TextColor color)

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

default Style.Builder

decorate(TextDecoration decoration)

Sets decoration to TextDecoration.State.TRUE.

default Style.Builder

decorate(TextDecoration... decorations)

Sets decorations to TextDecoration.State.TRUE.

default Style.Builder

decoration(TextDecoration decoration, boolean flag)

Sets the state of a decoration on this style.

Style.Builder

decoration(TextDecoration decoration, TextDecoration.State state)

Sets the value of a decoration.

Style.Builder

decorationIfAbsent(TextDecoration decoration, TextDecoration.State state)

Sets the state of a decoration on this style to state if the current state of the decoration is TextDecoration.State.NOT_SET.

default Style.Builder

decorations(Map<TextDecoration, TextDecoration.State> decorations)

Sets decorations for this style using the specified decorations map.

Style.Builder

font(@Nullable Key font)

Sets the font.

Style.Builder

hoverEvent(@Nullable HoverEventSource<?> source)

Sets the hover event.

Style.Builder

insertion(@Nullable String insertion)

Sets the string to be inserted.

default Style.Builder

merge(Style that)

Merges from another style into this style.

default Style.Builder

merge(Style that, Set<Style.Merge> merges)

Merges from another style into this style.

default Style.Builder

merge(Style that, Style.Merge... merges)

Merges from another style into this style.

default Style.Builder

merge(Style that, Style.Merge.Strategy strategy)

Merges from another style into this style.

Style.Builder

merge(Style that, Style.Merge.Strategy strategy, Set<Style.Merge> merges)

Merges from another style into this style.

default Style.Builder

merge(Style that, Style.Merge.Strategy strategy, Style.Merge... merges)

Merges from another style into this style.

Methods inherited from interface MutableStyleSetter
decorations

Methods inherited from interface StyleSetter
shadowColor, shadowColorIfAbsent

Method Details
- font
  
  @Contract("_ -> this") Style.Builder font(@Nullable Key font)
  
  Sets the font.
  
  Specified by:
  
  font in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  font - the font
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
  
  Since Minecraft:
  
  1.16
- color
  
  @Contract("_ -> this") Style.Builder color(@Nullable TextColor color)
  
  Sets the color.
  
  Specified by:
  
  color in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  color - the color
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- colorIfAbsent
  
  @Contract("_ -> this") Style.Builder colorIfAbsent(@Nullable TextColor color)
  
  Sets the color if there isn't one set already.
  
  Specified by:
  
  colorIfAbsent in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  color - the color
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- decorate
  
  @Contract("_ -> this") default Style.Builder decorate(TextDecoration decoration)
  
  Sets decoration to TextDecoration.State.TRUE.
  
  Specified by:
  
  decorate in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  decoration - the decoration
  
  Returns:
  
  a style
  
  Since:
  
  4.0.0
- decorate
  
  @Contract("_ -> this") default Style.Builder decorate(TextDecoration... decorations)
  
  Sets decorations to TextDecoration.State.TRUE.
  
  Specified by:
  
  decorate in interface MutableStyleSetter<Style.Builder>
  
  Specified by:
  
  decorate in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  decorations - the decorations
  
  Returns:
  
  a style
  
  Since:
  
  4.0.0
- decoration
  
  @Contract("_, _ -> this") default Style.Builder decoration(TextDecoration decoration, boolean flag)
  
  Sets the state of a decoration on this style.
  
  Specified by:
  
  decoration in interface StyleSetter<Style.Builder>
  
  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
  
  Since:
  
  4.0.0
- decorations
  
  @Contract("_ -> this") default Style.Builder decorations(Map<TextDecoration, TextDecoration.State> decorations)
  
  Sets decorations for this style using the specified decorations map.
  If a given decoration does not have a value explicitly set, the value of that particular decoration is not changed.
  
  Specified by:
  
  decorations in interface MutableStyleSetter<Style.Builder>
  
  Specified by:
  
  decorations in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  decorations - a map containing text decorations and their respective state.
  
  Returns:
  
  this builder.
  
  Since:
  
  4.10.0
- decoration
  
  @Contract("_, _ -> this") Style.Builder decoration(TextDecoration decoration, TextDecoration.State state)
  
  Sets the value of a decoration.
  
  Specified by:
  
  decoration in interface StyleSetter<Style.Builder>
  
  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
  
  Since:
  
  4.0.0
- decorationIfAbsent
  
  @Contract("_, _ -> this") Style.Builder decorationIfAbsent(TextDecoration decoration, TextDecoration.State state)
  
  Sets the state of a decoration on this style to state if the current state of the decoration is TextDecoration.State.NOT_SET.
  
  Specified by:
  
  decorationIfAbsent in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  decoration - the decoration
  
  state - the state
  
  Returns:
  
  this builder
  
  Since:
  
  4.12.0
- clickEvent
  
  @Contract("_ -> this") Style.Builder clickEvent(@Nullable ClickEvent<?> event)
  
  Sets the click event.
  
  Specified by:
  
  clickEvent in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  event - the click event
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- hoverEvent
  
  @Contract("_ -> this") Style.Builder hoverEvent(@Nullable HoverEventSource<?> source)
  
  Sets the hover event.
  
  Specified by:
  
  hoverEvent in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  source - the hover event source
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- insertion
  
  @Contract("_ -> this") Style.Builder insertion(@Nullable String insertion)
  
  Sets the string to be inserted.
  
  Specified by:
  
  insertion in interface StyleSetter<Style.Builder>
  
  Parameters:
  
  insertion - the insertion string
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- merge
  
  @Contract("_ -> this") default Style.Builder merge(Style that)
  
  Merges from another style into this style.
  
  Parameters:
  
  that - the other style
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- merge
  
  @Contract("_, _ -> this") default Style.Builder merge(Style that, Style.Merge.Strategy strategy)
  
  Merges from another style into this style.
  
  Parameters:
  
  that - the other style
  
  strategy - the merge strategy
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- merge
  
  @Contract("_, _ -> this") default Style.Builder merge(Style that, Style.Merge... merges)
  
  Merges from another style into this style.
  
  Parameters:
  
  that - the other style
  
  merges - the parts to merge
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- merge
  
  @Contract("_, _, _ -> this") default Style.Builder merge(Style that, Style.Merge.Strategy strategy, Style.Merge... merges)
  
  Merges from another style into this style.
  
  Parameters:
  
  that - the other style
  
  strategy - the merge strategy
  
  merges - the parts to merge
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- merge
  
  @Contract("_, _ -> this") default Style.Builder merge(Style that, Set<Style.Merge> merges)
  
  Merges from another style into this style.
  
  Parameters:
  
  that - the other style
  
  merges - the parts to merge
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- merge
  
  @Contract("_, _, _ -> this") Style.Builder merge(Style that, Style.Merge.Strategy strategy, Set<Style.Merge> merges)
  
  Merges from another style into this style.
  
  Parameters:
  
  that - the other style
  
  strategy - the merge strategy
  
  merges - the parts to merge
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- apply
  
  @Contract("_ -> this") default Style.Builder apply(StyleBuilderApplicable applicable)
  
  Applies applicable to this builder.
  
  Parameters:
  
  applicable - the applicable
  
  Returns:
  
  this builder
  
  Since:
  
  4.0.0
- build
  
  Style build()
  
  Builds the style.
  
  Specified by:
  
  build in interface AbstractBuilder<Style>
  
  Returns:
  
  the style

Interface Style.Builder

Method Summary

Methods inherited from interface MutableStyleSetter

Methods inherited from interface StyleSetter

Method Details

font

color

colorIfAbsent

decorate

decorate

decoration

decorations

decoration

decorationIfAbsent

clickEvent

hoverEvent

insertion

merge

merge

merge

merge

merge

merge

apply

build