eu.fthevenet.binjr.preferences

Class GlobalPreferences

java.lang.Object

eu.fthevenet.binjr.preferences.GlobalPreferences

public class GlobalPreferences
extends java.lang.Object

Stores the global user prefs for the application.

Author:

Frederic Thevenet

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	checkForUpdateOnStartUp
javafx.beans.property.BooleanProperty	ctrlPressed
javafx.beans.property.DoubleProperty	defaultGraphOpacity
javafx.beans.property.BooleanProperty	downSamplingEnabled Returns the down-sampling property
javafx.beans.property.IntegerProperty	downSamplingThreshold Returns the property for the series down-sampling threshold value
javafx.beans.property.BooleanProperty	horizontalMarkerOn
javafx.beans.property.BooleanProperty	loadLastWorkspaceOnStartup The loadLastWorkspaceOnStartup property
javafx.beans.property.BooleanProperty	loadPluginsFromExternalLocation
javafx.beans.property.Property<java.nio.file.Path>	mostRecentSavedWorkspace The mostRecentSavedWorkspace property
javafx.beans.property.Property<java.nio.file.Path>	mostRecentSaveFolder The mostRecentSaveFolder property
javafx.beans.property.Property<javafx.util.Duration>	notificationPopupDuration
javafx.beans.property.Property<java.nio.file.Path>	pluginsLocation
javafx.beans.property.BooleanProperty	shiftPressed
javafx.beans.property.BooleanProperty	showAreaOutline
javafx.beans.property.Property<UserInterfaceThemes>	userInterfaceTheme The UI theme property
javafx.beans.property.BooleanProperty	verticalMarkerOn

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	checkForUpdateOnStartUpProperty()
javafx.beans.property.BooleanProperty	ctrlPressedProperty()
javafx.beans.property.DoubleProperty	defaultGraphOpacityProperty()
javafx.beans.property.BooleanProperty	downSamplingEnabledProperty() Returns the down-sampling property
javafx.beans.property.IntegerProperty	downSamplingThresholdProperty() Returns the property for the series down-sampling threshold value
double	getDefaultGraphOpacity() Gets the value of the property defaultGraphOpacity.
java.lang.Boolean	getDownSamplingEnabled() Returns true if series down-sampling is enabled, false otherwise.
int	getDownSamplingThreshold() Returns the series down-sampling threshold value
boolean	getHorizontalMarkerOn() Gets the value of the property horizontalMarkerOn.
static GlobalPreferences	getInstance() Returns the singleton instance of GlobalPreferences
java.util.Optional<java.nio.file.Path>	getMostRecentSavedWorkspace() Gets the path from the most recently saved workspace
java.nio.file.Path	getMostRecentSaveFolder() Gets the path of the folder of the most recently saved item
javafx.util.Duration	getNotificationPopupDuration() Gets the value of the property notificationPopupDuration.
java.nio.file.Path	getPluginsLocation() Gets the value of the property pluginsLocation.
java.util.Collection<java.lang.String>	getRecentFiles() Gets the list of recently opened files
UserInterfaceThemes	getUserInterfaceTheme() Gets the current UI theme
boolean	getVerticalMarkerOn() Gets the value of the property verticalMarkerOn.
javafx.beans.property.BooleanProperty	horizontalMarkerOnProperty()
boolean	isCheckForUpdateOnStartUp() Gets the value of the property checkForUpdateOnStartUp.
java.lang.Boolean	isCtrlPressed() Gets the value of the property ctrlPressed.
boolean	isLoadLastWorkspaceOnStartup() Returns true if the most recently saved workspace should be re-opned on startup, false otherwise
boolean	isLoadPluginsFromExternalLocation() Gets the value of the property loadPluginsFromExternalLocation.
java.lang.Boolean	isShiftPressed() Gets the value of the property shiftPressed.
boolean	isShowAreaOutline() Gets the value of the property showAreaOutline.
javafx.beans.property.BooleanProperty	loadLastWorkspaceOnStartupProperty() The loadLastWorkspaceOnStartup property
javafx.beans.property.BooleanProperty	loadPluginsFromExternalLocationProperty()
javafx.beans.property.Property<java.nio.file.Path>	mostRecentSavedWorkspaceProperty() The mostRecentSavedWorkspace property
javafx.beans.property.Property<java.nio.file.Path>	mostRecentSaveFolderProperty() The mostRecentSaveFolder property
javafx.beans.property.Property<javafx.util.Duration>	notificationPopupDurationProperty()
javafx.beans.property.Property<java.nio.file.Path>	pluginsLocationProperty()
void	putToRecentFiles(java.lang.String value) Puts a path into the list of recently opened files
void	removeFromRecentFiles(java.lang.String value) Remove a path from the list of recently opened files
void	reset() Reset all prefs to their default values
void	setCheckForUpdateOnStartUp(boolean checkForUpdateOnStartUp) Sets the value of the property checkForUpdateOnStartUp.
void	setCtrlPressed(java.lang.Boolean ctrlPressed) Sets the value of the property ctrlPressed.
void	setDefaultGraphOpacity(double defaultGraphOpacity) Sets the value of the property defaultGraphOpacity.
void	setDownSamplingEnabled(boolean downSamplingEnabled) Enables or disables series down-sampling
void	setDownSamplingThreshold(int downSamplingThreshold) Sets the series down-sampling threshold value
void	setHorizontalMarkerOn(boolean horizontalMarkerOn) Sets the value of the property horizontalMarkerOn.
void	setLoadLastWorkspaceOnStartup(boolean loadLastWorkspaceOnStartup) Sets to true if the most recently saved workspace should be re-opned on startup, false otherwise
void	setLoadPluginsFromExternalLocation(boolean loadPluginsFromExternalLocation) Sets the value of the property loadPluginsFromExternalLocation.
void	setMostRecentSavedWorkspace(java.nio.file.Path mostRecentSavedWorkspace) Sets the path from the most recently saved workspace
void	setMostRecentSaveFolder(java.nio.file.Path mostRecentSaveFolder) Sets the path of the folder of the most recently saved item
void	setNotificationPopupDuration(javafx.util.Duration notificationPopupDuration) Sets the value of the property notificationPopupDuration.
void	setPluginsLocation(java.nio.file.Path pluginsLocation) Sets the value of the property pluginsLocation.
void	setShiftPressed(java.lang.Boolean shiftPressed) Sets the value of the property shiftPressed.
void	setShowAreaOutline(boolean showAreaOutline) Sets the value of the property showAreaOutline.
void	setUserInterfaceTheme(UserInterfaceThemes userInterfaceTheme) Sets the UI theme
void	setVerticalMarkerOn(boolean verticalMarkerOn) Sets the value of the property verticalMarkerOn.
javafx.beans.property.BooleanProperty	shiftPressedProperty()
javafx.beans.property.BooleanProperty	showAreaOutlineProperty()
javafx.beans.property.Property<UserInterfaceThemes>	userInterfaceThemeProperty() The UI theme property
javafx.beans.property.BooleanProperty	verticalMarkerOnProperty()

