Enum BuiltInLayouts

    • Enum Constant Detail

      • kList

        public static final BuiltInLayouts kList
        Groups components in a vertical list. New widgets added to the layout will be placed at the bottom of the list.
        Custom properties:
        NameTypeDefault ValueNotes
        Label positionString"BOTTOM" The position of component labels inside the grid. One of ["TOP", "LEFT", "BOTTOM", "RIGHT", "HIDDEN"
      • kGrid

        public static final BuiltInLayouts kGrid
        Groups components in an n x m grid. Grid layouts default to 3x3.
        Custom properties:
        NameTypeDefault ValueNotes
        Number of columnsNumber3Must be in the range [1,15]
        Number of rowsNumber3Must be in the range [1,15]
        Label position String "BOTTOM" The position of component labels inside the grid. One of ["TOP", "LEFT", "BOTTOM", "RIGHT", "HIDDEN"
    • Method Detail

      • values

        public static BuiltInLayouts[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (BuiltInLayouts c : BuiltInLayouts.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static BuiltInLayouts valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getLayoutName

        public String getLayoutName()
        Description copied from interface: LayoutType
        Gets the string type of the layout as defined by that layout in Shuffleboard.
        Specified by:
        getLayoutName in interface LayoutType