upidiff.gui
Class OpenDialogGUI

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--upidiff.gui.OpenDialogGUI
All Implemented Interfaces:
Accessible, ActionListener, EventListener, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

public class OpenDialogGUI
extends JDialog
implements ActionListener

A dialog component to present the user with the possibility to choose two files.

Author:
bmeurer, kasbar
See Also:
Serialized Form

Field Summary
private  JButton cancelButton
           
private  boolean cancelled
          Indicates whether the operation was cancelled.
private  JTextField firstFileField
           
private  JCheckBox hiddenFilesCheckbox
           
private  JButton okButton
           
private  JButton openFirstButton
           
private  JButton openSecondButton
           
private  JTextField secondFileField
           
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
 
Fields inherited from class java.awt.Window
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
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
OpenDialogGUI(Frame owner)
          Creates a new instance.
 
Method Summary
 void actionPerformed(ActionEvent event)
          Handles an action event in the dialog component.
private  String chooseFile()
          Called once the user pressed an "Open" button.
 InputSource getFirstInputSource()
          Returns the first selected file.
 InputSource getSecondInputSource()
          Returns the second selected file.
private  GridBagConstraints makeGBC(int x, int y, int w, int h)
          Helper routine to create a GridBagConstraints.
 boolean run()
          Runs the OpenDialogGUI instances.
 
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

firstFileField

private JTextField firstFileField

secondFileField

private JTextField secondFileField

openFirstButton

private JButton openFirstButton

openSecondButton

private JButton openSecondButton

hiddenFilesCheckbox

private JCheckBox hiddenFilesCheckbox

okButton

private JButton okButton

cancelButton

private JButton cancelButton

cancelled

private boolean cancelled
Indicates whether the operation was cancelled.

Constructor Detail

OpenDialogGUI

public OpenDialogGUI(Frame owner)
Creates a new instance.

Parameters:
owner - Parent window component.
Method Detail

actionPerformed

public void actionPerformed(ActionEvent event)
Handles an action event in the dialog component.

Specified by:
actionPerformed in interface ActionListener
Parameters:
event - Action event description.

chooseFile

private String chooseFile()
Called once the user pressed an "Open" button.

Returns:
The absolute path to the selected file or null.

run

public boolean run()
Runs the OpenDialogGUI instances. The dialog component is made visible upon call to this method and is hidden and disposed before this call returns. If the user has selected two files and clicked the "Ok" button, then true is returned, else this method returns false.

Returns:
true, if the user selected two files and clicked "Ok", else false.
See Also:
getFirstInputSource(), getSecondInputSource()

getFirstInputSource

public InputSource getFirstInputSource()
                                throws InputException
Returns the first selected file.

Returns:
The input source for the first selected file.
Throws:
InputException - Failed to fill the input buffer.

getSecondInputSource

public InputSource getSecondInputSource()
                                 throws InputException
Returns the second selected file.

Returns:
The input source for the second selected file.
Throws:
InputException - Failed to fill the input buffer.

makeGBC

private GridBagConstraints makeGBC(int x,
                                   int y,
                                   int w,
                                   int h)
Helper routine to create a GridBagConstraints.

Parameters:
x - X offset.
y - Y offset.
w - Width.
h - Height.
Returns:
The newly created constraints.