Package net.kyori.adventure.text
Interface ScopedComponent<C extends Component>
- Type Parameters:
C
- the component type
- All Superinterfaces:
Component
,ComponentBuilderApplicable
,ComponentLike
,net.kyori.examination.Examinable
,HoverEventSource<Component>
,StyleGetter
,StyleSetter<Component>
- All Known Subinterfaces:
BlockNBTComponent
,EntityNBTComponent
,KeybindComponent
,ScoreComponent
,SelectorComponent
,StorageNBTComponent
,TextComponent
,TranslatableComponent
,VirtualComponent
Some magic to change return types.
- Since:
- 4.0.0
-
Field Summary
Fields inherited from interface net.kyori.adventure.text.Component
EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY
-
Method Summary
Modifier and TypeMethodDescriptiondefault C
Appends a component to this component.default C
append
(@NotNull ComponentBuilder<?, ?> builder) Appends a component to this component.default C
append
(@NotNull ComponentLike like) Appends a component to this component.children
(@NotNull List<? extends ComponentLike> children) Sets the list of children.default C
clickEvent
(@Nullable ClickEvent event) Sets the click event of this component.default C
Sets the color of this component.default C
colorIfAbsent
(@Nullable TextColor color) Sets the color if there isn't one set already.default C
decorate
(@NotNull TextDecoration decoration) Sets the state ofdecoration
toTextDecoration.State.TRUE
on this component.default C
decoration
(@NotNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.default C
decoration
(@NotNull TextDecoration decoration, @NotNull TextDecoration.State state) Sets the value of a decoration on this component.default C
hoverEvent
(@Nullable HoverEventSource<?> event) Sets the hover event of this component.default C
Sets the string to be inserted when this component is shift-clicked.default C
mergeStyle
(@NotNull Component that) Merges from another style into this component's style.default C
mergeStyle
(@NotNull Component that, @NotNull Set<Style.Merge> merges) Merges from another style into this component's style.default C
mergeStyle
(@NotNull Component that, @NotNull Style.Merge @NotNull ... merges) Merges from another style into this component's style.default C
shadowColor
(@Nullable ARGBLike argb) Sets the shadow color of this component.default C
shadowColorIfAbsent
(@Nullable ARGBLike argb) Sets the shadow color if there isn't one set already.default C
style
(@NotNull Consumer<Style.Builder> style) Sets the style of this component.Sets the style of this component.default C
style
(@NotNull Style.Builder style) Sets the style of this component.Methods inherited from interface net.kyori.adventure.text.Component
appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, asHoverEvent, children, clickEvent, color, compact, componentBuilderApply, contains, contains, decoration, decorationIfAbsent, decorations, decorations, detectCycle, examinableProperties, font, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, shadowColor, spliterator, spliterator, style, style
Methods inherited from interface net.kyori.examination.Examinable
examinableName, examine
Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource
asHoverEvent
Methods inherited from interface net.kyori.adventure.text.format.StyleSetter
decorate, decorations
-
Method Details
-
children
Description copied from interface:Component
Sets the list of children.The contents of
children
will be copied. -
style
Description copied from interface:Component
Sets the style of this component. -
style
Description copied from interface:Component
Sets the style of this component. -
style
Description copied from interface:Component
Sets the style of this component. -
mergeStyle
Description copied from interface:Component
Merges from another style into this component's style.- Specified by:
mergeStyle
in interfaceComponent
- Parameters:
that
- the other style- Returns:
- a component
-
mergeStyle
@NotNull default C mergeStyle(@NotNull @NotNull Component that, @NotNull Style.Merge @NotNull ... merges) Description copied from interface:Component
Merges from another style into this component's style.- Specified by:
mergeStyle
in interfaceComponent
- Parameters:
that
- the other stylemerges
- the style parts to merge- Returns:
- a component
-
append
Description copied from interface:Component
Appends a component to this component. -
append
Description copied from interface:Component
Appends a component to this component. -
append
Description copied from interface:Component
Appends a component to this component. -
mergeStyle
@NotNull default C mergeStyle(@NotNull @NotNull Component that, @NotNull @NotNull Set<Style.Merge> merges) Description copied from interface:Component
Merges from another style into this component's style.- Specified by:
mergeStyle
in interfaceComponent
- Parameters:
that
- the other stylemerges
- the style parts to merge- Returns:
- a component
-
color
Description copied from interface:Component
Sets the color of this component. -
colorIfAbsent
Description copied from interface:Component
Sets the color if there isn't one set already.- Specified by:
colorIfAbsent
in interfaceComponent
- Specified by:
colorIfAbsent
in interfaceStyleSetter<C extends Component>
- Parameters:
color
- the color- Returns:
- a component
-
shadowColor
Description copied from interface:Component
Sets the shadow color of this component.- Specified by:
shadowColor
in interfaceComponent
- Specified by:
shadowColor
in interfaceStyleSetter<C extends Component>
- Parameters:
argb
- the color- Returns:
- a component
-
shadowColorIfAbsent
Description copied from interface:Component
Sets the shadow color if there isn't one set already.- Specified by:
shadowColorIfAbsent
in interfaceComponent
- Specified by:
shadowColorIfAbsent
in interfaceStyleSetter<C extends Component>
- Parameters:
argb
- the color- Returns:
- a component
-
decorate
Description copied from interface:Component
Sets the state ofdecoration
toTextDecoration.State.TRUE
on this component. -
decoration
Description copied from interface:Component
Sets the state of a decoration on this component.- Specified by:
decoration
in interfaceComponent
- Specified by:
decoration
in interfaceStyleSetter<C extends Component>
- Parameters:
decoration
- the decorationflag
-true
if this component should have the decoration,false
if this component should not have the decoration- Returns:
- a component
-
decoration
@NotNull default C decoration(@NotNull @NotNull TextDecoration decoration, @NotNull TextDecoration.State state) Description copied from interface:Component
Sets the value of a decoration on this component.- Specified by:
decoration
in interfaceComponent
- Specified by:
decoration
in interfaceStyleSetter<C extends Component>
- Parameters:
decoration
- the decorationstate
-TextDecoration.State.TRUE
if this component should have the decoration,TextDecoration.State.FALSE
if this component should not have the decoration, andTextDecoration.State.NOT_SET
if the decoration should not have a set value- Returns:
- a component
-
clickEvent
Description copied from interface:Component
Sets the click event of this component.- Specified by:
clickEvent
in interfaceComponent
- Specified by:
clickEvent
in interfaceStyleSetter<C extends Component>
- Parameters:
event
- the click event- Returns:
- a component
-
hoverEvent
Description copied from interface:Component
Sets the hover event of this component.- Specified by:
hoverEvent
in interfaceComponent
- Specified by:
hoverEvent
in interfaceStyleSetter<C extends Component>
- Parameters:
event
- the hover event source- Returns:
- a component
-
insertion
Description copied from interface:Component
Sets the string to be inserted when this component is shift-clicked.
-