Class SimpleWidget
- java.lang.Object
-
- edu.wpi.first.wpilibj.shuffleboard.ShuffleboardComponent<W>
-
- edu.wpi.first.wpilibj.shuffleboard.SimpleWidget
-
public final class SimpleWidget extends ShuffleboardComponent<W>
A Shuffleboard widget that handles a single data point such as a number or string.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
buildInto(NetworkTable parentTable, NetworkTable metaTable)
NetworkTableEntry
getEntry()
Gets the NetworkTable entry that contains the data for this widget.W
withWidget(WidgetType widgetType)
Sets the type of widget used to display the data.W
withWidget(String widgetType)
Sets the type of widget used to display the data.-
Methods inherited from class edu.wpi.first.wpilibj.shuffleboard.ShuffleboardComponent
buildMetadata, getParent, getTitle, getType, setType, withPosition, withProperties, withSize
-
-
-
-
Method Detail
-
getEntry
public NetworkTableEntry getEntry()
Gets the NetworkTable entry that contains the data for this widget.- Returns:
- The NetworkTable entry that contains the data for this widget.
-
buildInto
public void buildInto(NetworkTable parentTable, NetworkTable metaTable)
-
withWidget
public final W withWidget(WidgetType widgetType)
Sets the type of widget used to display the data. If not set, the default widget type will be used.- Parameters:
widgetType
- the type of the widget used to display the data- Returns:
- this widget object
- See Also:
BuiltInWidgets
-
withWidget
public final W withWidget(String widgetType)
Sets the type of widget used to display the data. If not set, the default widget type will be used. This method should only be used to use a widget that does not come built into Shuffleboard (i.e. one that comes with a custom or third-party plugin). To use a widget that is built into Shuffleboard, usewithWidget(WidgetType)
andBuiltInWidgets
.- Parameters:
widgetType
- the type of the widget used to display the data- Returns:
- this widget object
-
-