Interface ShuffleboardContainer

  • All Known Implementing Classes:
    ShuffleboardLayout, ShuffleboardTab

    public interface ShuffleboardContainer
    Common interface for objects that can contain shuffleboard components.
    • Method Detail

      • getComponents

        List<ShuffleboardComponent<?>> getComponents()
        Gets the components that are direct children of this container.
      • getLayout

        ShuffleboardLayout getLayout​(String type,
                                     String title)
        Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called.
        Parameters:
        type - the type of the layout, eg "List" or "Grid"
        title - the title of the layout
        Returns:
        the layout
      • add

        ComplexWidget add​(String title,
                          Sendable sendable)
                   throws IllegalArgumentException
        Adds a widget to this container to display the given sendable.
        Parameters:
        title - the title of the widget
        sendable - the sendable to display
        Returns:
        a widget to display the sendable data
        Throws:
        IllegalArgumentException - if a widget already exists in this container with the given title
      • add

        ComplexWidget add​(Sendable sendable)
        Adds a widget to this container to display the given sendable.
        Parameters:
        sendable - the sendable to display
        Returns:
        a widget to display the sendable data
        Throws:
        IllegalArgumentException - if a widget already exists in this container with the given title, or if the sendable's name has not been specified
      • getTitle

        String getTitle()
        Gets the title of this Shuffleboard value.
      • buildInto

        void buildInto​(NetworkTable parentTable,
                       NetworkTable metaTable)
        Builds the entries for this value.
        Parameters:
        parentTable - the table containing all the data for the parent. Values that require a complex entry or table structure should call parentTable.getSubTable(getTitle()) to get the table to put data into. Values that only use a single entry should call parentTable.getEntry(getTitle()) to get that entry.
        metaTable - the table containing all the metadata for this value and its sub-values