edu.wpi.first.smartdashboard.gui

Class DashboardPrefs

java.lang.Object

edu.wpi.first.smartdashboard.gui.DashboardPrefs

All Implemented Interfaces:

PropertyHolder

public class DashboardPrefs
extends java.lang.Object
implements PropertyHolder

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
BooleanProperty	autoShowWidgets
FileProperty	csvFile
IntegerListProperty	grid_heights
IntegerListProperty	grid_widths
IntegerProperty	height
BooleanProperty	hideMenu
BooleanProperty	logToCSV
FileProperty	saveFile
IntegerProperty	team
IntegerProperty	width
IntegerProperty	x
IntegerProperty	y

Constructor Summary

Constructors

Constructor and Description
DashboardPrefs(DashboardFrame frame)

Method Summary

Methods

Modifier and Type	Method and Description
static DashboardPrefs	getInstance()
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.

Methods inherited from class java.lang.Object

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

Field Detail

team

public final IntegerProperty team

hideMenu

public final BooleanProperty hideMenu

autoShowWidgets

public final BooleanProperty autoShowWidgets

grid_widths

public final IntegerListProperty grid_widths

grid_heights

public final IntegerListProperty grid_heights

x

public final IntegerProperty x

y

public final IntegerProperty y

width

public final IntegerProperty width

height

public final IntegerProperty height

saveFile

public final FileProperty saveFile

logToCSV

public final BooleanProperty logToCSV

csvFile

public final FileProperty csvFile

Constructor Detail

DashboardPrefs

public DashboardPrefs(DashboardFrame frame)

Method Detail

getInstance

public static DashboardPrefs getInstance()

getProperties

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

Description copied from interface: PropertyHolder

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.

Specified by:

getProperties in interface PropertyHolder

Returns:

a map

validatePropertyChange

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

Description copied from interface: PropertyHolder

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

Specified by:

validatePropertyChange in interface PropertyHolder

Parameters:

property - the Property

value - the value to change it to

Returns:

whether or not the change should be allowed

propertyChanged

public void propertyChanged(Property property)

Description copied from interface: PropertyHolder

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

Specified by:

propertyChanged in interface PropertyHolder

Parameters:

property - the Property that changed