Package com.vaadin.copilot

Record Class ComponentInfoHandler.ComponentDragDropApiInfo

java.lang.Object
java.lang.Record
com.vaadin.copilot.ComponentInfoHandler.ComponentDragDropApiInfo
Record Components:
acceptingChildren - whether the component can accept child components.
hasAddMethod - whether the component provides an add method.
hasOnlyAddMethod - whether the component has only the add method (i.e., lacks alternatives like addComponent, setContent, etc.).
methodSelectionDialogAvailable - whether a method selection dialog should be shown for adding children.
implementingHasComponents - whether the component implements the HasComponents interface.
Enclosing class:
ComponentInfoHandler
public static record ComponentInfoHandler.ComponentDragDropApiInfo(boolean acceptingChildren, boolean hasAddMethod, boolean hasOnlyAddMethod, boolean methodSelectionDialogAvailable, boolean implementingHasComponents) extends Record
A record that encapsulates metadata about a component's drag-and-drop API support.

This data structure is used to indicate the drag-and-drop capabilities and child component management features of a specific component in a Vaadin application.

  • Constructor Details

    • ComponentDragDropApiInfo

      public ComponentDragDropApiInfo(boolean acceptingChildren, boolean hasAddMethod, boolean hasOnlyAddMethod, boolean methodSelectionDialogAvailable, boolean implementingHasComponents)
      Creates an instance of a ComponentDragDropApiInfo record class.
      Parameters:
      acceptingChildren - the value for the acceptingChildren record component
      hasAddMethod - the value for the hasAddMethod record component
      hasOnlyAddMethod - the value for the hasOnlyAddMethod record component
      methodSelectionDialogAvailable - the value for the methodSelectionDialogAvailable record component
      implementingHasComponents - the value for the implementingHasComponents record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • acceptingChildren

      public boolean acceptingChildren()
      Returns the value of the acceptingChildren record component.
      Returns:
      the value of the acceptingChildren record component

    • hasAddMethod

      public boolean hasAddMethod()
      Returns the value of the hasAddMethod record component.
      Returns:
      the value of the hasAddMethod record component

    • hasOnlyAddMethod

      public boolean hasOnlyAddMethod()
      Returns the value of the hasOnlyAddMethod record component.
      Returns:
      the value of the hasOnlyAddMethod record component

    • methodSelectionDialogAvailable

      public boolean methodSelectionDialogAvailable()
      Returns the value of the methodSelectionDialogAvailable record component.
      Returns:
      the value of the methodSelectionDialogAvailable record component

    • implementingHasComponents

      public boolean implementingHasComponents()
      Returns the value of the implementingHasComponents record component.
      Returns:
      the value of the implementingHasComponents record component