Methods inherited from class java.lang.Object

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

Property Detail

downSamplingEnabled

public javafx.beans.property.BooleanProperty downSamplingEnabledProperty

Returns the down-sampling property

See Also:

getDownSamplingEnabled(), setDownSamplingEnabled(boolean)

downSamplingThreshold

public javafx.beans.property.IntegerProperty downSamplingThresholdProperty

Returns the property for the series down-sampling threshold value

See Also:

getDownSamplingThreshold(), setDownSamplingThreshold(int)

mostRecentSaveFolder

public javafx.beans.property.Property<java.nio.file.Path> mostRecentSaveFolderProperty

The mostRecentSaveFolder property

See Also:

getMostRecentSaveFolder(), setMostRecentSaveFolder(Path)

mostRecentSavedWorkspace

public javafx.beans.property.Property<java.nio.file.Path> mostRecentSavedWorkspaceProperty

The mostRecentSavedWorkspace property

See Also:

getMostRecentSavedWorkspace(), setMostRecentSavedWorkspace(Path)

loadLastWorkspaceOnStartup

public javafx.beans.property.BooleanProperty loadLastWorkspaceOnStartupProperty

The loadLastWorkspaceOnStartup property

See Also:

isLoadLastWorkspaceOnStartup(), setLoadLastWorkspaceOnStartup(boolean)

