Interface ScopedComponent<C extends Component>

    • Method Detail

      • children

        @NotNull
        C children​(@NotNull
                   @NotNull List<? extends ComponentLike> children)
        Description copied from interface: Component
        Sets the list of children.

        The contents of children will be copied.

        Specified by:
        children in interface Component
        Parameters:
        children - the children
        Returns:
        a component with the children set
      • style

        @NotNull
        C style​(@NotNull
                @NotNull Style style)
        Description copied from interface: Component
        Sets the style of this component.
        Specified by:
        style in interface Component
        Parameters:
        style - the style
        Returns:
        a component
      • style

        @NotNull
        default C style​(@NotNull
                        @NotNull Consumer<Style.Builder> style)
        Description copied from interface: Component
        Sets the style of this component.
        Specified by:
        style in interface Component
        Parameters:
        style - the style consumer
        Returns:
        a component
      • style

        @NotNull
        default C style​(@NotNull Style.Builder style)
        Description copied from interface: Component
        Sets the style of this component.
        Specified by:
        style in interface Component
        Parameters:
        style - the style
        Returns:
        a component
      • mergeStyle

        @NotNull
        default C mergeStyle​(@NotNull
                             @NotNull Component that)
        Description copied from interface: Component
        Merges from another style into this component's style.
        Specified by:
        mergeStyle in interface Component
        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 interface Component
        Parameters:
        that - the other style
        merges - the style parts to merge
        Returns:
        a component
      • append

        @NotNull
        default C append​(@NotNull
                         @NotNull Component component)
        Description copied from interface: Component
        Appends a component to this component.
        Specified by:
        append in interface Component
        Parameters:
        component - the component to append
        Returns:
        a component with the component added
      • append

        @NotNull
        default C append​(@NotNull
                         @NotNull ComponentLike component)
        Description copied from interface: Component
        Appends a component to this component.
        Specified by:
        append in interface Component
        Parameters:
        component - the component to append
        Returns:
        a component with the component added
      • append

        @NotNull
        default C append​(@NotNull
                         @NotNull ComponentBuilder<?,​?> builder)
        Description copied from interface: Component
        Appends a component to this component.
        Specified by:
        append in interface Component
        Parameters:
        builder - the component to append
        Returns:
        a component with the component added
      • 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 interface Component
        Parameters:
        that - the other style
        merges - the style parts to merge
        Returns:
        a component
      • color

        @NotNull
        default C color​(@Nullable
                        @Nullable TextColor color)
        Description copied from interface: Component
        Sets the color of this component.
        Specified by:
        color in interface Component
        Parameters:
        color - the color
        Returns:
        a component
      • colorIfAbsent

        @NotNull
        default C colorIfAbsent​(@Nullable
                                @Nullable TextColor color)
        Description copied from interface: Component
        Sets the color if there isn't one set already.
        Specified by:
        colorIfAbsent in interface Component
        Parameters:
        color - the color
        Returns:
        a component
      • decoration

        @NotNull
        default C decoration​(@NotNull
                             @NotNull TextDecoration decoration,
                             boolean flag)
        Description copied from interface: Component
        Sets the state of a decoration on this component.
        Specified by:
        decoration in interface 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
      • clickEvent

        @NotNull
        default C clickEvent​(@Nullable
                             @Nullable ClickEvent event)
        Description copied from interface: Component
        Sets the click event of this component.
        Specified by:
        clickEvent in interface Component
        Parameters:
        event - the click event
        Returns:
        a component
      • hoverEvent

        @NotNull
        default C hoverEvent​(@Nullable
                             @Nullable HoverEventSource<?> event)
        Description copied from interface: Component
        Sets the hover event of this component.
        Specified by:
        hoverEvent in interface Component
        Parameters:
        event - the hover event source
        Returns:
        a component
      • insertion

        @NotNull
        default C insertion​(@Nullable
                            @Nullable String insertion)
        Description copied from interface: Component
        Sets the string to be inserted when this component is shift-clicked.
        Specified by:
        insertion in interface Component
        Parameters:
        insertion - the insertion string
        Returns:
        a component