Interface LayoutComponent
-
- All Superinterfaces:
Component
,Iterable<ItemComponent>
,SerializableData
- All Known Implementing Classes:
ActionRow
public interface LayoutComponent extends SerializableData, Iterable<ItemComponent>, Component
Represents a top-level layout used forItemComponents
such asButtons
.Components must always be contained within such a layout.
- See Also:
ActionRow
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.dv8tion.jda.api.interactions.components.Component
Component.Type
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description LayoutComponent
asDisabled()
Returns a new instance of this LayoutComponent with all components set to disabled.LayoutComponent
asEnabled()
Returns a new instance of this LayoutComponent with all components set to enabled.default List<ActionComponent>
getActionComponents()
Immutable filtered copy ofgetComponents()
elements which areActionComponents
.default List<Button>
getButtons()
List of buttons in this component layout.List<ItemComponent>
getComponents()
List representation of this component layout.default boolean
isDisabled()
Whether all components in this layout aredisabled
.default boolean
isEmpty()
Check whether this layout is empty.default boolean
isEnabled()
Whether all components in this layout areenabled
.default boolean
isValid()
Check whether this is a valid layout configuration.default ItemComponent
updateComponent(String id, ItemComponent newComponent)
Find and replace a component in this layout.static boolean
updateComponent(List<? extends LayoutComponent> layouts, String id, ItemComponent newComponent)
Find and replace a component in this list of layouts.static boolean
updateComponent(List<? extends LayoutComponent> layouts, ItemComponent component, ItemComponent newComponent)
Find and replace a component in this list of layouts.default ItemComponent
updateComponent(ItemComponent component, ItemComponent newComponent)
Find and replace a component in this layout.LayoutComponent
withDisabled(boolean disabled)
Returns a new instance of this LayoutComponent with all components set to disabled/enabled.-
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
Methods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData
toData
-
-
-
-
Method Detail
-
getComponents
@Nonnull List<ItemComponent> getComponents()
List representation of this component layout.
This list is modifiable. Note that empty layouts are not supported.- Returns:
List
of components in this layout
-
getActionComponents
@Nonnull default List<ActionComponent> getActionComponents()
Immutable filtered copy ofgetComponents()
elements which areActionComponents
.- Returns:
- Immutable
List
copy ofActionComponents
in this layout
-
isDisabled
default boolean isDisabled()
Whether all components in this layout aredisabled
.
Note that this is a universal quantifier, which means false does not implyisEnabled()
!- Returns:
- True, if all components are disabled
-
isEnabled
default boolean isEnabled()
Whether all components in this layout areenabled
.
Note that this is a universal quantifier, which means false does not implyisDisabled()
!- Returns:
- True, if all components are enabled
-
withDisabled
@Nonnull @CheckReturnValue LayoutComponent withDisabled(boolean disabled)
Returns a new instance of this LayoutComponent with all components set to disabled/enabled.
This does not modify the layout this was called on. To do this in-place, you can usegetComponents()
.- Parameters:
disabled
- True if the components should be set to disabled, false if they should be enabled- Returns:
- The new layout component with all components updated
- See Also:
ActionComponent.withDisabled(boolean)
-
asDisabled
@Nonnull @CheckReturnValue LayoutComponent asDisabled()
Returns a new instance of this LayoutComponent with all components set to disabled.
This does not modify the layout this was called on. To do this in-place, you can usegetComponents()
.- Returns:
- The new layout component with all components updated
- See Also:
ActionComponent.asDisabled()
-
asEnabled
@Nonnull @CheckReturnValue LayoutComponent asEnabled()
Returns a new instance of this LayoutComponent with all components set to enabled.
This does not modify the layout this was called on. To do this in-place, you can usegetComponents()
.- Returns:
- The new layout component with all components updated
- See Also:
ActionComponent.asEnabled()
-
isEmpty
default boolean isEmpty()
Check whether this layout is empty.
Identical togetComponents().isEmpty()
- Returns:
- True, if this layout has no components
-
isValid
default boolean isValid()
Check whether this is a valid layout configuration.
This checks that there is at least one component in this layout and it does not violateItemComponent.getMaxPerRow()
.- Returns:
- True, if this layout is valid
-
updateComponent
@Nullable default ItemComponent updateComponent(@Nonnull String id, @Nullable ItemComponent newComponent)
Find and replace a component in this layout.
This will locate and replace the existing component with the specified ID. If you provide null it will be removed instead.- Parameters:
id
- The custom id of this component, can also be a URL for aButton
withButtonStyle.LINK
newComponent
- The new component or null to remove it- Returns:
- The old
ItemComponent
that was replaced or removed - Throws:
IllegalArgumentException
- If the provided id is null
-
updateComponent
static boolean updateComponent(@Nonnull List<? extends LayoutComponent> layouts, @Nonnull String id, @Nullable ItemComponent newComponent)
Find and replace a component in this list of layouts.
This will locate and replace the existing component with the specified ID. If you provide null it will be removed instead.If one of the layouts is empty after removing the component, it will be removed from the list. This is an inplace operation and modifies the provided list directly.
- Parameters:
layouts
- The layouts to modifyid
- The custom id of this component, can also be a URL for aButton
withButtonStyle.LINK
newComponent
- The new component or null to remove it- Returns:
- True, if any of the layouts was modified
- Throws:
UnsupportedOperationException
- If the list cannot be modifiedIllegalArgumentException
- If the provided id or list is null or the replace operation results in aninvalid
layout
-
updateComponent
@Nullable default ItemComponent updateComponent(@Nonnull ItemComponent component, @Nullable ItemComponent newComponent)
Find and replace a component in this layout.
This will locate and replace the existing component by checking forequality
. If you provide null it will be removed instead.Example
public void disableButton(ActionRow row, Button button) { row.updateComponent(button, button.asDisabled()); }
- Parameters:
component
- The component that should be replacednewComponent
- The new component or null to remove it- Returns:
- The old
ItemComponent
that was replaced or removed - Throws:
IllegalArgumentException
- If the provided component is null
-
updateComponent
static boolean updateComponent(@Nonnull List<? extends LayoutComponent> layouts, @Nonnull ItemComponent component, @Nullable ItemComponent newComponent)
Find and replace a component in this list of layouts.
This will locate and replace the existing component by checking forequality
. If you provide null it will be removed instead.If one of the layouts is empty after removing the component, it will be removed from the list. This is an inplace operation and modifies the provided list directly.
- Parameters:
layouts
- The layouts to modifycomponent
- The component that should be replacednewComponent
- The new component or null to remove it- Returns:
- True, if any of the layouts was modified
- Throws:
UnsupportedOperationException
- If the list cannot be modifiedIllegalArgumentException
- If the provided component or list is null or the replace operation results in aninvalid
layout
-
-