userInterfaceTheme

public javafx.beans.property.Property<UserInterfaceThemes> userInterfaceThemeProperty

The UI theme property

See Also:

getUserInterfaceTheme(), setUserInterfaceTheme(UserInterfaceThemes)

checkForUpdateOnStartUp

public javafx.beans.property.BooleanProperty checkForUpdateOnStartUpProperty

See Also:

isCheckForUpdateOnStartUp(), setCheckForUpdateOnStartUp(boolean)

horizontalMarkerOn

public javafx.beans.property.BooleanProperty horizontalMarkerOnProperty

See Also:

getHorizontalMarkerOn(), setHorizontalMarkerOn(boolean)

verticalMarkerOn

public javafx.beans.property.BooleanProperty verticalMarkerOnProperty

See Also:

getVerticalMarkerOn(), setVerticalMarkerOn(boolean)

showAreaOutline

public javafx.beans.property.BooleanProperty showAreaOutlineProperty

See Also:

isShowAreaOutline(), setShowAreaOutline(boolean)

defaultGraphOpacity

public javafx.beans.property.DoubleProperty defaultGraphOpacityProperty

See Also:

getDefaultGraphOpacity(), setDefaultGraphOpacity(double)

shiftPressed

public javafx.beans.property.BooleanProperty shiftPressedProperty

See Also:

isShiftPressed(), setShiftPressed(Boolean)

ctrlPressed

public javafx.beans.property.BooleanProperty ctrlPressedProperty

See Also:

isCtrlPressed(), setCtrlPressed(Boolean)

pluginsLocation

public javafx.beans.property.Property<java.nio.file.Path> pluginsLocationProperty

See Also:

getPluginsLocation(), setPluginsLocation(Path)

notificationPopupDuration

public javafx.beans.property.Property<javafx.util.Duration> notificationPopupDurationProperty

See Also:

getNotificationPopupDuration(), setNotificationPopupDuration(Duration)

loadPluginsFromExternalLocation

public javafx.beans.property.BooleanProperty loadPluginsFromExternalLocationProperty

See Also:

isLoadPluginsFromExternalLocation(), setLoadPluginsFromExternalLocation(boolean)

Method Detail

reset

public void reset()
           throws java.util.prefs.BackingStoreException

Reset all prefs to their default values

Throws:

java.util.prefs.BackingStoreException - if an error occurred while trying to clear the prefs backing store.

getInstance

public static GlobalPreferences getInstance()

Returns the singleton instance of GlobalPreferences

Returns:

the singleton instance of GlobalPreferences

getDownSamplingEnabled

public java.lang.Boolean getDownSamplingEnabled()

Returns true if series down-sampling is enabled, false otherwise.

Returns:

true if series down-sampling is enabled, false otherwise.

downSamplingEnabledProperty

public javafx.beans.property.BooleanProperty downSamplingEnabledProperty()

Returns the down-sampling property

See Also:

getDownSamplingEnabled(), setDownSamplingEnabled(boolean)

setDownSamplingEnabled

public void setDownSamplingEnabled(boolean downSamplingEnabled)

Enables or disables series down-sampling

Parameters:

downSamplingEnabled - true to enable series down-sampling, false otherwise.

getDownSamplingThreshold

public int getDownSamplingThreshold()

Returns the series down-sampling threshold value

Returns:

the series down-sampling threshold value

downSamplingThresholdProperty

public javafx.beans.property.IntegerProperty downSamplingThresholdProperty()

Returns the property for the series down-sampling threshold value

See Also:

getDownSamplingThreshold(), setDownSamplingThreshold(int)

setDownSamplingThreshold

public void setDownSamplingThreshold(int downSamplingThreshold)

Sets the series down-sampling threshold value

Parameters:

downSamplingThreshold - the series down-sampling threshold value

getMostRecentSaveFolder

public java.nio.file.Path getMostRecentSaveFolder()

