Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X Y 

A

AbstractDataSource<T> - Class in edu.wpi.first.shuffleboard.api.sources
Abstract implementation of DataSource that defines properties for AbstractDataSource.nameProperty(), AbstractDataSource.activeProperty(), and AbstractDataSource.dataProperty() for subclasses.
AbstractDataSource(DataType<T>) - Constructor for class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
AbstractNumberField<N extends java.lang.Number> - Class in edu.wpi.first.shuffleboard.api.components
A type of text field that only accepts valid numbers.
AbstractNumberField() - Constructor for class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
 
AbstractNumberField(N) - Constructor for class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
 
AbstractWidget - Class in edu.wpi.first.shuffleboard.api.widget
A partial implementation of Widget that implements property methods.
AbstractWidget() - Constructor for class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
 
AbstractWidgetType<W extends Widget> - Class in edu.wpi.first.shuffleboard.api.widget
Describes a widget.
AbstractWidgetType(String, Set<DataType>) - Constructor for class edu.wpi.first.shuffleboard.api.widget.AbstractWidgetType
 
AbstractWidgetType(Description) - Constructor for class edu.wpi.first.shuffleboard.api.widget.AbstractWidgetType
 
ActionList - Class in edu.wpi.first.shuffleboard.api.components
A class meant to represent abstract "actions" that can be taken by a user for a given context.
ActionList(String) - Constructor for class edu.wpi.first.shuffleboard.api.components.ActionList
 
