edu.wpi.first.smartdashboard.types

Class DisplayElementRegistry

java.lang.Object

edu.wpi.first.smartdashboard.types.DisplayElementRegistry

public class DisplayElementRegistry
extends java.lang.Object

This class contains several static methods that are used to dynamically link widgets to the types of data that they can display.

Author:

Joe Grinstead

Constructor Summary

Constructors

Constructor and Description
DisplayElementRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Set<java.lang.Class<? extends StaticWidget>>	getStaticWidgets() Returns all the StaticWidgets that are registered.
static java.util.Set<java.lang.Class<? extends Widget>>	getWidgetsForType(DataType type) Returns all the widgets which support a given type.
static void	registerStaticWidget(java.lang.Class<? extends StaticWidget> clazz) Adds the new StaticWidget to the registry.
static void	registerWidget(java.lang.Class<? extends Widget> clazz) Adds the new Widget to the registry.
static boolean	supportsType(java.lang.Class<? extends Widget> clazz, DataType type) Returns whether a Widget of the given class can handle an element of the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayElementRegistry

public DisplayElementRegistry()

Method Detail

registerStaticWidget

public static void registerStaticWidget(java.lang.Class<? extends StaticWidget> clazz)

Adds the new StaticWidget to the registry.

Parameters:

clazz - the class of the StaticWidget. If it is an abstract class, then it will be ignored.

registerWidget

public static void registerWidget(java.lang.Class<? extends Widget> clazz)

Adds the new Widget to the registry. There are plenty of requirements that a Widget must satisfy, because the DisplayElementRegistry relies heavily on reflection in order to simplify code for an extension developer. Make sure to look at what will cause a RuntimeException

Parameters:

clazz - the class of the Widget. If it is an abstract class, then it will be ignored.

Throws:

java.lang.RuntimeException - there are several ways that this will be thrown.

• If there is no TYPES field
• If the TYPES field is not static
• If the TYPES field is not final
• If the TYPES field is not public
• If the TYPES field is not an array of DataType
• If the TYPES field is null

getWidgetsForType

public static java.util.Set<java.lang.Class<? extends Widget>> getWidgetsForType(DataType type)

Returns all the widgets which support a given type.

Parameters:

type - the type to support

Returns:

the widgets which support the given type

getStaticWidgets

public static java.util.Set<java.lang.Class<? extends StaticWidget>> getStaticWidgets()

Returns all the StaticWidgets that are registered.

supportsType

public static boolean supportsType(java.lang.Class<? extends Widget> clazz,
                   DataType type)

Returns whether a Widget of the given class can handle an element of the given type.

Parameters:

clazz - the class of the Widget

type - the DataType that we are seeing if the Widget supports

Returns:

whether or not it is a supported type