Gets the path of the folder of the most recently saved item

Returns:

the path of the folder of the most recently saved item

mostRecentSaveFolderProperty

public javafx.beans.property.Property<java.nio.file.Path> mostRecentSaveFolderProperty()

The mostRecentSaveFolder property

See Also:

getMostRecentSaveFolder(), setMostRecentSaveFolder(Path)

setMostRecentSaveFolder

public void setMostRecentSaveFolder(java.nio.file.Path mostRecentSaveFolder)

Sets the path of the folder of the most recently saved item

Parameters:

mostRecentSaveFolder - the path of the folder of the most recently saved item

getMostRecentSavedWorkspace

public java.util.Optional<java.nio.file.Path> getMostRecentSavedWorkspace()

Gets the path from the most recently saved workspace

Returns:

the path from the most recently saved workspace

mostRecentSavedWorkspaceProperty

public javafx.beans.property.Property<java.nio.file.Path> mostRecentSavedWorkspaceProperty()

The mostRecentSavedWorkspace property

See Also:

getMostRecentSavedWorkspace(), setMostRecentSavedWorkspace(Path)

setMostRecentSavedWorkspace

public void setMostRecentSavedWorkspace(java.nio.file.Path mostRecentSavedWorkspace)

Sets the path from the most recently saved workspace

Parameters:

mostRecentSavedWorkspace - the path from the most recently saved workspace

isLoadLastWorkspaceOnStartup

public boolean isLoadLastWorkspaceOnStartup()

Returns true if the most recently saved workspace should be re-opned on startup, false otherwise

Returns:

true if the most recently saved workspace should be re-opned on startup, false otherwise

loadLastWorkspaceOnStartupProperty

public javafx.beans.property.BooleanProperty loadLastWorkspaceOnStartupProperty()

The loadLastWorkspaceOnStartup property

See Also:

isLoadLastWorkspaceOnStartup(), setLoadLastWorkspaceOnStartup(boolean)

setLoadLastWorkspaceOnStartup

public void setLoadLastWorkspaceOnStartup(boolean loadLastWorkspaceOnStartup)

Sets to true if the most recently saved workspace should be re-opned on startup, false otherwise

Parameters:

loadLastWorkspaceOnStartup - true if the most recently saved workspace should be re-opned on startup, false otherwise

getUserInterfaceTheme

public UserInterfaceThemes getUserInterfaceTheme()

Gets the current UI theme

Returns:

the current UI theme

userInterfaceThemeProperty

public javafx.beans.property.Property<UserInterfaceThemes> userInterfaceThemeProperty()

The UI theme property

See Also:

getUserInterfaceTheme(), setUserInterfaceTheme(UserInterfaceThemes)

setUserInterfaceTheme

public void setUserInterfaceTheme(UserInterfaceThemes userInterfaceTheme)

Sets the UI theme

Parameters:

userInterfaceTheme - the UI theme to apply

removeFromRecentFiles

public void removeFromRecentFiles(java.lang.String value)

Remove a path from the list of recently opened files

Parameters:

value - a path to remove from the list of recently opened files

putToRecentFiles

public void putToRecentFiles(java.lang.String value)

Puts a path into the list of recently opened files

Parameters:

value - a path to put into the list of recently opened files

getRecentFiles

public java.util.Collection<java.lang.String> getRecentFiles()

Gets the list of recently opened files

Returns:

the list of recently opened files

isCheckForUpdateOnStartUp

public boolean isCheckForUpdateOnStartUp()

Gets the value of the property checkForUpdateOnStartUp.

checkForUpdateOnStartUpProperty

public javafx.beans.property.BooleanProperty checkForUpdateOnStartUpProperty()

See Also:

isCheckForUpdateOnStartUp(), setCheckForUpdateOnStartUp(boolean)

setCheckForUpdateOnStartUp

public void setCheckForUpdateOnStartUp(boolean checkForUpdateOnStartUp)

Sets the value of the property checkForUpdateOnStartUp.

getHorizontalMarkerOn

public boolean getHorizontalMarkerOn()

Gets the value of the property horizontalMarkerOn.

