Package io.github.oblarg.oblog.annotations

Annotation Type Config.ToggleSwitch

  • @Repeatable(ToggleSwitches.class)
@Target({FIELD,METHOD,PARAMETER})
@Retention(RUNTIME)
public static @interface Config.ToggleSwitch
    Displays a boolean with a fixed-size toggle switch.
    Supported types:
    • Boolean

    This widget has no custom properties.

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The name of the value on Shuffleboard; defaults to field or method name.
        Default:
        "NO_NAME"

      • tabName

        java.lang.String tabName
        Returns:
        The name of the tab in which to place this widget, if the default inferred tab/layout is not desired. Users should be careful to avoid namespace collisions if the default tab is not used. Note that Log and config annotations can be repeated to place widgets on multiple tabs. Note also that this feature is NOT currently supported for NT-only mode!
        Default:
        "DEFAULT"

      • methodName

        java.lang.String methodName
        Returns:
        Optional name of a method to call on the field (or return value of the method) to obtain the actual setter that will be bound. Useful if one does not desire to make an entire object Loggable, but still wants to bind one of its setters.
        Default:
        "DEFAULT"

      • methodTypes

        java.lang.Class<?>[] methodTypes
        Returns:
        Parameter types of named method, if method name is provided.
        Default:
        {}

      • defaultValue

        boolean defaultValue
        Returns:
        The default value that the setter will return prior to manipulation on the dashboard.
        Default:
        false

      • rowIndex

        int rowIndex
        Returns:
        The row in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • columnIndex

        int columnIndex
        Returns:
        The column in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • width

        int width
        Returns:
        The width of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • height

        int height
        Returns:
        The height of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1