Component (text-api 3.0.1 API)

All Known Subinterfaces:

BlockNbtComponent, BuildableComponent<C,B>, EntityNbtComponent, KeybindComponent, NbtComponent<C,B>, ScopedComponent<C>, ScoreComponent, SelectorComponent, TextComponent, TranslatableComponent

All Known Implementing Classes:

AbstractComponent
```
public interface Component
```
A text component.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`@NonNull Component`	`append(@NonNull Component component)` Appends a component to this component.
`default @NonNull Component`	`append(@NonNull ComponentBuilder<?,?> builder)` Appends a component to this component.
`@NonNull java.util.List<Component>`	`children()` Gets the unmodifiable list of children.
`@NonNull Component`	`children(@NonNull java.util.List<Component> children)` Sets the list of children.
`default @Nullable ClickEvent`	`clickEvent()` Gets the click event of this component.
`default @NonNull Component`	`clickEvent(@Nullable ClickEvent event)` Sets the click event of this component.
`default @Nullable TextColor`	`color()` Gets the color of this component.
`default @NonNull Component`	`color(@Nullable TextColor color)` Sets the color of this component.
`default boolean`	`contains(@NonNull Component that)` Checks if this component contains a component.
`default TextDecoration.State`	`decoration(@NonNull TextDecoration decoration)` Gets the state of a decoration on this component.
`default @NonNull Component`	`decoration(@NonNull TextDecoration decoration, boolean flag)` Sets the state of a decoration on this component.
`default @NonNull Component`	`decoration(@NonNull TextDecoration decoration, TextDecoration.State state)` Sets the value of a decoration on this component.
`default @NonNull java.util.Set<TextDecoration>`	`decorations()` Gets a set of decorations this component has.
`default @NonNull java.util.Set<TextDecoration>`	`decorations(@NonNull java.util.Set<TextDecoration> defaultValues)` Gets a set of decorations this component has.
`default void`	`detectCycle(@NonNull Component that)` Prevents a cycle between this component and the provided component.
`default boolean`	`hasDecoration(@NonNull TextDecoration decoration)` Tests if this component has a decoration.
`default boolean`	`hasStyling()` Tests if this component has any styling.
`default @Nullable HoverEvent`	`hoverEvent()` Gets the hover event of this component.
`default @NonNull Component`	`hoverEvent(@Nullable HoverEvent event)` Sets the hover event of this component.
`default @Nullable java.lang.String`	`insertion()` Gets the string to be inserted when this component is shift-clicked.
`default @NonNull Component`	`insertion(@Nullable java.lang.String insertion)` Sets the string to be inserted when this component is shift-clicked.
`default @NonNull Component`	`mergeColor(@NonNull Component that)` Merges the color from another component into this component.
`default @NonNull Component`	`mergeDecorations(@NonNull Component that)` Merges the decorations from another component into this component.
`default @NonNull Component`	`mergeEvents(@NonNull Component that)` Merges the events from another component into this component.
`@NonNull Style`	`style()` Gets the style of this component.
`@NonNull Component`	`style(@NonNull Style style)` Sets the style of this component.

- Method Detail
  - children
```
@NonNull java.util.List<Component> children()
```
    Gets the unmodifiable list of children.
    
    Returns:
    
    the unmodifiable list of children
  - children
```
@NonNull Component children(@NonNull java.util.List<Component> children)
```
    Sets the list of children.
    The contents of children will be copied.
    
    Parameters:
    
    children - the children
    
    Returns:
    
    the unmodifiable list of children
  - contains
```
default boolean contains(@NonNull Component that)
```
    Checks if this component contains a component.
    
    Parameters:
    
    that - the other component
    
    Returns:
    
    true if this component contains the provided component, false otherwise
  - detectCycle
```
default void detectCycle(@NonNull Component that)
```
    Prevents a cycle between this component and the provided component.
    
    Parameters:
    
    that - the other component
  - append
```
@NonNull Component append(@NonNull Component component)
```
    Appends a component to this component.
    
    Parameters:
    
    component - the component to append
    
    Returns:
    
    a component with the component added
  - append
