gov.sns.tools.apputils
Class PathPreferenceSelector

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--gov.sns.tools.apputils.PathPreferenceSelector
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, javax.swing.ScrollPaneConstants, java.io.Serializable, 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

Field Summary
protected  javax.swing.JButton browseButton
           
protected  gov.sns.tools.apputils.CustomChooser chooser
           
protected  javax.swing.JButton commitButton
           
protected  javax.swing.JTextArea pathField
           
protected  javax.swing.JButton revertButton
           
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
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
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
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 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, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

chooser

protected gov.sns.tools.apputils.CustomChooser chooser

pathField

protected javax.swing.JTextArea pathField

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.

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