xal.tools.apputils

Class PathPreferenceSelector

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

xal.tools.apputils.PathPreferenceSelector

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.ScrollPaneConstants, javax.swing.WindowConstants

public class PathPreferenceSelector
extends javax.swing.JDialog
implements javax.swing.ScrollPaneConstants

Dialog box for selecting a file path and saving it as the default URL spec in a preference. The dialog box presents the user with a field for entering the path or the option of browsing to the path. A button allows the user to make the path the default path. The default path is stored as a URL spec via a Preferences instance provided in the constructor.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JButton	browseButton
protected xal.tools.apputils.CustomChooser	chooser
protected javax.swing.JButton	commitButton
protected javax.swing.JButton	revertButton
protected javax.swing.JTextArea	urlField

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 javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PathPreferenceSelector(java.awt.Dialog owner, java.util.prefs.Preferences defaults, java.lang.String urlKey, java.lang.String suffix, java.lang.String description) Constructor
PathPreferenceSelector(java.awt.Frame owner, java.util.prefs.Preferences defaults, java.lang.String urlKey, java.lang.String suffix, java.lang.String description) Constructor
PathPreferenceSelector(java.util.prefs.Preferences defaults, java.lang.String urlKey, java.lang.String suffix, java.lang.String description) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	browsePath() Handle the browse button action
protected void	close() Hide and dispose of the dialog box.
protected void	commitChanges() Handle the commit button action
boolean	hasSavedChanges() Determines whether the user has actually committed changes.
boolean	hasUnsavedChanges() Determine if there are any unsaved changes
protected void	initComponents() initialize the view
protected void	revertPath() Handle the revert button action
protected void	setup(java.util.prefs.Preferences defaults, java.lang.String urlKey, java.lang.String suffix, java.lang.String description) Initialize the dialog box and the file chooser
protected void	textChanged(javax.swing.event.DocumentEvent event) Handle the text changed event by updating the view to reflect the present state.
protected void	updateView() Update the view to reflect the model

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, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

chooser

protected xal.tools.apputils.CustomChooser chooser

urlField

protected javax.swing.JTextArea urlField

browseButton

protected javax.swing.JButton browseButton

commitButton

protected javax.swing.JButton commitButton

revertButton

protected javax.swing.JButton revertButton

Constructor Detail

PathPreferenceSelector

public PathPreferenceSelector(java.util.prefs.Preferences defaults,
                              java.lang.String urlKey,
                              java.lang.String suffix,
                              java.lang.String description)

Constructor

Parameters:

defaults - The Preferences instance that stores the default URL spec of the path.

urlKey - The preference key used for associating the URL spec to store.

suffix - The suffix used to filter files in the file chooser.

description - The description used to label the files.

PathPreferenceSelector

public PathPreferenceSelector(java.awt.Frame owner,
                              java.util.prefs.Preferences defaults,
                              java.lang.String urlKey,
                              java.lang.String suffix,
                              java.lang.String description)

Constructor

Parameters:

owner - The frame which owns this dialog.

defaults - The Preferences instance that stores the default URL spec of the path.

urlKey - The preference key used for associating the URL spec to store.

suffix - The suffix used to filter files in the file chooser.

description - The description used to label the files.

PathPreferenceSelector

public PathPreferenceSelector(java.awt.Dialog owner,
                              java.util.prefs.Preferences defaults,
                              java.lang.String urlKey,
                              java.lang.String suffix,
                              java.lang.String description)

Constructor

Parameters:

owner - The dialog which owns this dialog.

defaults - The Preferences instance that stores the default URL spec of the path.

urlKey - The preference key used for associating the URL spec to store.

suffix - The suffix used to filter files in the file chooser.

description - The description used to label the files.

Method Detail

setup

protected void setup(java.util.prefs.Preferences defaults,
                     java.lang.String urlKey,
                     java.lang.String suffix,
                     java.lang.String description)

Initialize the dialog box and the file chooser

Parameters:

defaults - The Preferences instance that stores the default URL spec of the path.

urlKey - The preference key used for associating the URL spec to store.

suffix - The suffix used to filter files in the file chooser.

description - The description used to label the files.

initComponents

protected void initComponents()

initialize the view

browsePath

protected void browsePath()

Handle the browse button action

commitChanges

protected void commitChanges()

Handle the commit button action

revertPath

protected void revertPath()

Handle the revert button action

close

protected void close()

Hide and dispose of the dialog box.

textChanged

protected void textChanged(javax.swing.event.DocumentEvent event)

Handle the text changed event by updating the view to reflect the present state.

Parameters:

event - The document's "text changed" event.

hasSavedChanges

public boolean hasSavedChanges()

Determines whether the user has actually committed changes.

Returns:

true if the user has saved changes

hasUnsavedChanges

public boolean hasUnsavedChanges()

Determine if there are any unsaved changes

Returns:

true if there are unsaved changes and false if not.

updateView

protected void updateView()

Update the view to reflect the model