```
default @NonNull Component append(@NonNull ComponentBuilder<?,?> builder)
```
    Appends a component to this component.
    
    Parameters:
    
    builder - the component to append
    
    Returns:
    
    a component with the component added
  - style
```
@NonNull Style style()
```
    Gets the style of this component.
    
    Returns:
    
    the style of this component
  - style
```
@NonNull Component style(@NonNull Style style)
```
    Sets the style of this component.
    
    Parameters:
    
    style - the style
    
    Returns:
    
    a component
  - color
```
default @Nullable TextColor color()
```
    Gets the color of this component.
    
    Returns:
    
    the color of this component
  - color
```
default @NonNull Component color(@Nullable TextColor color)
```
    Sets the color of this component.
    
    Parameters:
    
    color - the color
    
    Returns:
    
    a component
  - hasDecoration
```
default boolean hasDecoration(@NonNull TextDecoration decoration)
```
    Tests if this component has a decoration.
    
    Parameters:
    
    decoration - the decoration
    
    Returns:
    
    true if this component has the decoration, false if this component does not have the decoration
  - decoration
```
default TextDecoration.State decoration(@NonNull TextDecoration decoration)
```
    Gets the state of a decoration on this 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
  - decoration
```
default @NonNull Component decoration(@NonNull TextDecoration decoration,
                                      boolean flag)
```
    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
```
default @NonNull Component decoration(@NonNull TextDecoration decoration,
                                      TextDecoration.State state)
```
    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
  - decorations
```
default @NonNull java.util.Set<TextDecoration> decorations()
```
    Gets a set of decorations this component has.
    
    Returns:
    
    a set of decorations this component has
  - decorations
```
default @NonNull java.util.Set<TextDecoration> decorations(@NonNull java.util.Set<TextDecoration> defaultValues)
```
    Gets a set of decorations this component has.
    
    Parameters:
    
    defaultValues - a set of default values
    
    Returns:
    
    a set of decorations this component has
  - clickEvent
```
default @Nullable ClickEvent clickEvent()
```
    Gets the click event of this component.
    
    Returns:
    
    the click event
  - clickEvent
```
default @NonNull Component clickEvent(@Nullable ClickEvent event)
```
    Sets the click event of this component.
    
    Parameters:
    
    event - the click event
    
    Returns:
    
    a component
  - hoverEvent
```
default @Nullable HoverEvent hoverEvent()
```
    Gets the hover event of this component.
    
    Returns:
    
    the hover event
  - hoverEvent
```
default @NonNull Component hoverEvent(@Nullable HoverEvent event)
```
    Sets the hover event of this component.
    
    Parameters:
    
    event - the hover event
    
    Returns:
    
    a component
  - insertion
```
default @Nullable java.lang.String insertion()
```
    Gets the string to be inserted when this component is shift-clicked.
    
    Returns:
    
    the insertion string
  - insertion
```
default @NonNull Component insertion(@Nullable java.lang.String insertion)
```
    Sets the string to be inserted when this component is shift-clicked.
    
    Parameters:
    
    insertion - the insertion string
    
    Returns:
    
    a component
  - mergeColor
```
default @NonNull Component mergeColor(@NonNull Component that)
```
    Merges the color from another component into this component.
    
    Parameters:
    
    that - the other component
    
    Returns:
    
    a component
  - mergeDecorations
```
default @NonNull Component mergeDecorations(@NonNull Component that)
```
    Merges the decorations from another component into this component.
    
    Parameters:
    
    that - the other component
    
    Returns:
    
    a component
  - mergeEvents
```
default @NonNull Component mergeEvents(@NonNull Component that)
```
    Merges the events from another component into this component.
    
    Parameters:
    
    that - the other component
    
    Returns:
    
    a component
  - hasStyling
```
default boolean hasStyling()
```
    Tests if this component has any styling.
    
    Returns:
    
    true if this component has any styling, false if this component does not have any styling

Interface Component

Method Summary

Method Detail

children

children

contains

detectCycle

append

append

style

style

color

color

hasDecoration

decoration

decoration

decoration

decorations

decorations

clickEvent

clickEvent

hoverEvent

hoverEvent

insertion

insertion

mergeColor

mergeDecorations

mergeEvents

hasStyling