Class PreferenceDialog
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- java.awt.Window
-
- java.awt.Dialog
-
- javax.swing.JDialog
-
- org.openstreetmap.josm.gui.preferences.PreferenceDialog
-
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,RootPaneContainer
,WindowConstants
public class PreferenceDialog extends JDialog
The main preferences dialog. Dialog window where the user can change various settings. Organized in main tabs to the left (TabPreferenceSetting
) and (optional) sub-pages (SubPreferenceSetting
).- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
PreferenceDialog.CancelAction
(package private) class
PreferenceDialog.OKAction
(package private) class
PreferenceDialog.WindowEventHandler
-
Nested classes/interfaces inherited from class javax.swing.JDialog
JDialog.AccessibleJDialog
-
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
-
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
-
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 private boolean
canceled
private ContextSensitiveHelpAction
helpAction
private static Pair<Class<? extends TabPreferenceSetting>,Class<? extends SubPreferenceSetting>>
previouslySelected
private PreferenceTabbedPane
tpPreferences
private PreferenceDialog.WindowEventHandler
windowEventHandler
-
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
-
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
-
Fields inherited from class java.awt.Component
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
-
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
-
Constructor Summary
Constructors Constructor Description PreferenceDialog(Component parent)
Constructs a newPreferenceDialog
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
build()
protected JPanel
buildActionPanel()
void
dispose()
PreferenceTabbedPane
getTabbedPane()
Replies the preferences tabbed pane.boolean
isCanceled()
Determines if preferences changes have been canceled.void
selectPreferencesTabByClass(Class<? extends TabPreferenceSetting> clazz)
Select preferences tab by class.void
selectPreferencesTabByName(String name)
Select preferences tab by name.void
selectPreviouslySelectedPreferences()
Select preferences tab that was selected previously.void
selectSubPreferencesTabByClass(Class<? extends SubPreferenceSetting> clazz)
Select preferences sub-tab by class.protected void
setCanceled(boolean canceled)
void
setHelpContext(String helpContext)
Sets the help context of the preferences dialog.void
setVisible(boolean visible)
-
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
-
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
-
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
tpPreferences
private final PreferenceTabbedPane tpPreferences
-
helpAction
private final ContextSensitiveHelpAction helpAction
-
windowEventHandler
private final PreferenceDialog.WindowEventHandler windowEventHandler
-
canceled
private boolean canceled
-
previouslySelected
private static Pair<Class<? extends TabPreferenceSetting>,Class<? extends SubPreferenceSetting>> previouslySelected
-
-
Constructor Detail
-
PreferenceDialog
public PreferenceDialog(Component parent)
Constructs a newPreferenceDialog
.- Parameters:
parent
- parent component
-
-
Method Detail
-
buildActionPanel
protected JPanel buildActionPanel()
-
build
protected final void build()
-
setHelpContext
public final void setHelpContext(String helpContext)
Sets the help context of the preferences dialog.- Parameters:
helpContext
- new help context- Since:
- 13431
-
getTabbedPane
public PreferenceTabbedPane getTabbedPane()
Replies the preferences tabbed pane.- Returns:
- The preferences tabbed pane, or null if the dialog is not yet initialized.
- Since:
- 5604
-
isCanceled
public boolean isCanceled()
Determines if preferences changes have been canceled.- Returns:
true
if preferences changes have been canceled
-
setCanceled
protected void setCanceled(boolean canceled)
-
setVisible
public void setVisible(boolean visible)
- Overrides:
setVisible
in classDialog
-
selectPreviouslySelectedPreferences
public void selectPreviouslySelectedPreferences()
Select preferences tab that was selected previously.
-
selectPreferencesTabByName
public void selectPreferencesTabByName(String name)
Select preferences tab by name.- Parameters:
name
- preferences tab name (icon)
-
selectPreferencesTabByClass
public void selectPreferencesTabByClass(Class<? extends TabPreferenceSetting> clazz)
Select preferences tab by class.- Parameters:
clazz
- preferences tab class
-
selectSubPreferencesTabByClass
public void selectSubPreferencesTabByClass(Class<? extends SubPreferenceSetting> clazz)
Select preferences sub-tab by class.- Parameters:
clazz
- preferences sub-tab class
-
-