Package jmri.jmrix.ecos.swing.preferences

Class PreferencesPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrix.ecos.swing.preferences.PreferencesPane

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, JmriServiceProviderInterface, PreferencesPanel

public class PreferencesPane
extends JPanel
implements PropertyChangeListener, PreferencesPanel

Pane to show ECoS preferences

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
(package private) JComboBox<String>	_addLocoEcos
(package private) JComboBox<String>	_addLocoJmri
(package private) JComboBox<String>	_addTurnoutsEcos
(package private) JComboBox<String>	_addTurnoutsJmri
(package private) ButtonGroup	_adhocLocoEcos
(package private) JRadioButton	_adhocLocoEcosAsk
(package private) JRadioButton	_adhocLocoEcosLeave
(package private) JRadioButton	_adhocLocoEcosRemove
(package private) JTextField	_ecosAttSufText
(package private) JTextField	_ecosDescription
(package private) JRadioButton	_forceControlLocoEcosAlways
(package private) JRadioButton	_forceControlLocoEcosAsk
(package private) JRadioButton	_forceControlLocoEcosNever
(package private) ButtonGroup	_locoControl
(package private) JRadioButton	_locoControlForce
(package private) JRadioButton	_locoControlNormal
(package private) ButtonGroup	_locoEcosControl
(package private) JComboBox<String>	_masterControl
(package private) JCheckBox	_rememberAdhocLocosEcos
(package private) JComboBox<String>	_removeLocosEcos
(package private) JComboBox<String>	_removeLocosJmri
(package private) JComboBox<String>	_removeTurnoutsEcos
(package private) JComboBox<String>	_removeTurnoutsJmri
(package private) String[]	choiceTypes
(package private) EcosPreferences	ep
(package private) int[]	masterChoiceCode
(package private) int[]	masterControlCode
(package private) String[]	masterControlTypes	Options in the ECoS Sync prefs drop down.
(package private) int	numChoiceTypes
(package private) int	numTypes
(package private) JPanel	rostertabpanel
(package private) JPanel	throttletabpanel
(package private) JPanel	turnouttabpanel
(package private) boolean	updateButtonPressed

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
PreferencesPane(EcosPreferences epref)

Method Summary

Modifier and Type	Method	Description
String	getLabelKey()	Text displayed above the preferences panel This label is only displayed if the preferences panel is in a tabbed set of preferences.
JComponent	getPreferencesComponent()	Get the preferences component for display
String	getPreferencesItem()	Get the Preferences Item identifier.
String	getPreferencesItemText()	Get the text for the Preferences Item in the preferences window list of preferences categories.
String	getPreferencesTooltip()	The tooltip to display for a tabbed preferences panel
String	getTabbedPreferencesTitle()	Get the title for the tab containing this preferences item.
boolean	isDirty()	Indicate that preferences need to be saved.
boolean	isPersistant()	Indicates that this PrefernecesPanel should be stored across application starts by the PreferencesManager This should be true if the implementing class relies on the ConfigureManager stores and retrieves the preferences managed by the implementing class on behalf of the implementing class.
boolean	isPreferencesValid()	Indicate that the preferences are valid.
boolean	isRestartRequired()	Indicate that the preferences will not take effect until restarted.
void	propertyChange(PropertyChangeEvent e)
void	savePreferences()	Save any changes to preferences.
(package private) void	updateValues()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.swing.PreferencesPanel

getIsEnabled, getSortOrder

Field Details

throttletabpanel

JPanel throttletabpanel

rostertabpanel

JPanel rostertabpanel

turnouttabpanel

JPanel turnouttabpanel

_addTurnoutsEcos

JComboBox<String> _addTurnoutsEcos

_removeTurnoutsEcos

JComboBox<String> _removeTurnoutsEcos

_addTurnoutsJmri

JComboBox<String> _addTurnoutsJmri

_removeTurnoutsJmri

JComboBox<String> _removeTurnoutsJmri

_masterControl

JComboBox<String> _masterControl

_addLocoEcos

JComboBox<String> _addLocoEcos

_removeLocosEcos

JComboBox<String> _removeLocosEcos

_addLocoJmri

JComboBox<String> _addLocoJmri

_removeLocosJmri

JComboBox<String> _removeLocosJmri

_ecosAttSufText

JTextField _ecosAttSufText

_ecosDescription

JTextField _ecosDescription

_adhocLocoEcosAsk

JRadioButton _adhocLocoEcosAsk

_adhocLocoEcosLeave

JRadioButton _adhocLocoEcosLeave

_adhocLocoEcosRemove

