Package jmri.util
Class HelpUtilPreferencesPanel
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- jmri.util.HelpUtilPreferencesPanel
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,JmriServiceProviderInterface
,PreferencesPanel
public class HelpUtilPreferencesPanel extends javax.swing.JPanel implements PreferencesPanel
Preferences panel for HelpUtil- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description (package private) javax.swing.ButtonGroup
_openHelpButtonGroup
(package private) javax.swing.JRadioButton
_openHelpOnFileRadioButton
(package private) javax.swing.JRadioButton
_openHelpOnJMRIWebServerRadioButton
(package private) javax.swing.JRadioButton
_openHelpOnlineRadioButton
-
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
-
-
Constructor Summary
Constructors Constructor Description HelpUtilPreferencesPanel()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getLabelKey()
Text displayed above the preferences panel This label is only displayed if the preferences panel is in a tabbed set of preferences.javax.swing.JComponent
getPreferencesComponent()
Get the preferences component for displayjava.lang.String
getPreferencesItem()
Get the Preferences Item identifier.java.lang.String
getPreferencesItemText()
Get the text for the Preferences Item in the preferences window list of preferences categories.java.lang.String
getPreferencesTooltip()
The tooltip to display for a tabbed preferences paneljava.lang.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 theConfigureManager
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.-
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 Detail
-
_openHelpOnFileRadioButton
javax.swing.JRadioButton _openHelpOnFileRadioButton
-
_openHelpOnlineRadioButton
javax.swing.JRadioButton _openHelpOnlineRadioButton
-
_openHelpOnJMRIWebServerRadioButton
javax.swing.JRadioButton _openHelpOnJMRIWebServerRadioButton
-
_openHelpButtonGroup
javax.swing.ButtonGroup _openHelpButtonGroup
-
-
Constructor Detail
-
HelpUtilPreferencesPanel
public HelpUtilPreferencesPanel()
-
-
Method Detail
-
getPreferencesItem
public java.lang.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 interfacePreferencesPanel
- Returns:
- the preferences item identifier.
-
getPreferencesItemText
public java.lang.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 interfacePreferencesPanel
- Returns:
- the text for the preferences item.
-
getTabbedPreferencesTitle
public java.lang.String getTabbedPreferencesTitle()
Description copied from interface:PreferencesPanel
Get the title for the tab containing this preferences item.- Specified by:
getTabbedPreferencesTitle
in interfacePreferencesPanel
- Returns:
- a tab title
-
getLabelKey
public java.lang.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 interfacePreferencesPanel
- Returns:
- label text
-
getPreferencesComponent
public javax.swing.JComponent getPreferencesComponent()
Description copied from interface:PreferencesPanel
Get the preferences component for display- Specified by:
getPreferencesComponent
in interfacePreferencesPanel
- 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 theConfigureManager
stores and retrieves the preferences managed by the implementing class on behalf of the implementing class.- Specified by:
isPersistant
in interfacePreferencesPanel
- Returns:
- false if the implementing class stores its own preferences
-
getPreferencesTooltip
public java.lang.String getPreferencesTooltip()
Description copied from interface:PreferencesPanel
The tooltip to display for a tabbed preferences panel- Specified by:
getPreferencesTooltip
in interfacePreferencesPanel
- 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 byTabbedPreferences
ifPreferencesPanel.isPersistant()
is false.- Specified by:
savePreferences
in interfacePreferencesPanel
-
isDirty
public boolean isDirty()
Description copied from interface:PreferencesPanel
Indicate that preferences need to be saved.- Specified by:
isDirty
in interfacePreferencesPanel
- 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 interfacePreferencesPanel
- 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 interfacePreferencesPanel
- Returns:
- true if the preferences are valid, false otherwise
-
-