gistoolkit.display.widgets
Class GISToolkitDialog

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended bygistoolkit.display.widgets.GISToolkitDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants
Direct Known Subclasses:
ColorDlg, DB2JoinDialog, DbaseFileJoinDialog, FindImageDialog, FontDlg, LayerPropertiesDialog, LegendDialog, MySQLJoinDialog, OracleJoinDialog, PostGISJoinDialog, ProjectionDialog, ScaleBarDialog, ShapeFileConverterDialog

public class GISToolkitDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener

Generic dialog to contain OK and Cancel Buttons.

This dialog allows the user to easilly create a dialog that contains controlls. The dialog contains both an OK, and Cancel button at the bottom right. The application can determine which button was selected by calling isOK() on the dialog after it has returned.

If you are in need of a dialog that checks the contents of it's controlls, for proper useage, you may wish to sub class this dialog. The dialog will call the doOK() when the OK button is selected by the user, but before the dialog is dismissed. If the doOK() method returns a value of tue, the dialog will be dismissed, and isOK() will subsequently be true. If on the other hand, the doOK() buton returns false, then no action is taken, the dialog is not disposed.

The same behavior is true of the doCancel() method with the exception that if it returns true, subsequent calls to the isOK() method return false.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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
GISToolkitDialog()
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Dialog owner)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Dialog owner, boolean modal)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Dialog owner, java.lang.String title)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Dialog owner, java.lang.String title, boolean modal)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Frame owner)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Frame owner, boolean modal)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Frame owner, java.lang.String title)
          GISToolkitDialog constructor comment.
GISToolkitDialog(java.awt.Frame owner, java.lang.String title, boolean modal)
          GISToolkitDialog constructor comment.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent inAE)
          Respond to the events from the OK and Cancel buttons.
protected  void centerDialog()
          center the dialog on the screen.
protected  boolean doCancel()
          Called when the Cancel button is selected.
protected  boolean doOK()
          Called when the OK button is selected.
 javax.swing.JButton getCancelButton()
          Returns the Cancel Button.
 java.awt.Container getContentPane()
          Return a reference to the Contents Panel.
 boolean getOK()
          Returns true if the OK button was selected.
 javax.swing.JButton getOKButton()
          Returns the OK Button.
 boolean isOK()
          Returns true if the OK button was selected.
static void main(java.lang.String[] args)
          Testing main entrypoint - starts the part when it is run as an application
protected  void resetSize()
          Setup the display properties of the panel.
 void setContentPane(java.awt.Container inComponent)
          Set the contentpane to the given component.
 void setOK(boolean inOK)
          Sets the determiner if the OK button was selected.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, 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
 

Constructor Detail

GISToolkitDialog

public GISToolkitDialog()
GISToolkitDialog constructor comment.


GISToolkitDialog

public GISToolkitDialog(java.awt.Dialog owner)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Dialog

GISToolkitDialog

public GISToolkitDialog(java.awt.Dialog owner,
                        java.lang.String title)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Dialog
title - java.lang.String

GISToolkitDialog

public GISToolkitDialog(java.awt.Dialog owner,
                        java.lang.String title,
                        boolean modal)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Dialog
title - java.lang.String
modal - boolean

GISToolkitDialog

public GISToolkitDialog(java.awt.Dialog owner,
                        boolean modal)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Dialog
modal - boolean

GISToolkitDialog

public GISToolkitDialog(java.awt.Frame owner)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Frame

GISToolkitDialog

public GISToolkitDialog(java.awt.Frame owner,
                        java.lang.String title)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Frame
title - java.lang.String

GISToolkitDialog

public GISToolkitDialog(java.awt.Frame owner,
                        java.lang.String title,
                        boolean modal)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Frame
title - java.lang.String
modal - boolean

GISToolkitDialog

public GISToolkitDialog(java.awt.Frame owner,
                        boolean modal)
GISToolkitDialog constructor comment.

Parameters:
owner - java.awt.Frame
modal - boolean
Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent inAE)
Respond to the events from the OK and Cancel buttons.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

doCancel

protected boolean doCancel()
Called when the Cancel button is selected. If a false is returned, the dialog will not be disposed.

The dialog will call the doCancel() when the Cancel button is selected by the user, but before the dialog is dismissed. If the doCancel() method returns a value of tue, the dialog will be dismissed, and isOK() will subsequently be false. If on the other hand, the doCancel() buton returns false, then no action is taken, the dialog is not disposed.


doOK

protected boolean doOK()
Called when the OK button is selected. If a false is returned, the dialog will not be disposed, and the OK flag will not be set to true.

If you are in need of a dialog that checks the contents of it's controlls, for proper useage, you may wish to sub class this dialog. The dialog will call the doOK() when the OK button is selected by the user, but before the dialog is dismissed. If the doOK() method returns a value of tue, the dialog will be dismissed, and isOK() will subsequently be true. If on the other hand, the doOK() buton returns false, then no action is taken, the dialog is not disposed.


getCancelButton

public javax.swing.JButton getCancelButton()
Returns the Cancel Button.

This allows the programmer to change the behavior, look, feel, and visibility of the cancel button if they wish. Perhaps they want a dialog with only an ok, then tempDialog.getCancelButton().setVisible(false), would be appropriate.


getContentPane

public java.awt.Container getContentPane()
Return a reference to the Contents Panel.

This method allows you to create your own container, and set it as the contents of the dialog. The ContentPane will take up all the space above the buttons.

Specified by:
getContentPane in interface javax.swing.RootPaneContainer

setContentPane

public void setContentPane(java.awt.Container inComponent)
Set the contentpane to the given component.

This method allows you to create your own container, and set it as the contents of the dialog. The ContentPane will take up all the space above the buttons.

Specified by:
setContentPane in interface javax.swing.RootPaneContainer

getOK

public boolean getOK()
Returns true if the OK button was selected.


getOKButton

public javax.swing.JButton getOKButton()
Returns the OK Button.

This allows the programmer to change the behavior, look, feel, and visibility of the OK button if they wish. Perhaps they want a dialog with a DO IT button, then tempDialog.getOKButton().setText("DO IT"), would be appropriate.


isOK

public boolean isOK()
Returns true if the OK button was selected.


resetSize

protected void resetSize()
Setup the display properties of the panel.


centerDialog

protected void centerDialog()
center the dialog on the screen.


setOK

public void setOK(boolean inOK)
Sets the determiner if the OK button was selected.


main

public static void main(java.lang.String[] args)
Testing main entrypoint - starts the part when it is run as an application