JRadioButton _adhocLocoEcosRemove

_forceControlLocoEcosAsk

JRadioButton _forceControlLocoEcosAsk

_forceControlLocoEcosNever

JRadioButton _forceControlLocoEcosNever

_forceControlLocoEcosAlways

JRadioButton _forceControlLocoEcosAlways

_locoControlNormal

JRadioButton _locoControlNormal

_locoControlForce

JRadioButton _locoControlForce

_adhocLocoEcos

ButtonGroup _adhocLocoEcos

_locoEcosControl

ButtonGroup _locoEcosControl

_locoControl

ButtonGroup _locoControl

_rememberAdhocLocosEcos

JCheckBox _rememberAdhocLocosEcos

ep

EcosPreferences ep

updateButtonPressed

boolean updateButtonPressed

masterControlTypes

String[] masterControlTypes

Options in the ECoS Sync prefs drop down.

Keep masterControlTypes array identical to EcosPreferences.setLocoMaster(String)

masterControlCode

int[] masterControlCode

numTypes

int numTypes

choiceTypes

String[] choiceTypes

masterChoiceCode

int[] masterChoiceCode

numChoiceTypes

int numChoiceTypes

Constructor Details

PreferencesPane

public PreferencesPane(EcosPreferences epref)

Method Details

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

updateValues

void updateValues()

getPreferencesItem

public String getPreferencesItem()

Description copied from interface: PreferencesPanel

Get the Preferences Item identifier. Multiple PreferencePanels can be displayed as tabs in a single item. Preferences items are listed in the menu on the left of the preferences window.

Specified by:

getPreferencesItem in interface PreferencesPanel

Returns:

the preferences item identifier.

getPreferencesItemText

public String getPreferencesItemText()

Description copied from interface: PreferencesPanel

Get the text for the Preferences Item in the preferences window list of preferences categories. Multiple PreferencePanels can be displayed as tabs in a single item. Preferences items are listed in the menu on the left of the preferences window.

Specified by:

getPreferencesItemText in interface PreferencesPanel

Returns:

the text for the preferences item.

getTabbedPreferencesTitle

public String getTabbedPreferencesTitle()

Description copied from interface: PreferencesPanel

Get the title for the tab containing this preferences item.

Specified by:

getTabbedPreferencesTitle in interface PreferencesPanel

Returns:

a tab title

getLabelKey

public String getLabelKey()

Description copied from interface: PreferencesPanel

Text displayed above the preferences panel This label is only displayed if the preferences panel is in a tabbed set of preferences. This label can contain multiple lines.

Specified by:

getLabelKey in interface PreferencesPanel

Returns:

label text

getPreferencesComponent

public JComponent getPreferencesComponent()

Description copied from interface: PreferencesPanel

Get the preferences component for display

Specified by:

getPreferencesComponent in interface PreferencesPanel

Returns:

the preferences panel

isPersistant

public boolean isPersistant()

Description copied from interface: PreferencesPanel

Indicates that this PrefernecesPanel should be stored across application starts by the PreferencesManager This should be true if the implementing class relies on the ConfigureManager stores and retrieves the preferences managed by the implementing class on behalf of the implementing class.

Specified by:

isPersistant in interface PreferencesPanel

Returns:

false if the implementing class stores its own preferences

getPreferencesTooltip

public String getPreferencesTooltip()

Description copied from interface: PreferencesPanel

The tooltip to display for a tabbed preferences panel

Specified by:

getPreferencesTooltip in interface PreferencesPanel

Returns:

tooltip text

savePreferences

public void savePreferences()

Description copied from interface: PreferencesPanel

Save any changes to preferences. This method is called for every instance of a PreferencesPanel that is loaded by TabbedPreferences if PreferencesPanel.isPersistant() is false.

Specified by:

savePreferences in interface PreferencesPanel

isDirty

public boolean isDirty()

Description copied from interface: PreferencesPanel

Indicate that preferences need to be saved.

Specified by:

isDirty in interface PreferencesPanel

Returns:

true if preferences need to be saved, false otherwise

isRestartRequired

public boolean isRestartRequired()

Description copied from interface: PreferencesPanel

Indicate that the preferences will not take effect until restarted.

Specified by:

isRestartRequired in interface PreferencesPanel

Returns:

true if the application needs to restart

isPreferencesValid

public boolean isPreferencesValid()

Description copied from interface: PreferencesPanel

Indicate that the preferences are valid.

Specified by:

isPreferencesValid in interface PreferencesPanel

Returns:

true if the preferences are valid, false otherwise