Package jmri.jmrit.beantable.usermessagepreferences

Class UserMessagePreferencesPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.JmriPanel

jmri.jmrit.beantable.usermessagepreferences.UserMessagePreferencesPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JmriServiceProviderInterface, PreferencesPanel

public class UserMessagePreferencesPane
extends JmriPanel
implements PreferencesPanel

Pane to show User Message Preferences.

Class based preferences are returned from JmriUserPreferencesManager. If a class has more than one possible message, it will have its own tab.

Classes with a single possible message will be in the Misc items tab. These are only shown when active.

The Misc items tab includes an option to show only tabs that have active messages. The normal tabs list is quite long.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	UserMessagePreferencesPane.ListItems

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) UserPreferencesManager	p
(package private) JTabbedPane	tab
(package private) boolean	updating

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
UserMessagePreferencesPane()

Method Summary

Modifier and Type	Method	Description
protected String	getClassName()
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	savePreferences()	Save any changes to preferences.
void	updateManager()

Methods inherited from class jmri.util.swing.JmriPanel

dispose, getHelpTarget, getMenus, getMinimumDimension, getTitle, getWindowInterface, initComponents, initContext, isMultipleInstances, setWindowInterface

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

p

UserPreferencesManager p

tab

JTabbedPane tab

updating

boolean updating

Constructor Details

UserMessagePreferencesPane

public UserMessagePreferencesPane()

Method Details

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

updateManager

public void updateManager()

getClassName

protected String getClassName()