actionsForNode(Node) - Static method in class edu.wpi.first.shuffleboard.api.components.ActionList
Retrieves the ActionList supplier that has been added to a node, if one exists.
active - Variable in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
activeProperty() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
activeProperty() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Checks if this data source is active, i.e.
add(TypeAdapter<?>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
Adds the given type adapter.
addAction(String, Runnable) - Method in class edu.wpi.first.shuffleboard.api.components.ActionList
 
addAction(String, Node, Runnable) - Method in class edu.wpi.first.shuffleboard.api.components.ActionList
Add an action with an associated graphic, such as a checkmark or icon.
addChangeListener(ChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
addChild(Component) - Method in interface edu.wpi.first.shuffleboard.api.widget.Layout
 
addClient(Sourced) - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
addClient(Sourced) - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Adds a client to this source.
addComponent(Component) - Method in interface edu.wpi.first.shuffleboard.api.widget.ComponentContainer
Adds a component to this container.
addComponent(Component) - Method in interface edu.wpi.first.shuffleboard.api.widget.Layout
 
addComponentFor(DataSource<?>) - Method in interface edu.wpi.first.shuffleboard.api.Populatable
Adds a component for a data source.
addComponentIfPossible(DataSource<?>) - Method in interface edu.wpi.first.shuffleboard.api.Populatable
If possible, adds a component for a data source.
addComponentIfPossible(SourceTypes, String) - Method in interface edu.wpi.first.shuffleboard.api.Populatable
If possible, adds a component for a data source.
addImmediateListener(ImmediateChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
addImmediateListener(ImmediateChangeListener<? super Boolean>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
addImmediateListener(ImmediateChangeListener<? super Number>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
addImmediateListener(ImmediateChangeListener<? super T>) - Method in interface edu.wpi.first.shuffleboard.api.properties.AtomicProperty
Adds a listener to be called immediately after the value changes, even when it changes from a thread other than the JavaFX application thread.
addImmediateListener(ImmediateChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
addInvalidationListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
addItem(T) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Adds an item to the list of registered items.
addListener(ChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
addListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
addListener(ChangeListener<? super Boolean>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
addListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
addListener(ChangeListener<? super Number>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
addListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
addNested(ActionList) - Method in class edu.wpi.first.shuffleboard.api.components.ActionList
Adds another action list to this one, placing each of its actions in a separate sub-menu.
addSource(DataSource) - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
 
addSource(DataSource) - Method in class edu.wpi.first.shuffleboard.api.widget.SingleSourceWidget
 
addSource(DataSource) - Method in interface edu.wpi.first.shuffleboard.api.widget.Sourced
Adds a source.
All - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
Represents the type of all data; a widget that can accept this data type can accept data of any type.
all() - Method in class edu.wpi.first.shuffleboard.api.util.ListUtils.Replacement
Makes all instances of the target value be replaced.
allAvailableSourceUris() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Gets a read-only observable list of all available source URIs of all the known types.
allComponents() - Method in interface edu.wpi.first.shuffleboard.api.widget.Component
All of the components contained by or represented by this one, if any.
allComponents() - Method in interface edu.wpi.first.shuffleboard.api.widget.ComponentContainer
Gets a stream of all the components in this container.
allComponents() - Method in class edu.wpi.first.shuffleboard.api.widget.Components
 
allComponents() - Method in interface edu.wpi.first.shuffleboard.api.widget.Layout
 
allComponents() - Method in interface edu.wpi.first.shuffleboard.api.widget.Widget
 
AllType - Class in edu.wpi.first.shuffleboard.api.data.types
A catchall data type that represents all data.
allWidgets() - Method in class edu.wpi.first.shuffleboard.api.widget.Components
 
alphabetical - Static variable in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Compares tree items alphabetically.
AlphanumComparator - Class in edu.wpi.first.shuffleboard.api.util
A string comparator that uses the alphanum algorithm to compare strings that contain numbers.
AlphanumComparator() - Constructor for class edu.wpi.first.shuffleboard.api.util.AlphanumComparator
 
AnnotatedWidget - Interface in edu.wpi.first.shuffleboard.api.widget
A type of widget that has its name and data types set with a Description annotation on the class.
APP_PREFIX - Static variable in class edu.wpi.first.shuffleboard.api.dnd.DataFormats
The prefix for all data formats specific to the app.
append(TimestampedData) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
Appends the given data to the end of the data list.
apply(I) - Method in interface edu.wpi.first.shuffleboard.api.util.ThrowingFunction
 
asMap() - Method in class edu.wpi.first.shuffleboard.api.data.ComplexData
Creates a map containing all the individual data points composing this complex data object.
asMap() - Method in class edu.wpi.first.shuffleboard.api.data.MapData
 
asMap() - Method in class edu.wpi.first.shuffleboard.api.data.NamedData
 
assertRunningFromTest() - Static method in class edu.wpi.first.shuffleboard.api.util.TestUtils
Asserts that this method's call stack originated from a test method invocation.
AsyncProperty<T> - Class in edu.wpi.first.shuffleboard.api.properties
A thread-safe implementation of a property.
AsyncProperty() - Constructor for class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
AsyncProperty(T) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
AsyncProperty(Object, String) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
AsyncProperty(Object, String, T) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
AsyncUtils - Class in edu.wpi.first.shuffleboard.api.util
A quick and dirty solution to running certain things asynchronously.
AtomicBooleanProperty - Class in edu.wpi.first.shuffleboard.api.properties
An implementation of BooleanProperty that makes all reads and writes atomic.
AtomicBooleanProperty(boolean) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
AtomicBooleanProperty(String, boolean) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
AtomicBooleanProperty(Object, String, boolean) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
AtomicIntegerProperty - Class in edu.wpi.first.shuffleboard.api.properties
An implementation of IntegerProperty that makes all reads and writes atomic.
AtomicIntegerProperty() - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
AtomicIntegerProperty(int) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
AtomicIntegerProperty(String, int) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
AtomicIntegerProperty(Object, String, int) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
AtomicProperty<T> - Interface in edu.wpi.first.shuffleboard.api.properties
A type of property that makes all reads and writes atomic.
AtomicPropertyListenerDelegate<T> - Class in edu.wpi.first.shuffleboard.api.properties
A helper class that implements many of the listener and binding related methods for atomic properties.
AtomicPropertyListenerDelegate(AtomicProperty<T>) - Constructor for class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
autoPopulate() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo.TabInfoBuilder
Sets the built tab to autopopulate.
AutoSizedTextField - Class in edu.wpi.first.shuffleboard.api.components
A TextField that resizes itself to fit its content.
AutoSizedTextField() - Constructor for class edu.wpi.first.shuffleboard.api.components.AutoSizedTextField
Default constructor.

B

bind(ObservableValue<? extends T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
bind(ObservableValue<? extends Boolean>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
bind(ObservableValue<? extends Number>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
bind(ObservableValue<? extends T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
Binds the atomic property to an observable value.
bind(Property<T>, ObservableMap<K, V>, K, Function<V, T>) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Binds a property to the value of an entry in a map.
bind(Property<T>, DataSource<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Binds a property to the data of a data source.
bind(ObservableList<? super T>, ObservableValue<? extends List<? extends T>>) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Binds an observable list to a list property.
bindBidirectional(Property<T>, DataSource<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Bidirectionally binds a property and a data source.
bindBidirectionalWithConverter(Property<T>, Property<U>, Function<? super T, ? extends U>, Function<? super U, ? extends T>) - Static method in class edu.wpi.first.shuffleboard.api.util.PropertyUtils
Binds two properties bidirectionally.
bindToMapBidirectionally(Property<T>, ObservableMap<K, V>, K, Function<V, T>) - Static method in class edu.wpi.first.shuffleboard.api.util.PropertyUtils
Binds a property to a specific key in a map.
bindWithConverter(Property<T>, Property<U>, Function<U, T>) - Static method in class edu.wpi.first.shuffleboard.api.util.PropertyUtils
Binds firstProperty to secondProperty, using a conversion function to map values of type U to T so the first property can be bound.
Boolean - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to boolean data.
BooleanArray - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to a boolean array (boolean[]).
BooleanArrayAdapter - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
 
BooleanArrayAdapter() - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.BooleanArrayAdapter
 
BooleanArrayType - Class in edu.wpi.first.shuffleboard.api.data.types
 
BooleanType - Class in edu.wpi.first.shuffleboard.api.data.types
 
branchesFirst - Static variable in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Compares tree items, branches first.
build() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo.TabInfoBuilder
Creates a new TabInfo object from this builder.
build() - Method in class edu.wpi.first.shuffleboard.api.util.Maps.MapBuilder
Returns the built map.
builder() - Static method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
 
builder() - Static method in class edu.wpi.first.shuffleboard.api.util.Maps
Creates a new map builder.
ByteArray - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to an array of raw bytes (byte[]).
ByteArrayAdapter - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
 
ByteArrayAdapter() - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.ByteArrayAdapter
 

C

cancel() - Method in class edu.wpi.first.shuffleboard.api.util.Debouncer
Cancels the debouncer.
castStream(Class<U>) - Static method in class edu.wpi.first.shuffleboard.api.util.TypeUtils
Filter out members of a subtype from a stream of some base type.
centerProperty() - Method in class edu.wpi.first.shuffleboard.api.components.LinearIndicator
 
changesFrom(T) - Method in class edu.wpi.first.shuffleboard.api.data.ComplexData
Gets a map of changes that, when applied to other, would result in data identical to this one.
cleanUp() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.TypeAdapter
Resets the state of this type adapter (if it has state) before a new recording starts.
cleanUpAll() - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
 
close() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Closes this data source and frees any used resources.
col - Variable in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
combineLists(ObservableList<T>, ObservableList<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.PropertyUtils
Combines multiple observable lists into a single one.
compare(String, String) - Method in class edu.wpi.first.shuffleboard.api.util.AlphanumComparator
 
compareTo(TimestampedData) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
ComplexAnnotatedWidget<D extends ComplexData> - Class in edu.wpi.first.shuffleboard.api.widget
A complex widget that is backed by a String-to-Object map of data values.
ComplexAnnotatedWidget() - Constructor for class edu.wpi.first.shuffleboard.api.widget.ComplexAnnotatedWidget
 
ComplexData<T extends ComplexData<T>> - Class in edu.wpi.first.shuffleboard.api.data
A complex data type backed internally by an observable map.
ComplexData() - Constructor for class edu.wpi.first.shuffleboard.api.data.ComplexData
 
ComplexDataType<T extends ComplexData> - Class in edu.wpi.first.shuffleboard.api.data
Represents complex data such as POJOs or maps.
ComplexDataType(String, Class<T>) - Constructor for class edu.wpi.first.shuffleboard.api.data.ComplexDataType
 
Component - Interface in edu.wpi.first.shuffleboard.api.widget
A Component is base interface for any part of the dashboard that can be instantiated by the user.
ComponentContainer - Interface in edu.wpi.first.shuffleboard.api.widget
A common interface for objects that can contain components.
componentNamesForSource(DataSource<?>) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Gets the names of all the possible components than can display the data in a given source.
componentNamesForType(DataType) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Gets the names of all the possible components that can display the given type, sorted alphabetically.
components() - Method in interface edu.wpi.first.shuffleboard.api.widget.ComponentContainer
Gets a stream of all the first-level components in this container.
Components - Class in edu.wpi.first.shuffleboard.api.widget
Utility class for keeping track of known widgets.
Components() - Constructor for class edu.wpi.first.shuffleboard.api.widget.Components
 
components() - Method in interface edu.wpi.first.shuffleboard.api.widget.Layout
 
ComponentType<C extends Component> - Interface in edu.wpi.first.shuffleboard.api.widget
A ComponentType is a Java object that encapsulates a single "variety" of component that the user could instantiate.
computeIfAbsent(String, Supplier<DataSource<T>>) - Method in class edu.wpi.first.shuffleboard.api.sources.Sources
 
computeIfAbsent(Map<K, V>, K, ThrowingFunction<? super K, ? extends V, ? extends X>) - Static method in class edu.wpi.first.shuffleboard.api.util.Maps
An unsafe version of Map.computeIfAbsent that may throw a checked exception.
concat(String, String, String...) - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Concatenates multiple keys.
connect() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
connect() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Connects this source to the underlying data stream.
connect() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Connects sources of this type to the backing source interface.
connected - Variable in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
connectedProperty() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
ConnectionStatus - Class in edu.wpi.first.shuffleboard.api.sources
Contains information about the state of a source type's connection to the source of its data.
ConnectionStatus(String, boolean) - Constructor for class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
 
connectionStatusProperty() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
 
containsKey(String) - Method in class edu.wpi.first.shuffleboard.api.data.MapData
 
containsValue(Object) - Method in class edu.wpi.first.shuffleboard.api.data.MapData
 
create(double, double, double, double, double) - Static method in class edu.wpi.first.shuffleboard.api.components.CurvedArrow
Creates a new curved arrow.
createComponent(String) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Tries to create an arbitrary component.
createComponent(String, DataSource<?>) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Creates a new component with the given name.
createPolar(double, double, double, double, double) - Static method in class edu.wpi.first.shuffleboard.api.components.CurvedArrow
Creates a new curved arrow.
createRecordingFilePath(Instant) - Static method in class edu.wpi.first.shuffleboard.api.util.Storage
Generates the path to a recording file based on when a recording started.
createRootSourceEntry() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Creates a root source entry.
createSourceEntryForUri(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Creates a source entry corresponding to the given URI.
createStraight(double, double, double, double) - Static method in class edu.wpi.first.shuffleboard.api.components.CurvedArrow
Creates a straight arrow, which is just a curved arrow with an infinite radius.
createWidget(String, DataSource<T>) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Tries to create a widget from a known widget with the given name.
createWidget(String, Collection<DataSource>) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Tries to create a widget from a known widget with the given name.
createWidget(String) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Tries to create a widget from a known widget name, without an initial source.
currentModeProperty() - Static method in enum edu.wpi.first.shuffleboard.api.DashboardMode
 
CurvedArrow - Class in edu.wpi.first.shuffleboard.api.components
A utility class for generating curved arrows.

D

DashboardMode - Enum in edu.wpi.first.shuffleboard.api
An enum representing the possible modes of dashboard operation.
data - Variable in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
DataFormats - Class in edu.wpi.first.shuffleboard.api.dnd
Utility class for the app's data formats.
DataFormats.WidgetData - Class in edu.wpi.first.shuffleboard.api.dnd
Holds the information about a dragged widget.
dataOrDefault - Variable in class edu.wpi.first.shuffleboard.api.widget.SimpleAnnotatedWidget
A read-only binding of the data for this widget.
dataProperty() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
dataProperty() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
 
dataProperty() - Method in class edu.wpi.first.shuffleboard.api.widget.SimpleAnnotatedWidget
The property for this widgets data.
dataProperty() - Method in interface edu.wpi.first.shuffleboard.api.widget.SingleTypeWidget
Gets a property containing the value of the source.
DataSource<T> - Interface in edu.wpi.first.shuffleboard.api.sources
A data source provides some kind of data that widgets can display and manipulate.
DataType<T> - Class in edu.wpi.first.shuffleboard.api.data
Represents types of data that sources can provide and widgets can display.
DataType(String, Class<T>) - Constructor for class edu.wpi.first.shuffleboard.api.data.DataType
Creates a new data type instance.
dataType - Variable in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
dataTypeForEntry(String) - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Gets the data type most closely associated with the value of the given network table key.
dataTypeForSource(DataTypes, String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Gets the data type of a source for a given URI.
DataTypes - Class in edu.wpi.first.shuffleboard.api.data
Registry of data types in shuffleboard.
DataTypes() - Constructor for class edu.wpi.first.shuffleboard.api.data.DataTypes
Creates a new data type registry.
Debouncer - Class in edu.wpi.first.shuffleboard.api.util
A simple class for debouncing method calls.
Debouncer(Runnable, Duration) - Constructor for class edu.wpi.first.shuffleboard.api.util.Debouncer
Creates a new debouncer.
decode(byte[], int, DataType<T>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Decodes a byte buffer as a value of the given data type.
defaultComponentNameFor(DataType) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Gets the name of the default component for the given data type, or Optional.empty() if there is no default component for that type.
DelegatedAdapter<T> - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
A type adapter whose DelegatedAdapter.serialize(T) and DelegatedAdapter.deserialize(byte[], int) methods are delegated to functions.
DelegatedAdapter(DataType<T>, Function<? super T, byte[]>, BiFunction<byte[], Integer, ? extends T>, ToIntFunction<? super T>) - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.DelegatedAdapter
Creates a new adapter that uses the given functions.
Description - Annotation Type in edu.wpi.first.shuffleboard.api.plugin
Describes a plugins group ID (a unique identifier for the group or organization that develops the plugin); and its name, version, and a summary of what the plugin provides.
Description - Annotation Type in edu.wpi.first.shuffleboard.api.widget
Describes a widget.
deserialize(byte[], int) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.BooleanArrayAdapter
 
deserialize(byte[], int) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.ByteArrayAdapter
 
deserialize(byte[], int) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.DelegatedAdapter
 
deserialize(byte[], int) - Method in interface edu.wpi.first.shuffleboard.api.sources.recording.serialization.Deserializer
Deserializes data from a byte buffer, beginning at the given position.
deserialize(byte[], int) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.NumberArrayAdapter
 
deserialize(byte[], int) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringAdapter
 
deserialize(byte[], int) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringArrayAdapter
 
Deserializer<T> - Interface in edu.wpi.first.shuffleboard.api.sources.recording.serialization
An interface for functions that can convert raw byte arrays of serialized data back to objects.
disconnect() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
disconnect() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Disconnects this source from the underlying data stream.
disconnect() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Disconnects sources of this type from the backing source interface.
DOWN - Static variable in interface edu.wpi.first.shuffleboard.api.util.RoundingMode
Rounds a fractional value up to the nearest integer greater than or equal to the given value.
DummySource<T> - Class in edu.wpi.first.shuffleboard.api.sources
 
DummySource(DataType<T>, T) - Constructor for class edu.wpi.first.shuffleboard.api.sources.DummySource
Create a new static, unchanging source for the given data type and value.

E

EditableLabel - Class in edu.wpi.first.shuffleboard.api.components
 
EditableLabel() - Constructor for class edu.wpi.first.shuffleboard.api.components.EditableLabel
A text label that you can double click to edit.
EditableLabel(Property<String>) - Constructor for class edu.wpi.first.shuffleboard.api.components.EditableLabel
 
edu.wpi.first.shuffleboard.api - package edu.wpi.first.shuffleboard.api
Defines an API for interfacing with Shuffleboard.
edu.wpi.first.shuffleboard.api.components - package edu.wpi.first.shuffleboard.api.components
Defines various useful JavaFX components.
edu.wpi.first.shuffleboard.api.css - package edu.wpi.first.shuffleboard.api.css
 
edu.wpi.first.shuffleboard.api.data - package edu.wpi.first.shuffleboard.api.data
Defines classes for creating and registering data and data types.
edu.wpi.first.shuffleboard.api.data.types - package edu.wpi.first.shuffleboard.api.data.types
 
edu.wpi.first.shuffleboard.api.dnd - package edu.wpi.first.shuffleboard.api.dnd
 
edu.wpi.first.shuffleboard.api.plugin - package edu.wpi.first.shuffleboard.api.plugin
Provides a framework for adding custom widgets, components, data types, sources, and themes to Shuffleboard.
edu.wpi.first.shuffleboard.api.prefs - package edu.wpi.first.shuffleboard.api.prefs
 
edu.wpi.first.shuffleboard.api.properties - package edu.wpi.first.shuffleboard.api.properties
 
edu.wpi.first.shuffleboard.api.sources - package edu.wpi.first.shuffleboard.api.sources
Provides a framework for providing data to Shuffleboard.
edu.wpi.first.shuffleboard.api.sources.recording - package edu.wpi.first.shuffleboard.api.sources.recording
 
edu.wpi.first.shuffleboard.api.sources.recording.serialization - package edu.wpi.first.shuffleboard.api.sources.recording.serialization
 
edu.wpi.first.shuffleboard.api.tab - package edu.wpi.first.shuffleboard.api.tab
 
edu.wpi.first.shuffleboard.api.theme - package edu.wpi.first.shuffleboard.api.theme
 
edu.wpi.first.shuffleboard.api.util - package edu.wpi.first.shuffleboard.api.util
 
edu.wpi.first.shuffleboard.api.widget - package edu.wpi.first.shuffleboard.api.widget
Provides a framework for defining UI components for use in Shuffleboard.
enabledProperty() - Static method in class edu.wpi.first.shuffleboard.api.LiveWindow
 
encode(T) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
 
encode(T, DataType<T>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a value as a byte array.
EqualityUtils - Class in edu.wpi.first.shuffleboard.api.util
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.data.DataType
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
 
equals(Object) - Method in class edu.wpi.first.shuffleboard.api.widget.TileSize
 
exportProperties(Property<?>...) - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
Exports the given properties so other parts of the app can see the properties of this widget.
ExtendedPropertySheet - Class in edu.wpi.first.shuffleboard.api.components
A version of PropertySheet that has better support for editing numbers (using NumberField and IntegerField for doubles and integers, respectively) and booleans (using ToggleSwitch), and themes.
ExtendedPropertySheet() - Constructor for class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet
Creates an empty property sheet.
ExtendedPropertySheet(Collection<? extends Property<?>>) - Constructor for class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet
Creates a new property sheet containing items for each of the given properties.
ExtendedPropertySheet.PropertyItem<T> - Class in edu.wpi.first.shuffleboard.api.components
An item backed by a JavaFX property.

F

first() - Method in class edu.wpi.first.shuffleboard.api.util.ListUtils.Replacement
Makes only the first instance of the target value be replaced.
flagMatches(int, int) - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Checks if network table flags contains a specific flag.
flush() - Method in class edu.wpi.first.shuffleboard.api.prefs.FlushableProperty
 
FlushableProperty<T> - Class in edu.wpi.first.shuffleboard.api.prefs
A Property that can be flushed.
FlushableProperty(Property<T>) - Constructor for class edu.wpi.first.shuffleboard.api.prefs.FlushableProperty
Create a new FlushableProperty.
forAnnotatedWidget(Class<T>) - Static method in interface edu.wpi.first.shuffleboard.api.widget.WidgetType
Creates a widget type for a widget class that has a @Description annotation.
forJavaType(Class<T>) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Gets the data type most relevant to a Java class.
forJavaTypes(Class<?>...) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Gets a set of registered data types that can handle data of the supplied Java types.
forName(String) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Gets the data type with the given name.
forName(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Gets the source type with the given name, or SourceTypes.None if that name has not been registered.
forName(String) - Method in class edu.wpi.first.shuffleboard.api.theme.Themes
Gets the theme with the given name.
forType(Class<D>) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Gets the registered data type of the given class.
forType(DataType<T>) - Static method in class edu.wpi.first.shuffleboard.api.sources.DummySource
 
forType(SourceType) - Method in class edu.wpi.first.shuffleboard.api.sources.Sources
Gets a list of all the known data sources.
forTypes(Class<? extends DataType>...) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Gets the registered data types of the given types.
forTypes(Set<DataType>) - Static method in class edu.wpi.first.shuffleboard.api.sources.DummySource
Return an example source value for the given data types.
forTypes(DataType...) - Static method in class edu.wpi.first.shuffleboard.api.sources.DummySource
 
forUri(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Given a URI-like string with a protocol and a pseudo-path, return a source for the current SourceType This function will throw an error if it doesn't support the protocol that's passed.
forUri(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Creates a data source corresponding to the given URI.
fromMap() - Method in class edu.wpi.first.shuffleboard.api.data.ComplexDataType
Gets a function used to create a new data object from a map of values to property names.
fromMap(Map<String, Object>) - Method in class edu.wpi.first.shuffleboard.api.data.ComplexDataType
Creates a new data object from the given map.
fromMap() - Method in class edu.wpi.first.shuffleboard.api.data.types.MapType
 
fromString(String) - Method in class edu.wpi.first.shuffleboard.api.util.UnitStringConverter
 
fullIdString() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets an ID string unique to this plugin in the format "{groupId}:{name}:{version}.
FxUtils - Class in edu.wpi.first.shuffleboard.api.util
Utility methods for JavaFX not available in the standard library.

G

get(String) - Method in class edu.wpi.first.shuffleboard.api.data.MapData
 
get() - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
get() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
get() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
get(DataType<T>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
Gets the type adapter for the given data type, or null if no such adapter exists.
get(String) - Method in class edu.wpi.first.shuffleboard.api.sources.Sources
 
get(Map<? super K, ?>, K) - Static method in class edu.wpi.first.shuffleboard.api.util.Maps
Gets the element mapped to K in a map, casting it as needed.
get() - Method in class edu.wpi.first.shuffleboard.api.widget.LayoutClass
 
getActiveWidgets() - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Gets a list of the active widgets in the application.
getAdapters() - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
 
getAllSourceNames(List<TimestampedData>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Gets the names of all the sources represented in a data set.
getAngle() - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
Gets the angle of this vector, in radians in the range (-pi, pi).
getAsImage(Color) - Method in class edu.wpi.first.shuffleboard.api.util.GridImage
Creates an image of a grid based off this model.
getAvailableSources() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Gets a observable map of available source URIs to their values.
getAvailableSourceUris() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Gets a list of the URIs of all available sources of this type.
getBean() - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
getBean() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
getBean() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
getBean() - Method in class edu.wpi.first.shuffleboard.api.util.PseudoClassProperty
 
getCategory() - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
getCenter() - Method in class edu.wpi.first.shuffleboard.api.components.LinearIndicator
Gets the value of the property center.
getChildren() - Method in interface edu.wpi.first.shuffleboard.api.widget.Layout
 
getCol() - Method in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
getComponents() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a list of the non-annotated components defined by this plugin.
getConnectionStatus() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Gets the connection status of this source type.
getControlCssMetaData() - Method in class edu.wpi.first.shuffleboard.api.components.StyleableGauge
 
getCurrentFile() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.TypeAdapter
Gets the current recording file being loaded.
getCurrentMode() - Static method in enum edu.wpi.first.shuffleboard.api.DashboardMode
Gets the current mode of the dashboard.
getData() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Gets the current value of this data source.
getData() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
getData() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
getData() - Method in interface edu.wpi.first.shuffleboard.api.widget.SingleTypeWidget
Gets the current value of the data source.
getDataType() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
getDataType() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Gets the type of data that this source is providing.
getDataType() - Method in interface edu.wpi.first.shuffleboard.api.sources.recording.serialization.Deserializer
Gets the type of data this can deserialize.
getDataType() - Method in interface edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializer
Gets the type of the data this can serialize.
getDataType() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.TypeAdapter
 
getDataType() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
getDataType() - Method in interface edu.wpi.first.shuffleboard.api.widget.SingleTypeWidget
 
getDataTypes() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a list of custom data types that this plugin defines.
getDataTypes() - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidgetType
 
getDataTypes() - Method in interface edu.wpi.first.shuffleboard.api.widget.AnnotatedWidget
 
getDataTypes() - Method in interface edu.wpi.first.shuffleboard.api.widget.ComponentType
Gets a set of data types that this component is capable of displaying.
getDataTypes() - Method in interface edu.wpi.first.shuffleboard.api.widget.Sourced
Gets the allowable data types for sources.
getDataTypes() - Method in interface edu.wpi.first.shuffleboard.api.widget.WidgetType
Get data types the widget should be suggested for.
getDebounceDelay() - Method in class edu.wpi.first.shuffleboard.api.util.Debouncer
Gets the maximum amount of time after a method has been called to wait before running it.
getDefault() - Static method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Gets the default data type registry.
getDefault() - Static method in class edu.wpi.first.shuffleboard.api.sources.Sources
 
getDefault() - Static method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Gets the default source type registry.
getDefault() - Static method in class edu.wpi.first.shuffleboard.api.theme.Themes
Gets the default themes instance.
getDefault() - Static method in class edu.wpi.first.shuffleboard.api.widget.Components
Gets the default widget registry.
getDefaultComponents() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a map of the default components to use for each data type.
getDefaultTabInfo() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a list of information about any default tabs that shuffleboard should use.
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.DataType
Gets the default value of this data type, eg 0 for numbers or an empty String for text.
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.AllType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.BooleanArrayType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.BooleanType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.MapType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.NoneType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.NumberArrayType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.NumberType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.RawByteType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.StringArrayType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.StringType
 
getDefaultValue() - Method in class edu.wpi.first.shuffleboard.api.data.types.UnknownType
 
getDescription() - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
getDescription() - Method in interface edu.wpi.first.shuffleboard.api.widget.AnnotatedWidget
 
getDragPoint() - Method in class edu.wpi.first.shuffleboard.api.dnd.DataFormats.WidgetData
 
getEntryForCellData(TreeTableColumn.CellDataFeatures<T, ?>) - Static method in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
 
getFirst() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
getGroupId() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
The group ID of this plugin.
getHeight() - Method in class edu.wpi.first.shuffleboard.api.widget.TileSize
 
getHost() - Method in class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
Gets the host(s) that the source type is connected to.
getId() - Method in class edu.wpi.first.shuffleboard.api.dnd.DataFormats.WidgetData
 
getId() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
 
getInstance() - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Gets the recorder instance.
getItems() - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Gets a read-only view of the list of registered items.
getJavaClass() - Method in class edu.wpi.first.shuffleboard.api.data.DataType
Gets the Java class of the data objects this data type represents.
getLabel(Node) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Gets the label associated with a node.
getLast() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
getLength() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
Gets the length of this recording in milliseconds.
getMagnitude() - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
Gets the magnitude of this vector.
getName() - Method in class edu.wpi.first.shuffleboard.api.components.ActionList
 
getName() - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
getName() - Method in class edu.wpi.first.shuffleboard.api.data.DataType
Gets the name of this data type.
getName() - Method in class edu.wpi.first.shuffleboard.api.data.NamedData
 
getName() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets the name of this plugin.
getName() - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
getName() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
getName() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
getName() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Gets the name of this data source.
getName() - Method in interface edu.wpi.first.shuffleboard.api.sources.SourceEntry
The name of a source corresponding to this entry.
getName() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
 
getName() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
Gets the name of the tab this represents.
getName() - Method in class edu.wpi.first.shuffleboard.api.theme.Theme
Gets the name of this theme.
getName() - Method in class edu.wpi.first.shuffleboard.api.util.PseudoClassProperty
 
getName() - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidgetType
 
getName() - Method in interface edu.wpi.first.shuffleboard.api.widget.AnnotatedWidget
 
getName() - Method in interface edu.wpi.first.shuffleboard.api.widget.Component
Gets the name of this widget type.
getName() - Method in interface edu.wpi.first.shuffleboard.api.widget.ComponentType
Get the name of the component (ex: "Number Slider").
getName() - Method in class edu.wpi.first.shuffleboard.api.widget.LayoutClass
 
getNumber() - Method in class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
Gets the value of the property number.
getNumberFromText(String) - Method in class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
Converts text representation of a number to the number itself.
getNumberFromText(String) - Method in class edu.wpi.first.shuffleboard.api.components.IntegerField
 
getNumberFromText(String) - Method in class edu.wpi.first.shuffleboard.api.components.NumberField
 
getObservableValue() - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
getOptional(DataType<T>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
Gets an optional containing the adapter for the given data type, or an empty optional if there is no such adapter.
getPluginPath() - Static method in class edu.wpi.first.shuffleboard.api.util.Storage
The directory that plugins are loaded from.
getProperties() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a list of properties of this plugin that can be changed by users.
getProperties() - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
 
getProperties() - Method in interface edu.wpi.first.shuffleboard.api.widget.Widget
Gets the user-configurable properties for this widget.
getProtocol() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
 
getRecordingDir() - Static method in class edu.wpi.first.shuffleboard.api.util.Storage
The directory that contains the nested recording files and sub-directories.
getRecordingFile() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
 
getRow() - Method in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
getSerializedSize(boolean[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.BooleanArrayAdapter
 
getSerializedSize(byte[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.ByteArrayAdapter
 
getSerializedSize(T) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.DelegatedAdapter
 
getSerializedSize(T) - Method in interface edu.wpi.first.shuffleboard.api.sources.recording.serialization.Deserializer
Gets the size of a byte array that would encode the given value.
getSerializedSize(double[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.NumberArrayAdapter
 
getSerializedSize(String) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringAdapter
 
getSerializedSize(String[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringArrayAdapter
 
getSource() - Method in class edu.wpi.first.shuffleboard.api.widget.SingleSourceWidget
Gets the value of the property source.
getSourceId() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
getSourceIds() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
getSourcePrefix() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
The source prefix the tab should use when autopopulating.
getSources() - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
 
getSources() - Method in interface edu.wpi.first.shuffleboard.api.widget.Sourced
Gets an observable list of the sources for this object.
getSourceType() - Method in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Gets the value of the property sourceType.
getSourceTypes() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a list of custom source types that this plugin defines.
getStartTime() - Static method in class edu.wpi.first.shuffleboard.api.util.Time
Gets the start time of the current application run in epoch milliseconds.
getStorageDir() - Static method in class edu.wpi.first.shuffleboard.api.util.Storage
The main storage directory that all Shuffleboard files should exist in.
getStyleableProperty(S) - Method in class edu.wpi.first.shuffleboard.api.css.SimpleCssMetaData
 
getStyleSheets() - Method in class edu.wpi.first.shuffleboard.api.theme.Theme
Gets the style sheets in this theme.
getSummary() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a descriptive string describing what this plugin provides.
getText() - Method in class edu.wpi.first.shuffleboard.api.components.EditableLabel
Gets the value of the property text.
getThemes() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets a list of themes that this plugin defines.
getThemes() - Method in class edu.wpi.first.shuffleboard.api.theme.Themes
Gets an observable list of the registered themes.
getThemesDir() - Static method in class edu.wpi.first.shuffleboard.api.util.Storage
Gets the directory for custom external themes, creating it if it does not exist.
getTimestamp() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
getTitle() - Method in interface edu.wpi.first.shuffleboard.api.widget.Component
Gets the value of the property title.
getType() - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
getType() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Gets the type of this source.
getType() - Method in class edu.wpi.first.shuffleboard.api.sources.DummySource
 
getType() - Method in class edu.wpi.first.shuffleboard.api.sources.SubSource
 
getType() - Method in interface edu.wpi.first.shuffleboard.api.widget.ComponentType
 
getType() - Method in class edu.wpi.first.shuffleboard.api.widget.LayoutClass
 
getTypeAdapters() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
 
getTypesExpected() - Method in exception edu.wpi.first.shuffleboard.api.data.IncompatibleSourceException
 
getTypesFound() - Method in exception edu.wpi.first.shuffleboard.api.data.IncompatibleSourceException
 
getUserAgentStylesheet() - Method in class edu.wpi.first.shuffleboard.api.components.StyleableGauge
 
getValue() - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
getValue() - Method in class edu.wpi.first.shuffleboard.api.components.LinearIndicator
Gets the value of the property value.
getValue() - Method in class edu.wpi.first.shuffleboard.api.data.NamedData
 
getValue() - Method in interface edu.wpi.first.shuffleboard.api.sources.SourceEntry
The value of a source corresponding to this entry.
getValueView() - Method in interface edu.wpi.first.shuffleboard.api.sources.SourceEntry
Gets an object used to display the value of the source this entry represents.
getVersion() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets the version of this plugin.
getView() - Method in interface edu.wpi.first.shuffleboard.api.widget.Component
Gets a JavaFX pane that displays this component.
getViewName() - Method in interface edu.wpi.first.shuffleboard.api.sources.SourceEntry
The string to use to display the name of the source.
getWidth() - Method in class edu.wpi.first.shuffleboard.api.widget.TileSize
 
getX() - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
Gets the X-coordinate of this vector.
getY() - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
Gets the Y-coordinate of this vector.
GridImage - Class in edu.wpi.first.shuffleboard.api.util
A representation of an image of a grid.
GridImage(int, int, int, int, int) - Constructor for class edu.wpi.first.shuffleboard.api.util.GridImage
Creates a new grid image representation.
GridPoint - Class in edu.wpi.first.shuffleboard.api.util
Represents a point in a grid.
GridPoint(int, int) - Constructor for class edu.wpi.first.shuffleboard.api.util.GridPoint
Creates a point at the given column and row indices.

H

hasClients() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
hasClients() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Checks if any clients are connected to this source.
hasComponentFor(String) - Method in interface edu.wpi.first.shuffleboard.api.Populatable
Checks if this contains a component corresponding to a data source.
hashCode() - Method in class edu.wpi.first.shuffleboard.api.data.DataType
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
 
hashCode() - Method in class edu.wpi.first.shuffleboard.api.widget.TileSize
 
hasItems() - Method in class edu.wpi.first.shuffleboard.api.components.ActionList
 
hasSerializer(DataType<?>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
Checks if there is an adapter for the given data type.
header(List<TimestampedData>) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Generates a header for a serialized recording.
hierarchy(DataSource<?>) - Method in class edu.wpi.first.shuffleboard.api.sources.Sources
 

I

idString() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Gets an ID string unique to this plugin in the format "{groupId}:{name}".
ImmediateChangeListener<T> - Interface in edu.wpi.first.shuffleboard.api.properties
A change listener that is invoked immediately when an atomic property changes.
IncompatibleSourceException - Exception in edu.wpi.first.shuffleboard.api.data
 
IncompatibleSourceException(Set<DataType>, DataType) - Constructor for exception edu.wpi.first.shuffleboard.api.data.IncompatibleSourceException
Represents binding sources of incompatible types to a widget.
IncompleteDataException - Exception in edu.wpi.first.shuffleboard.api.data
An exception thrown when attempting to create a data object without having all the variables available.
IncompleteDataException(String) - Constructor for exception edu.wpi.first.shuffleboard.api.data.IncompleteDataException
 
IncompleteDataException(String, Throwable) - Constructor for exception edu.wpi.first.shuffleboard.api.data.IncompleteDataException
 
INITIAL_THEME - Static variable in class edu.wpi.first.shuffleboard.api.theme.Themes
 
inst - Static variable in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
The root network table.
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.AllType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.BooleanArrayType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.BooleanType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.MapType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.NoneType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.NumberArrayType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.NumberType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.RawByteType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.StringArrayType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.StringType
 
Instance - Static variable in class edu.wpi.first.shuffleboard.api.data.types.UnknownType
 
INSTANCE - Static variable in class edu.wpi.first.shuffleboard.api.util.AlphanumComparator
A public default instance to use, since every instance of this class is identical.
IntegerField - Class in edu.wpi.first.shuffleboard.api.components
A type of text field that only accepts valid integers.
IntegerField() - Constructor for class edu.wpi.first.shuffleboard.api.components.IntegerField
 
IntegerField(int) - Constructor for class edu.wpi.first.shuffleboard.api.components.IntegerField
 
invalidated(T, T) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
Fires all listeners when the value of the property changes.
invalidated() - Method in class edu.wpi.first.shuffleboard.api.util.PseudoClassProperty
 
InvalidPluginDefinitionException - Exception in edu.wpi.first.shuffleboard.api.plugin
An exception that can be thrown when a plugin has an invalid definition, e.g.
InvalidPluginDefinitionException(String) - Constructor for exception edu.wpi.first.shuffleboard.api.plugin.InvalidPluginDefinitionException
 
InvalidPluginDefinitionException(String, Throwable) - Constructor for exception edu.wpi.first.shuffleboard.api.plugin.InvalidPluginDefinitionException
 
InvalidWidgetException - Exception in edu.wpi.first.shuffleboard.api.widget
An exception thrown when a widget is determined to have an invalid configuration.
InvalidWidgetException(String) - Constructor for exception edu.wpi.first.shuffleboard.api.widget.InvalidWidgetException
Constructs an exception with the given message.
isActive() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Gets the value of the property active.
isAutoPopulate() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
Checks if the tab should autopopulate.
isBound() - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
isBound() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
isBound() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
isBound() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
isChanged() - Method in class edu.wpi.first.shuffleboard.api.prefs.FlushableProperty
 
isCompatible(DataType, Collection<? extends DataType>) - Static method in class edu.wpi.first.shuffleboard.api.data.DataTypes
 
isCompleteNumber(String) - Method in class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
Checks if the given string is a valid number acceptable by this text field.
isCompleteNumber(String) - Method in class edu.wpi.first.shuffleboard.api.components.IntegerField
 
isCompleteNumber(String) - Method in class edu.wpi.first.shuffleboard.api.components.NumberField
 
isComplex() - Method in class edu.wpi.first.shuffleboard.api.data.ComplexDataType
 
isComplex() - Method in class edu.wpi.first.shuffleboard.api.data.DataType
Checks if this data type is complex or not.
isComplex() - Method in class edu.wpi.first.shuffleboard.api.data.SimpleDataType
 
isConnected() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
Gets the value of the property connected.
isConnected() - Method in class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
Checks if the source type connected to the host(s).
isConnected() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Checks if this source is currently connected to its underlying data stream.
isDelete(int) - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Checks if the given network table flags contains the delete flag.
isDifferent(Object, Object) - Static method in class edu.wpi.first.shuffleboard.api.util.EqualityUtils
Checks if two objects are different, ie !isEqual(o1, o2).
isDifferent(T[], T[]) - Static method in class edu.wpi.first.shuffleboard.api.util.EqualityUtils
Checks if two object arrays are different, ie !isEqual(array1, array2).
isEmpty() - Method in class edu.wpi.first.shuffleboard.api.data.MapData
 
isEnabled() - Static method in class edu.wpi.first.shuffleboard.api.LiveWindow
Gets the value of the property enabled.
isEqual(Object, Object) - Static method in class edu.wpi.first.shuffleboard.api.util.EqualityUtils
Checks if two objects are equal.
isEqual(T[], T[]) - Static method in class edu.wpi.first.shuffleboard.api.util.EqualityUtils
Checks if two object arrays are logically equal.
isLoaded() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Checks if this plugin has been loaded.
isMetadata(String) - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Checks if the given key is metadata, eg matches the format "~METADATA~" or ".metadata"
isRecordable() - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
 
isRegistered(T) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Checks if the given item has been registered with this registry.
isResizable() - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
isRunning() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Gets the value of the property running.
isSettable(S) - Method in class edu.wpi.first.shuffleboard.api.css.SimpleCssMetaData
 
isStartOfNumber(String) - Method in class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
Checks if the given string is a valid start to an acceptable number in text form.
isStartOfNumber(String) - Method in class edu.wpi.first.shuffleboard.api.components.IntegerField
 
isStartOfNumber(String) - Method in class edu.wpi.first.shuffleboard.api.components.NumberField
 

J

javaTypeFor(String) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
 
joining(Supplier<? extends T>) - Static method in class edu.wpi.first.shuffleboard.api.util.ListUtils
 
joining(Supplier<? extends T>, Supplier<? extends T>, Supplier<? extends T>) - Static method in class edu.wpi.first.shuffleboard.api.util.ListUtils
Creates a collector for interleaving items with a constant separator item, along with prepending and appending items to bookend the resulting list.

L

Layout - Interface in edu.wpi.first.shuffleboard.api.widget
A Layout is a dashboard Component that holds other Components (i.e., widgets or other layouts) in a nested fashion.
LayoutClass<T extends Layout> - Class in edu.wpi.first.shuffleboard.api.widget
A helper class for creating ComponentTypes from Layout classes and a name.
LayoutClass(String, Class<T>) - Constructor for class edu.wpi.first.shuffleboard.api.widget.LayoutClass
 
LayoutType<T extends Layout> - Interface in edu.wpi.first.shuffleboard.api.widget
A typed sub-class of ComponentType for Layouts.
LinearIndicator - Class in edu.wpi.first.shuffleboard.api.components
A component that uses a bar to display a number.
LinearIndicator() - Constructor for class edu.wpi.first.shuffleboard.api.components.LinearIndicator
 
ListUtils - Class in edu.wpi.first.shuffleboard.api.util
Utility class for working with lists.
ListUtils.Replacement<T> - Class in edu.wpi.first.shuffleboard.api.util
 
LiveWindow - Class in edu.wpi.first.shuffleboard.api
Helper class for dealing with LiveWindow mode.
loadedProperty() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
 
loadRecording(Path) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Loads the recording stored in the given file.
loadThemesFromDir() - Method in class edu.wpi.first.shuffleboard.api.theme.Themes
Loads and registers all themes from the themes directory.
logger - Static variable in class edu.wpi.first.shuffleboard.api.widget.Components
 

M

MAGIC_NUMBER - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
A magic number that is always the first entry in a recording file.
makeDaemonThread(Runnable) - Static method in class edu.wpi.first.shuffleboard.api.util.ThreadUtils
Creates a daemon thread to run the given runnable.
Map - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
 
MapBuilder() - Constructor for class edu.wpi.first.shuffleboard.api.util.Maps.MapBuilder
 
MapData - Class in edu.wpi.first.shuffleboard.api.data
 
MapData(Map<String, Object>) - Constructor for class edu.wpi.first.shuffleboard.api.data.MapData
 
Maps - Class in edu.wpi.first.shuffleboard.api.util
Utility class for maps.
Maps.MapBuilder<K,V> - Class in edu.wpi.first.shuffleboard.api.util
A builder class for maps.
MapType - Class in edu.wpi.first.shuffleboard.api.data.types
 
MATERIAL_DARK - Static variable in class edu.wpi.first.shuffleboard.api.theme.Themes
 
MATERIAL_LIGHT - Static variable in class edu.wpi.first.shuffleboard.api.theme.Themes
 
maxHeight(double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
maxWidth(double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
menuItem(String, EventHandler<ActionEvent>) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Creates a menu item with the given text and event handler.
menuLabel(String) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Creates a disabled menu item for use as a label.
minHeight(double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
minWidth(double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 

N

name - Variable in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
name(String) - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo.TabInfoBuilder
Sets the name of the built tab.
NamedData<T> - Class in edu.wpi.first.shuffleboard.api.data
Data that only contains a name and value.
NamedData(String, T) - Constructor for class edu.wpi.first.shuffleboard.api.data.NamedData
 
nameProperty() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
nameProperty() - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
 
NEAREST - Static variable in interface edu.wpi.first.shuffleboard.api.util.RoundingMode
Rounds a fractional value to the nearest integer.
NetworkTableUtils - Class in edu.wpi.first.shuffleboard.api.util
Utility class for working with network tables.
newDaemonScheduledExecutorService() - Static method in class edu.wpi.first.shuffleboard.api.util.ThreadUtils
A single-threaded ScheduledExecutorService that uses a daemon thread instead of one the doesn't respect shutdown.
Nil - Static variable in class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
 
None - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
Represents the type of "null" or non-present data.
none() - Static method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Creates a data source with no name, no data, and is never active.
None - Static variable in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
 
NoneType - Class in edu.wpi.first.shuffleboard.api.data.types
Represents the type of "null" or non-present data.
now() - Static method in class edu.wpi.first.shuffleboard.api.util.Time
Gets the current time in epoch milliseconds according to the system clock.
Number - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to numeric data.
NumberArray - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to an array of numeric data (double[]).
NumberArrayAdapter - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
 
NumberArrayAdapter() - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.NumberArrayAdapter
 
NumberArrayType - Class in edu.wpi.first.shuffleboard.api.data.types
 
NumberField - Class in edu.wpi.first.shuffleboard.api.components
A type of text field that only accepts valid floating-point decimal numbers.
NumberField() - Constructor for class edu.wpi.first.shuffleboard.api.components.NumberField
Creates a new number field with no value.
NumberField(double) - Constructor for class edu.wpi.first.shuffleboard.api.components.NumberField
Creates a number field with the given initial value.
numberProperty() - Method in class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
 
NumberType - Class in edu.wpi.first.shuffleboard.api.data.types
 

O

onLoad() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Called when a plugin is loaded.
onUnload() - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Called when a plugin is unloaded.
optionalCast(Object, Class<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.TypeUtils
If 'value' can be cast into 'cls', returns an Optional of that casted value.
optionalCast(Class<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.TypeUtils
 
optionalStream() - Static method in class edu.wpi.first.shuffleboard.api.util.TypeUtils
Turns a Stream of Optional<T>s into a Stream of the type T wrapped by the optional, dropping non-present values.

P

ParametrizedController - Annotation Type in edu.wpi.first.shuffleboard.api.widget
An annotation for FXML-based widgets that contains the path to the FXML file.
pickComponentNameFor(DataType) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Gets the name of a component that can handle data of the given type.
Plugin - Class in edu.wpi.first.shuffleboard.api.plugin
Common superclass for plugins that can be loaded by the app at startup or during runtime.
Plugin() - Constructor for class edu.wpi.first.shuffleboard.api.plugin.Plugin
Creates a new plugin instance.
Populatable - Interface in edu.wpi.first.shuffleboard.api
Common interface for items that support auto-population of UI components by the application.
PreferencesUtils - Class in edu.wpi.first.shuffleboard.api.util
Utilities for saving and loading JavaFX properties to and from a Preferences object.
prefHeight(double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
prefWidth(double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
PropertyItem(Property<T>) - Constructor for class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
Creates a new PropertyItem from the given property.
PropertyItem(Property<T>, String) - Constructor for class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
Creates a new PropertyItem from the given property and with the given name.
PropertyUtils - Class in edu.wpi.first.shuffleboard.api.util
Utility methods for working with JavaFX properties.
PseudoClassProperty - Class in edu.wpi.first.shuffleboard.api.util
A boolean property that is reflected as a pseudo-class selector on the given node.
PseudoClassProperty(Node, String) - Constructor for class edu.wpi.first.shuffleboard.api.util.PseudoClassProperty
Creates a property for the specific node and pseudoClass.
put(String, Object) - Method in class edu.wpi.first.shuffleboard.api.data.MapData
Creates a new MapData instance that is identical to this one, but with a new value for the given key.
put(byte[], byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Puts src into dst at the given position.
put(K, V) - Method in class edu.wpi.first.shuffleboard.api.util.Maps.MapBuilder
Puts the given key-value entry into the map and returns this builder to allow for method chaining.
putAll(Map<? extends K, ? extends V>) - Method in class edu.wpi.first.shuffleboard.api.util.Maps.MapBuilder
Puts all the contents of a map into the builder.

R

RawByteType - Class in edu.wpi.first.shuffleboard.api.data.types
 
read(TimestampedData) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Reads a data point and passes it to all appropriate sources of this type.The default behavior is to do nothing; recordable subclasses must override this method.
read(Property<? super T>, Preferences, Function<String, ? extends T>) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Reads a value saved in a preferences object and stores it in a JavaFX property.
read(IntegerProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Reads an int saved in a preferences object and stores it in a JavaFX property.
read(LongProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Reads a long saved in a preferences object and stores it in a JavaFX property.
read(DoubleProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Reads a double saved in a preferences object and stores it in a JavaFX property.
read(BooleanProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Reads a boolean saved in a preferences object and stores it in a JavaFX property.
read(StringProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Reads a string saved in a preferences object and stores it in a JavaFX property.
readBoolean(byte[]) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Parses a byte array as a boolean value.
readBoolean(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a boolean from a byte array at the given position.
readDouble(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a double-precision number from a big-endian byte array.
readInt(byte[]) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a 32-bit int from a big-endian byte array.
readInt(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a 32-bit int from a big-endian byte array.
readLong(byte[]) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a 64-bit int from a big-endian byte array.
readLong(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a 64-bit int from a big-endian byte array.
readShort(byte[]) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a short (signed 16-bit integer) from a big-endian byte array.
readShort(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a short (signed 16-bit integer) from a big-endian byte array.
readString(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a string from the given byte array, starting at the given position.
readStringArray(byte[], int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Reads a string array from the given byte array, starting at the given position.
record(String, DataType<?>, Object) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Records a data point at the current time.
recordCurrentValue(DataSource<?>) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Records the current value of the given source.
Recorder - Class in edu.wpi.first.shuffleboard.api.sources.recording
Records data from sources.
Recording - Class in edu.wpi.first.shuffleboard.api.sources.recording
 
Recording() - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
register(DataType) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Registers the given data type.
register(DataSource) - Method in class edu.wpi.first.shuffleboard.api.sources.Sources
 
register(SourceType) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Registers a new source type.
register(Theme) - Method in class edu.wpi.first.shuffleboard.api.theme.Themes
 
register(T) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Registers an item with this registry.
register(ComponentType) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
 
register(Class<T>) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Convenience overload for registering annotated widgets.
registerAll(T...) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Registers many items at once.
registerAll(Collection<? extends T>) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Registers many items at once.
registerIfAbsent(T) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Registers an item only if it is not already registered.
registerSupplier(Node, Supplier<ActionList>) - Static method in class edu.wpi.first.shuffleboard.api.components.ActionList
Add an ActionList supplier to a Node, for insertion in a scene graph.
Registry<T> - Class in edu.wpi.first.shuffleboard.api.util
Common superclass for registry classes.
Registry() - Constructor for class edu.wpi.first.shuffleboard.api.util.Registry
 
remove(TypeAdapter) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializers
Removes the given type adapter.
removeAllSources() - Method in interface edu.wpi.first.shuffleboard.api.widget.Sourced
 
removeChangeListener(ChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
removeClient(Sourced) - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
removeClient(Sourced) - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Removes a client from this source.
removeEntry(S) - Method in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Removes a source entry from this tree table, as well as all child entries and empty parents.
removeImmediateListener(ImmediateChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
removeImmediateListener(ImmediateChangeListener<? super Boolean>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
removeImmediateListener(ImmediateChangeListener<? super Number>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
removeImmediateListener(ImmediateChangeListener<? super T>) - Method in interface edu.wpi.first.shuffleboard.api.properties.AtomicProperty
Removes an immediate listener from this property.
removeImmediateListener(ImmediateChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
removeInvalidationListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
 
removeItem(T) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Removes an item from the list of registered items.
removeListener(ChangeListener<? super T>) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
removeListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
removeListener(ChangeListener<? super Boolean>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
removeListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
removeListener(ChangeListener<? super Number>) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
removeListener(InvalidationListener) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
removeProtocol(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Removes the protocol prefix from a string.
removeSource(DataSource) - Method in interface edu.wpi.first.shuffleboard.api.widget.Sourced
 
replace(Predicate<? super T>) - Method in class edu.wpi.first.shuffleboard.api.util.ListUtils.Replacement
Sets a predicate to use to test elements in the list.
replace(T) - Method in class edu.wpi.first.shuffleboard.api.util.ListUtils.Replacement
Sets the element to be replaced.
replaceIn(List<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.ListUtils
Replaces the first instance of an element in a list with another.
Requirements - Annotation Type in edu.wpi.first.shuffleboard.api.plugin
Marks a plugin class as requiring other plugins.
Requires - Annotation Type in edu.wpi.first.shuffleboard.api.plugin
Defines a requirement of a plugin.
reset() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Resets this recorder.
ResizableImageView - Class in edu.wpi.first.shuffleboard.api.components
An implementation of ImageView that has proper resizing code.
ResizableImageView() - Constructor for class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
resize(double, double) - Method in class edu.wpi.first.shuffleboard.api.components.ResizableImageView
 
rootTable - Static variable in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
 
round(double) - Method in interface edu.wpi.first.shuffleboard.api.util.RoundingMode
Rounds a fractional value to an integer.
RoundingMode - Interface in edu.wpi.first.shuffleboard.api.util
Specifies a rounding behavior for mathematical operations.
row - Variable in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
run() - Method in class edu.wpi.first.shuffleboard.api.util.Debouncer
 
runAsync(Runnable) - Static method in class edu.wpi.first.shuffleboard.api.util.AsyncUtils
 
runningProperty() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
 
runOnFxThread(Runnable) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Runs a task on the JavaFX application thread as soon as possible.

S

save(Property<? extends T>, Preferences, Function<? super T, String>) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Saves a property to a preferences object.
save(IntegerProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Saves an integer property.
save(LongProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Saves a long property.
save(DoubleProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Saves a double property.
save(BooleanProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Saves a boolean property.
save(StringProperty, Preferences) - Static method in class edu.wpi.first.shuffleboard.api.util.PreferencesUtils
Saves a string property.
saveRecording(Recording, Path) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Saves a recording to the given file.
Serialization - Class in edu.wpi.first.shuffleboard.api.sources.recording
 
serialize(boolean[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.BooleanArrayAdapter
 
serialize(byte[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.ByteArrayAdapter
 
serialize(T) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.DelegatedAdapter
 
serialize(double[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.NumberArrayAdapter
 
serialize(T) - Method in interface edu.wpi.first.shuffleboard.api.sources.recording.serialization.Serializer
Serializes the given data as a byte array.
serialize(String) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringAdapter
 
serialize(String[]) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringArrayAdapter
 
Serializer<T> - Interface in edu.wpi.first.shuffleboard.api.sources.recording.serialization
An interface for functions that can convert data of type T to a raw byte array.
Serializers - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
Keeps track of data serializers to use for saving and loading data recording files.
set(T) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
set(boolean) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
set(int) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
setActive(boolean) - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
Sets the value of the property active.
setAsyncRunner(Consumer<Runnable>) - Static method in class edu.wpi.first.shuffleboard.api.util.AsyncUtils
 
setCenter(double) - Method in class edu.wpi.first.shuffleboard.api.components.LinearIndicator
Sets the value of the property center.
setConnected(boolean) - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
Sets the value of the property connected.
setConnectionStatus(ConnectionStatus) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
Sets the connection status of this source type.
setCurrentFile(File) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.serialization.TypeAdapter
Sets the current recording file.
setCurrentMode(DashboardMode) - Static method in enum edu.wpi.first.shuffleboard.api.DashboardMode
Sets the current mode of the dashboard.
setData(T) - Method in interface edu.wpi.first.shuffleboard.api.sources.DataSource
Sets the value of the property data.
setData(T) - Method in interface edu.wpi.first.shuffleboard.api.widget.SingleTypeWidget
Sets the current value of the data source.
setDefault(DataTypes) - Static method in class edu.wpi.first.shuffleboard.api.data.DataTypes
Sets the default instance to use.
setDefault(Components) - Static method in class edu.wpi.first.shuffleboard.api.widget.Components
Sets the default instance to use.
setDefaultComponent(DataType, ComponentType<?>) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
Sets the default component to use for a given data type.
setLoaded(boolean) - Method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Flags this plugin as loaded or unloaded.
setName(String) - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
Sets the value of the property name.
setNumber(N) - Method in class edu.wpi.first.shuffleboard.api.components.AbstractNumberField
Sets the value of the property number.
setRunning(boolean) - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Sets the value of the property running.
setSkinType(Gauge.SkinType) - Method in class edu.wpi.first.shuffleboard.api.components.StyleableGauge
 
setSource(DataSource) - Method in class edu.wpi.first.shuffleboard.api.widget.SingleSourceWidget
Sets the value of the property source.
setSourceType(SourceType) - Method in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Sets the value of the property sourceType.
setStartTime(long) - Static method in class edu.wpi.first.shuffleboard.api.util.Time
Sets the start time of the current application run in epoch milliseconds.
setText(String) - Method in class edu.wpi.first.shuffleboard.api.components.EditableLabel
Sets the value of the property text.
setTitle(String) - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
Sets the value of the property title.
setTitle(String) - Method in interface edu.wpi.first.shuffleboard.api.widget.Component
Sets the value of the property title.
setValue(Object) - Method in class edu.wpi.first.shuffleboard.api.components.ExtendedPropertySheet.PropertyItem
 
setValue(double) - Method in class edu.wpi.first.shuffleboard.api.components.LinearIndicator
Sets the value of the property value.
setValue(T) - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
setValue(Boolean) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
setValue(Number) - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
shutdown() - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Shuts down the default instance.
shutdown(NetworkTableInstance) - Static method in class edu.wpi.first.shuffleboard.api.util.NetworkTableUtils
Shuts down the network table client or server, then clears all entries from network tables.
SimpleAdapter<T> - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
An adapter for simple data types (eg number, boolean) that always have a specific serialized size.
SimpleAdapter(DataType<T>, Function<T, byte[]>, BiFunction<byte[], Integer, T>, int) - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.SimpleAdapter
 
SimpleAnnotatedWidget<T> - Class in edu.wpi.first.shuffleboard.api.widget
 
SimpleAnnotatedWidget() - Constructor for class edu.wpi.first.shuffleboard.api.widget.SimpleAnnotatedWidget
 
SimpleColorCssMetaData<S extends javafx.css.Styleable> - Class in edu.wpi.first.shuffleboard.api.css
A convenience subclass of SimpleCssMetaData for color properties.
SimpleColorCssMetaData(String, Function<? super S, Property<Color>>) - Constructor for class edu.wpi.first.shuffleboard.api.css.SimpleColorCssMetaData
Creates a new simple color CSS metadata object.
SimpleCssMetaData<S extends javafx.css.Styleable,T> - Class in edu.wpi.first.shuffleboard.api.css
A simple implementation of CSS metadata that allows the property to be styled as long as it is not bound.
SimpleCssMetaData(String, StyleConverter<?, T>, Function<? super S, Property<T>>) - Constructor for class edu.wpi.first.shuffleboard.api.css.SimpleCssMetaData
Creates a new simple CSS metadata object.
SimpleDataType<T> - Class in edu.wpi.first.shuffleboard.api.data
Represents the type of simple data such as numbers or strings.
SimpleDataType(String, Class<T>) - Constructor for class edu.wpi.first.shuffleboard.api.data.SimpleDataType
 
SimpleStyleableObjectPropertyWrapper<T> - Class in edu.wpi.first.shuffleboard.api.properties
Wraps a normal JavaFX property in a styleable wrapper property.
SimpleStyleableObjectPropertyWrapper(CssMetaData<? extends Styleable, T>, Property<T>) - Constructor for class edu.wpi.first.shuffleboard.api.properties.SimpleStyleableObjectPropertyWrapper
Creates a new styleable property that wraps another.
SingleSourceWidget - Class in edu.wpi.first.shuffleboard.api.widget
A partial implementation of Widget that only has a single source.
SingleSourceWidget() - Constructor for class edu.wpi.first.shuffleboard.api.widget.SingleSourceWidget
 
SingleTypeWidget<T> - Interface in edu.wpi.first.shuffleboard.api.widget
 
SIZE_OF_BOOL - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
The size of a serialized boolean, in bytes.
SIZE_OF_BYTE - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
The size of a serialized byte, in bytes.
SIZE_OF_DOUBLE - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
The size of a serialized double, in bytes.
SIZE_OF_INT - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
The size of a serialized int, in bytes.
SIZE_OF_LONG - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
The size of a serialized short, in bytes.
SIZE_OF_SHORT - Static variable in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
The size of a serialized short, in bytes.
sizeOfStringArray(String[]) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Gets the size of a string array if it were encoded as a byte array with Serialization.toByteArray(String[]).
source - Static variable in class edu.wpi.first.shuffleboard.api.dnd.DataFormats
The data format for sources being dragged.
source - Variable in class edu.wpi.first.shuffleboard.api.widget.SingleSourceWidget
 
Sourced - Interface in edu.wpi.first.shuffleboard.api.widget
Common interface for objects that have data sources.
SourceEntry - Interface in edu.wpi.first.shuffleboard.api.sources
A representation of a source used for the drag-and-drop of sources, as well as previewing them in the application.
sourcePrefix(String) - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo.TabInfoBuilder
Sets the source prefix the built tab should use during autopopulation.
sourceProperty() - Method in class edu.wpi.first.shuffleboard.api.widget.SingleSourceWidget
 
Sources - Class in edu.wpi.first.shuffleboard.api.sources
Keeps track of all created data sources.
Sources() - Constructor for class edu.wpi.first.shuffleboard.api.sources.Sources
 
sources - Variable in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
 
SourceTreeTable<S extends SourceEntry,V> - Class in edu.wpi.first.shuffleboard.api.components
A tree table view or displaying hierarchical sources.
SourceTreeTable() - Constructor for class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Creates a new source tree table.
SourceType - Class in edu.wpi.first.shuffleboard.api.sources
Represents the type of a data source and where the data for that source comes from.
SourceType(String, boolean, String, Function<String, DataSource>) - Constructor for class edu.wpi.first.shuffleboard.api.sources.SourceType
Creates a new source type.
sourceTypeProperty() - Method in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
 
SourceTypes - Class in edu.wpi.first.shuffleboard.api.sources
 
SourceTypes() - Constructor for class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Creates a new source type registry.
start() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Starts recording data.
startTimeProperty() - Static method in class edu.wpi.first.shuffleboard.api.util.Time
 
Static - Static variable in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
 
stop() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recorder
Stops recording data.
Storage - Class in edu.wpi.first.shuffleboard.api.util
Utilities for local file storage.
String - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to text data.
StringAdapter - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
 
StringAdapter() - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringAdapter
 
StringArray - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
The type corresponding to an array of strings (String[]).
StringArrayAdapter - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
 
StringArrayAdapter() - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.StringArrayAdapter
 
StringArrayType - Class in edu.wpi.first.shuffleboard.api.data.types
 
StringType - Class in edu.wpi.first.shuffleboard.api.data.types
 
stripProtocol(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Tries to strip the protocol from a source URI.
StyleableGauge - Class in edu.wpi.first.shuffleboard.api.components
A subclass of Gauge that allows various UI properties to be styled with CSS.
StyleableGauge() - Constructor for class edu.wpi.first.shuffleboard.api.components.StyleableGauge
 
StyleableGauge(Gauge.SkinType) - Constructor for class edu.wpi.first.shuffleboard.api.components.StyleableGauge
 
subArray(byte[], int, int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Deprecated.
use Arrays.copyOfRange(byte[], int, int) instead
SubSource<T> - Class in edu.wpi.first.shuffleboard.api.sources
A type of source that provides a view of a subset of the data of another source, as well as propagating data changes to the original source.
SubSource(DataType<T>, DataSource<U>, Function<? super T, ? extends U>, Function<? super U, ? extends T>) - Constructor for class edu.wpi.first.shuffleboard.api.sources.SubSource
Creates a new sub source.
subtract(GridPoint) - Method in class edu.wpi.first.shuffleboard.api.util.GridPoint
Subtracts another grid point from this one.
supports(String) - Method in interface edu.wpi.first.shuffleboard.api.Populatable
Checks if the given data source is supported, ie it matches some criteria; for example, a widget that populates with data under a certain path should check if the source's ID starts with that path.

T

TabInfo - Class in edu.wpi.first.shuffleboard.api.tab
Represents a tab in the dashboard.
TabInfo(String, boolean, String) - Constructor for class edu.wpi.first.shuffleboard.api.tab.TabInfo
Creates a new TabInfo object.
TabInfo.TabInfoBuilder - Class in edu.wpi.first.shuffleboard.api.tab
 
TabInfoBuilder() - Constructor for class edu.wpi.first.shuffleboard.api.tab.TabInfo.TabInfoBuilder
 
TestUtils - Class in edu.wpi.first.shuffleboard.api.util
Utility class for making sure certain methods may only be called from tests.
textProperty() - Method in class edu.wpi.first.shuffleboard.api.components.EditableLabel
 
Theme - Class in edu.wpi.first.shuffleboard.api.theme
A theme is a way of stying the shuffleboard application.
Theme(String, String...) - Constructor for class edu.wpi.first.shuffleboard.api.theme.Theme
Creates a new theme with the given name and styled by the given style sheets.
Theme(Class<?>, String, String...) - Constructor for class edu.wpi.first.shuffleboard.api.theme.Theme
Creates a new theme with the given name and styled by the given style sheets.
Themes - Class in edu.wpi.first.shuffleboard.api.theme
Keeps track of the themes available to the application.
Themes(Theme...) - Constructor for class edu.wpi.first.shuffleboard.api.theme.Themes
Creates a new theme registry.
ThreadUtils - Class in edu.wpi.first.shuffleboard.api.util
Utilities dealing with threading.
ThrowingFunction<I,O,X extends java.lang.Throwable> - Interface in edu.wpi.first.shuffleboard.api.util
A version of Function that may throw a checked exception.
TileSize - Class in edu.wpi.first.shuffleboard.api.widget
Represents the size of a tile in a grid.
TileSize(int, int) - Constructor for class edu.wpi.first.shuffleboard.api.widget.TileSize
Creates a size with the given width and height.
Time - Class in edu.wpi.first.shuffleboard.api.util
Utility class for working with the current time.
TimestampedData - Class in edu.wpi.first.shuffleboard.api.sources.recording
Represents an immutable view of the value of a data source at a specific instant.
TimestampedData(String, DataType, Object, long) - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
Creates a new time stamped data object.
titleProperty() - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidget
 
titleProperty() - Method in interface edu.wpi.first.shuffleboard.api.widget.Component
Gets the label for this component.
toByteArray(boolean) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a boolean as a 1-byte array.
toByteArray(short) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a 16-bit int as a 2-byte big-endian byte array.
toByteArray(int) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a 32-bit int as a 4-byte big-endian byte array.
toByteArray(long) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a 64-bit int as an 8-byte big-endian byte array.
toByteArray(double) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a double-precision number as an 8-byte big-endian byte array.
toByteArray(String) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a string as a big-endian byte array.
toByteArray(String[]) - Static method in class edu.wpi.first.shuffleboard.api.sources.recording.Serialization
Encodes a string array as a big-endian byte array.
toHexString(Color) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
Converts a JavaFX color to a hex web string in the format #RRGGBBAA.
toMenuItems() - Method in class edu.wpi.first.shuffleboard.api.components.ActionList
Returns MenuItem view of the ActionList, with all items represented by either text items or sub-menus.
toString() - Method in class edu.wpi.first.shuffleboard.api.data.DataType
 
toString() - Method in class edu.wpi.first.shuffleboard.api.data.MapData
 
toString() - Method in class edu.wpi.first.shuffleboard.api.data.NamedData
 
toString() - Method in class edu.wpi.first.shuffleboard.api.sources.AbstractDataSource
 
toString() - Method in class edu.wpi.first.shuffleboard.api.sources.ConnectionStatus
 
toString() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.Recording
 
toString() - Method in class edu.wpi.first.shuffleboard.api.sources.recording.TimestampedData
 
toString() - Method in class edu.wpi.first.shuffleboard.api.tab.TabInfo
 
toString() - Method in class edu.wpi.first.shuffleboard.api.theme.Theme
 
toString() - Method in class edu.wpi.first.shuffleboard.api.util.GridPoint
 
toString(Number) - Method in class edu.wpi.first.shuffleboard.api.util.UnitStringConverter
 
toString() - Method in class edu.wpi.first.shuffleboard.api.util.Vector2D
 
toString() - Method in class edu.wpi.first.shuffleboard.api.widget.AbstractWidgetType
 
toString() - Method in class edu.wpi.first.shuffleboard.api.widget.TileSize
 
toUri(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceType
 
tryInstantiate(Class<T>) - Static method in class edu.wpi.first.shuffleboard.api.util.TypeUtils
Tries to create a new instance of T using a public no-arg ("default") constructor.
TypeAdapter<T> - Class in edu.wpi.first.shuffleboard.api.sources.recording.serialization
A TypeAdapter combines Serializer and Deserializer in one class for ease of use.
TypeAdapter(DataType<T>) - Constructor for class edu.wpi.first.shuffleboard.api.sources.recording.serialization.TypeAdapter
Creates a new adapter for the given data type.
typedSourceProperty() - Method in class edu.wpi.first.shuffleboard.api.widget.SimpleAnnotatedWidget
 
typeForUri(String) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Gets the source type associated with the given URI, or SourceTypes.None if the protocol is not recognized.
TypeUtils - Class in edu.wpi.first.shuffleboard.api.util
Utilities dealing with the type system.

U

UiHints - Annotation Type in edu.wpi.first.shuffleboard.api.sources
Marks a source type with hints for the UI.
unbind() - Method in class edu.wpi.first.shuffleboard.api.properties.AsyncProperty
 
unbind() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicBooleanProperty
 
unbind() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicIntegerProperty
 
unbind() - Method in class edu.wpi.first.shuffleboard.api.properties.AtomicPropertyListenerDelegate
Unbinds the atomic property.
UnitStringConverter - Class in edu.wpi.first.shuffleboard.api.util
A string converter that converts numbers to formatted unit strings.
UnitStringConverter(String) - Constructor for class edu.wpi.first.shuffleboard.api.util.UnitStringConverter
Creates a new converter that uses the given unit string.
Unknown - Static variable in class edu.wpi.first.shuffleboard.api.data.DataTypes
Represents an "unknown" data type; that is, data is present, but the type could not be determined.
UnknownType - Class in edu.wpi.first.shuffleboard.api.data.types
A catchall data type that is used when the type of data is unknown.
unregister(DataType) - Method in class edu.wpi.first.shuffleboard.api.data.DataTypes
 
unregister(DataSource) - Method in class edu.wpi.first.shuffleboard.api.sources.Sources
 
unregister(SourceType) - Method in class edu.wpi.first.shuffleboard.api.sources.SourceTypes
Unregisters an item from this registry.
unregister(Theme) - Method in class edu.wpi.first.shuffleboard.api.theme.Themes
 
unregister(T) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Unregisters an item from this registry.
unregister(ComponentType) - Method in class edu.wpi.first.shuffleboard.api.widget.Components
 
unregisterAll(T...) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Unregisters many items at once.
unregisterAll(Collection<? extends T>) - Method in class edu.wpi.first.shuffleboard.api.util.Registry
Unregisters many items at once.
UP - Static variable in interface edu.wpi.first.shuffleboard.api.util.RoundingMode
Rounds a fractional value down to the nearest integer less than or equal to the given value.
updateEntry(S) - Method in class edu.wpi.first.shuffleboard.api.components.SourceTreeTable
Updates a source entry in this tree table, creating branches as needed.

V

validateAnnotatedComponentClass(Class<T>) - Static method in class edu.wpi.first.shuffleboard.api.widget.Components
Validates a component class.
validatePluginClass(Class<? extends Plugin>) - Static method in class edu.wpi.first.shuffleboard.api.plugin.Plugin
Validates that a plugin class has valid description and dependency annotations.
valueOf(String) - Static method in enum edu.wpi.first.shuffleboard.api.DashboardMode
Returns the enum constant of this type with the specified name.
valueProperty() - Method in class edu.wpi.first.shuffleboard.api.components.LinearIndicator
 
values() - Static method in enum edu.wpi.first.shuffleboard.api.DashboardMode
Returns an array containing the constants of this enum type, in the order they are declared.
Vector2D - Class in edu.wpi.first.shuffleboard.api.util
A vector in 2-dimensional Cartesian space.
Vector2D(double, double) - Constructor for class edu.wpi.first.shuffleboard.api.util.Vector2D
Creates a vector from the origin to the point (x, y).
viewFor(Class<T>) - Static method in class edu.wpi.first.shuffleboard.api.widget.Components
Create an instance for a ParametrizedController annotated class.

W

when(Property<Boolean>) - Static method in class edu.wpi.first.shuffleboard.api.util.FxUtils
A more general version of Bindings.when(ObservableBooleanValue) that can accept general boolean properties as conditions.
Widget - Interface in edu.wpi.first.shuffleboard.api.widget
A widget is a UI element that displays data from data sources and has the ability to modify that data.
WidgetData(String, GridPoint) - Constructor for class edu.wpi.first.shuffleboard.api.dnd.DataFormats.WidgetData
Creates a new widget data object with the given ID and initial drag point.
widgetTile - Static variable in class edu.wpi.first.shuffleboard.api.dnd.DataFormats
The data format for widgets being dragged.
widgetType - Static variable in class edu.wpi.first.shuffleboard.api.dnd.DataFormats
The data format for widget type names (string).
WidgetType<W extends Widget> - Interface in edu.wpi.first.shuffleboard.api.widget
WidgetType extends ComponentType with Widget-specific metadata.
with(T) - Method in class edu.wpi.first.shuffleboard.api.util.ListUtils.Replacement
Replaces the elements in the list with the replacement one.
with(Supplier<? extends T>) - Method in class edu.wpi.first.shuffleboard.api.util.ListUtils.Replacement
Replaces the elements in the list with values given by the supplier.
withName(String) - Static method in class edu.wpi.first.shuffleboard.api.components.ActionList
Creates an empty action list with the given name.

X

x - Variable in class edu.wpi.first.shuffleboard.api.util.Vector2D
 

Y

y - Variable in class edu.wpi.first.shuffleboard.api.util.Vector2D
 
A B C D E F G H I J L M N O P R S T U V W X Y 
Skip navigation links