edu.wpi.first.smartdashboard.properties

Interface PropertyHolder

All Known Implementing Classes:

AbstractNumberDatasetWidget, AbstractTableWidget, AbstractValueWidget, BooleanBox, Button, CheckBox, Chooser, Command, CommandButton, Compass, ConnectionIndicator, DashboardPrefs, DigitalInputDisplay, DigitalOutputController, DisplayElement, EncoderDisplay, FormattedField, GyroDisplay, Image, Label, LinePlot, LWSubsystem, PIDEditor, ProgressBar, RelayController, RobotPreferences, Scheduler, ServoController, SimpleDial, SingleNumberDisplay, SpeedController, StaticWidget, Subsystem, TextBox, VideoStreamViewerExtension, Widget

public interface PropertyHolder

This interface defines methods that allow an object to use the standard property mechanism used in the SmartDashboard project. The system is designed to make the necessary coding for an extension developer quite small.

Author:

Joe Grinstead

See Also:

Property

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,Property>	getProperties() Returns a mapping between every property name and the corresponding property.
void	propertyChanged(Property property) This method will be called after the given Property's value has changed.
boolean	validatePropertyChange(Property property, java.lang.Object value) This method allows the PropertyHolder to veto whether or not the given Property should change to the given value.

Method Detail

getProperties

java.util.Map<java.lang.String,Property> getProperties()

Returns a mapping between every property name and the corresponding property. The map will be edited externally; it should not be a copy of the internal map.

Returns:

a map

validatePropertyChange

boolean validatePropertyChange(Property property,
                             java.lang.Object value)

This method allows the PropertyHolder to veto whether or not the given Property should change to the given value. It is called whenever setValue(...) is called.

It is called only when the value if the value is acceptable. In other words, it must not be null and it must correspond to the type of element that the Property accepts. So if the given Property is an IntegerProperty, then value will be a non-null Integer object.

Note that this method will not be called when a property receives its value from a save file

Parameters:

property - the Property

value - the value to change it to

Returns:

whether or not the change should be allowed

propertyChanged

void propertyChanged(Property property)

This method will be called after the given Property's value has changed.

Parameters:

property - the Property that changed