Package jmri.jmrit.throttle.preferences

Class ThrottlesPreferences

java.lang.Object

jmri.jmrit.throttle.preferences.ThrottlesPreferences

All Implemented Interfaces:

InstanceManagerAutoDefault

public class ThrottlesPreferences
extends Object
implements InstanceManagerAutoDefault

A class to store JMRI throttles preferences.

A singleton instance is provided by a call to jmri.InstanceManager.getDefault(ThrottlesPreferences.class); or jmri.InstanceManager.getNullableDefault(ThrottlesPreferences.class);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ThrottlesPreferences.ThrottlesPrefsXml	An extension of the abstract XmlFile.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	dirty
static final String	prefPopertyName

Constructor Summary

Constructors

Constructor	Description
ThrottlesPreferences()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
org.jdom2.Element	getAdressPanelDefaultXML()	Get the default throttle address panel XML layout
org.jdom2.Element	getControlPanelDefaultXML()	Get the default throttle control panel XML layout
String	getDefaultThrottleFilePath()
org.jdom2.Element	getFunctionPanelDefaultXML()	Get the default throttle function panel XML layout
org.jdom2.Element	getThrottleFrameDefaultXML()
ThrottlesPreferencesWindowKeyboardControls	getThrottlesKeyboardControls()
Dimension	getWindowDimension()
boolean	isAddressSelectorShowingAllRosterGroup()
boolean	isAutoLoading()
boolean	isDirty()
boolean	isEnablingRosterSearch()
boolean	isHidingSpeedStepSelector()
boolean	isHidingUndefinedFuncButt()
boolean	isIgnoringThrottlePosition()
boolean	isResizingWindow()
boolean	isSavingThrottleOnLayoutSave()
boolean	isSilentShare()
boolean	isSilentSteal()
boolean	isUsingExThrottle()
boolean	isUsingFunctionIcon()	Check if function icons are in use.
boolean	isUsingLargeSpeedSlider()
boolean	isUsingRosterImage()
boolean	isUsingToolBar()
void	load(org.jdom2.Element e)
void	removePropertyChangeListener(PropertyChangeListener l)	Remove a PropertyChangeListener.
void	save()
void	set(ThrottlesPreferences tp)
void	setAddressSelectorShowingAllRosterGroup(boolean b)
void	setAutoLoad(boolean b)
void	setDefaultThrottleFilePath(String p)
void	setEnableRosterSearch(boolean b)
void	setHideSpeedStepSelector(boolean b)
void	setHideUndefinedFuncButt(boolean b)
void	setIgnoreThrottlePosition(boolean b)
void	setResizeWindow(boolean winImg)
void	setSaveThrottleOnLayoutSave(boolean b)
void	setSilentShare(boolean b)
void	setSilentSteal(boolean b)
void	setThrottlesKeyboardControls(ThrottlesPreferencesWindowKeyboardControls tpwkc)	Set the throttles keyboard controls preferences
void	setUseExThrottle(boolean exThrottle)
void	setUseLargeSpeedSlider(boolean b)
void	setUseRosterImage(boolean rosterImage)
void	setUsingFunctionIcon(boolean useFunctionIcon)
void	setUsingToolBar(boolean win4all)
void	setWindowDimension(Dimension d)
org.jdom2.Element	store()

Methods inherited from class java.lang.Object

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

Field Details

prefPopertyName

public static final String prefPopertyName

See Also:

• Constant Field Values

dirty

protected boolean dirty

Constructor Details

ThrottlesPreferences

public ThrottlesPreferences()

Method Details

load

public void load(org.jdom2.Element e)

isDirty

public boolean isDirty()

Returns:

true if preferences need to be saved

store

public org.jdom2.Element store()

set

public void set(ThrottlesPreferences tp)

save

public void save()

getWindowDimension

public Dimension getWindowDimension()

setWindowDimension

public void setWindowDimension(Dimension d)

isUsingExThrottle

public boolean isUsingExThrottle()

setUseExThrottle

public void setUseExThrottle(boolean exThrottle)

isUsingToolBar

public boolean isUsingToolBar()

setUsingToolBar

public void setUsingToolBar(boolean win4all)

isUsingFunctionIcon

public boolean isUsingFunctionIcon()

Check if function icons are in use.

Returns:

user preference to use function icons.

setUsingFunctionIcon

public void setUsingFunctionIcon(boolean useFunctionIcon)

isResizingWindow

public boolean isResizingWindow()

setResizeWindow

public void setResizeWindow(boolean winImg)

isUsingRosterImage

public boolean isUsingRosterImage()

setUseRosterImage

public void setUseRosterImage(boolean rosterImage)

isEnablingRosterSearch

public boolean isEnablingRosterSearch()

setEnableRosterSearch

public void setEnableRosterSearch(boolean b)

setAutoLoad

public void setAutoLoad(boolean b)

isAutoLoading

public boolean isAutoLoading()

setHideUndefinedFuncButt

public void setHideUndefinedFuncButt(boolean b)

isHidingUndefinedFuncButt

public boolean isHidingUndefinedFuncButt()

setIgnoreThrottlePosition

public void setIgnoreThrottlePosition(boolean b)

isIgnoringThrottlePosition

public boolean isIgnoringThrottlePosition()

setSaveThrottleOnLayoutSave

public void setSaveThrottleOnLayoutSave(boolean b)

isSavingThrottleOnLayoutSave

public boolean isSavingThrottleOnLayoutSave()

isSilentSteal

public boolean isSilentSteal()

isSilentShare

public boolean isSilentShare()

setSilentSteal

public void setSilentSteal(boolean b)

setSilentShare

public void setSilentShare(boolean b)

setUseLargeSpeedSlider

public void setUseLargeSpeedSlider(boolean b)

isUsingLargeSpeedSlider

public boolean isUsingLargeSpeedSlider()

setDefaultThrottleFilePath

public void setDefaultThrottleFilePath(String p)

getDefaultThrottleFilePath

public String getDefaultThrottleFilePath()

isHidingSpeedStepSelector

public boolean isHidingSpeedStepSelector()

setHideSpeedStepSelector

public void setHideSpeedStepSelector(boolean b)

isAddressSelectorShowingAllRosterGroup

public boolean isAddressSelectorShowingAllRosterGroup()

setAddressSelectorShowingAllRosterGroup

public void setAddressSelectorShowingAllRosterGroup(boolean b)

getThrottlesKeyboardControls

public ThrottlesPreferencesWindowKeyboardControls getThrottlesKeyboardControls()

Returns:

the throttles keyboard controls preferences

setThrottlesKeyboardControls

public void setThrottlesKeyboardControls(ThrottlesPreferencesWindowKeyboardControls tpwkc)

Set the throttles keyboard controls preferences

Parameters:

tpwkc - the new keyboard preferences

getAdressPanelDefaultXML

public org.jdom2.Element getAdressPanelDefaultXML()

Get the default throttle address panel XML layout

Returns:

the default address panel XML layout, null if none

getControlPanelDefaultXML

public org.jdom2.Element getControlPanelDefaultXML()

Get the default throttle control panel XML layout

Returns:

the default control panel XML layout, null if none

getFunctionPanelDefaultXML

public org.jdom2.Element getFunctionPanelDefaultXML()

Get the default throttle function panel XML layout

Returns:

the default function panel XML layout, null if none

getThrottleFrameDefaultXML

public org.jdom2.Element getThrottleFrameDefaultXML()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Add a PropertyChangeListener. AddressListeners are notified when the throtlle preferences are updated

Parameters:

l - listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Remove a PropertyChangeListener.

Parameters:

l - listener to remove.