horizontalMarkerOnProperty

public javafx.beans.property.BooleanProperty horizontalMarkerOnProperty()

See Also:

getHorizontalMarkerOn(), setHorizontalMarkerOn(boolean)

setHorizontalMarkerOn

public void setHorizontalMarkerOn(boolean horizontalMarkerOn)

Sets the value of the property horizontalMarkerOn.

getVerticalMarkerOn

public boolean getVerticalMarkerOn()

Gets the value of the property verticalMarkerOn.

verticalMarkerOnProperty

public javafx.beans.property.BooleanProperty verticalMarkerOnProperty()

See Also:

getVerticalMarkerOn(), setVerticalMarkerOn(boolean)

setVerticalMarkerOn

public void setVerticalMarkerOn(boolean verticalMarkerOn)

Sets the value of the property verticalMarkerOn.

isShowAreaOutline

public boolean isShowAreaOutline()

Gets the value of the property showAreaOutline.

showAreaOutlineProperty

public javafx.beans.property.BooleanProperty showAreaOutlineProperty()

See Also:

isShowAreaOutline(), setShowAreaOutline(boolean)

setShowAreaOutline

public void setShowAreaOutline(boolean showAreaOutline)

Sets the value of the property showAreaOutline.

getDefaultGraphOpacity

public double getDefaultGraphOpacity()

Gets the value of the property defaultGraphOpacity.

defaultGraphOpacityProperty

public javafx.beans.property.DoubleProperty defaultGraphOpacityProperty()

See Also:

getDefaultGraphOpacity(), setDefaultGraphOpacity(double)

setDefaultGraphOpacity

public void setDefaultGraphOpacity(double defaultGraphOpacity)

Sets the value of the property defaultGraphOpacity.

isShiftPressed

public java.lang.Boolean isShiftPressed()

Gets the value of the property shiftPressed.

setShiftPressed

public void setShiftPressed(java.lang.Boolean shiftPressed)

Sets the value of the property shiftPressed.

shiftPressedProperty

public javafx.beans.property.BooleanProperty shiftPressedProperty()

See Also:

isShiftPressed(), setShiftPressed(Boolean)

isCtrlPressed

public java.lang.Boolean isCtrlPressed()

Gets the value of the property ctrlPressed.

setCtrlPressed

public void setCtrlPressed(java.lang.Boolean ctrlPressed)

Sets the value of the property ctrlPressed.

ctrlPressedProperty

public javafx.beans.property.BooleanProperty ctrlPressedProperty()

See Also:

isCtrlPressed(), setCtrlPressed(Boolean)

getPluginsLocation

public java.nio.file.Path getPluginsLocation()

Gets the value of the property pluginsLocation.

setPluginsLocation

public void setPluginsLocation(java.nio.file.Path pluginsLocation)

Sets the value of the property pluginsLocation.

pluginsLocationProperty

public javafx.beans.property.Property<java.nio.file.Path> pluginsLocationProperty()

See Also:

getPluginsLocation(), setPluginsLocation(Path)

getNotificationPopupDuration

public javafx.util.Duration getNotificationPopupDuration()

Gets the value of the property notificationPopupDuration.

notificationPopupDurationProperty

public javafx.beans.property.Property<javafx.util.Duration> notificationPopupDurationProperty()

See Also:

getNotificationPopupDuration(), setNotificationPopupDuration(Duration)

setNotificationPopupDuration

public void setNotificationPopupDuration(javafx.util.Duration notificationPopupDuration)

Sets the value of the property notificationPopupDuration.

isLoadPluginsFromExternalLocation

public boolean isLoadPluginsFromExternalLocation()

Gets the value of the property loadPluginsFromExternalLocation.

loadPluginsFromExternalLocationProperty

public javafx.beans.property.BooleanProperty loadPluginsFromExternalLocationProperty()

See Also:

isLoadPluginsFromExternalLocation(), setLoadPluginsFromExternalLocation(boolean)

setLoadPluginsFromExternalLocation

public void setLoadPluginsFromExternalLocation(boolean loadPluginsFromExternalLocation)

Sets the value of the property loadPluginsFromExternalLocation.