Package edu.wpi.first.wpilibj.shuffleboard

Class ShuffleboardLayout

java.lang.Object

edu.wpi.first.wpilibj.shuffleboard.ShuffleboardComponent<ShuffleboardLayout>

edu.wpi.first.wpilibj.shuffleboard.ShuffleboardLayout

All Implemented Interfaces:

ShuffleboardContainer

public class ShuffleboardLayout
extends ShuffleboardComponent<ShuffleboardLayout>
implements ShuffleboardContainer

A layout in a Shuffleboard tab. Layouts can contain widgets and other layouts.

Method Summary

Modifier and Type	Method	Description
ComplexWidget	add(Sendable sendable)	Adds a widget to this container to display the given sendable.
ComplexWidget	add(String title, Sendable sendable)	Adds a widget to this container to display the given sendable.
SimpleWidget	add(String title, Object defaultValue)	Adds a widget to this container to display the given data.
SuppliedValueWidget<Boolean>	addBoolean(String title, BooleanSupplier valueSupplier)	Adds a widget to this container.
SuppliedValueWidget<boolean[]>	addBooleanArray(String title, Supplier<boolean[]> valueSupplier)	Adds a widget to this container.
SuppliedValueWidget<double[]>	addDoubleArray(String title, Supplier<double[]> valueSupplier)	Adds a widget to this container.
SuppliedValueWidget<Double>	addNumber(String title, DoubleSupplier valueSupplier)	Adds a widget to this container.
SuppliedValueWidget<byte[]>	addRaw(String title, Supplier<byte[]> valueSupplier)	Adds a widget to this container.
SuppliedValueWidget<String>	addString(String title, Supplier<String> valueSupplier)	Adds a widget to this container.
SuppliedValueWidget<String[]>	addStringArray(String title, Supplier<String[]> valueSupplier)	Adds a widget to this container.
void	buildInto(NetworkTable parentTable, NetworkTable metaTable)
List<ShuffleboardComponent<?>>	getComponents()	Gets the components that are direct children of this container.
ShuffleboardLayout	getLayout(String title)	Gets the already-defined layout in this container with the given title.
ShuffleboardLayout	getLayout(String title, String type)	Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called.
String	getTitle()	Gets the title of this Shuffleboard value.

Methods inherited from class edu.wpi.first.wpilibj.shuffleboard.ShuffleboardComponent

buildMetadata, getParent, getTitle, getType, setType, withPosition, withProperties, withSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.wpi.first.wpilibj.shuffleboard.ShuffleboardContainer

add, add, addCamera, addPersistent, getLayout

Method Details

getComponents

public List<ShuffleboardComponent<?>> getComponents()

Description copied from interface: ShuffleboardContainer

Gets the components that are direct children of this container.

Specified by:

getComponents in interface ShuffleboardContainer

Returns:

The components that are direct children of this container.

getLayout

public ShuffleboardLayout getLayout(String title, String type)

Description copied from interface: ShuffleboardContainer

Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called. Note: this method should only be used to use a layout type that is not already built into Shuffleboard. To use a layout built into Shuffleboard, use ShuffleboardContainer.getLayout(String, LayoutType) and the layouts in BuiltInLayouts.

Specified by:

getLayout in interface ShuffleboardContainer

Parameters:

title - the title of the layout

type - the type of the layout, eg "List Layout" or "Grid Layout"

Returns:

the layout

See Also:

ShuffleboardContainer.getLayout(String, LayoutType)

getLayout

public ShuffleboardLayout getLayout(String title)

Description copied from interface: ShuffleboardContainer

Gets the already-defined layout in this container with the given title.

 Shuffleboard.getTab("Example Tab")
   .getLayout("My Layout", BuiltInLayouts.kList);

 // Later...
 Shuffleboard.getTab("Example Tab")
   .getLayout("My Layout");
 

Specified by:

getLayout in interface ShuffleboardContainer

Parameters:

title - the title of the layout to get

Returns:

the layout with the given title

add

public ComplexWidget add(String title, Sendable sendable)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container to display the given sendable.

Specified by:

add in interface ShuffleboardContainer

Parameters:

title - the title of the widget

sendable - the sendable to display

Returns:

a widget to display the sendable data

add

public ComplexWidget add(Sendable sendable)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container to display the given sendable.

Specified by:

add in interface ShuffleboardContainer

Parameters:

sendable - the sendable to display

Returns:

a widget to display the sendable data

add

public SimpleWidget add(String title, Object defaultValue)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container to display the given data.

Specified by:

add in interface ShuffleboardContainer

Parameters:

title - the title of the widget

defaultValue - the default value of the widget

Returns:

a widget to display the sendable data

See Also:

add(String title, Object defaultValue)

addString

public SuppliedValueWidget<String> addString(String title, Supplier<String> valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addString in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

addNumber

public SuppliedValueWidget<Double> addNumber(String title, DoubleSupplier valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addNumber in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

addBoolean

public SuppliedValueWidget<Boolean> addBoolean(String title, BooleanSupplier valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addBoolean in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

addStringArray

public SuppliedValueWidget<String[]> addStringArray(String title, Supplier<String[]> valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addStringArray in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

addDoubleArray

public SuppliedValueWidget<double[]> addDoubleArray(String title, Supplier<double[]> valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addDoubleArray in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

addBooleanArray

public SuppliedValueWidget<boolean[]> addBooleanArray(String title, Supplier<boolean[]> valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addBooleanArray in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

addRaw

public SuppliedValueWidget<byte[]> addRaw(String title, Supplier<byte[]> valueSupplier)

Description copied from interface: ShuffleboardContainer

Adds a widget to this container. The widget will display the data provided by the value supplier. Changes made on the dashboard will not propagate to the widget object, and will be overridden by values from the value supplier.

Specified by:

addRaw in interface ShuffleboardContainer

Parameters:

title - the title of the widget

valueSupplier - the supplier for values

Returns:

a widget to display data

buildInto

public void buildInto(NetworkTable parentTable, NetworkTable metaTable)

getTitle

public abstract String getTitle()

Gets the title of this Shuffleboard value.

Returns:

The title of this Shuffleboard value.