org.geotools.swing.dialog
Class JAboutDialog

Object
  extended by Component
      extended by Container
          extended by Window
              extended by Dialog
                  extended by JDialog
                      extended by AbstractSimpleDialog
                          extended by JAboutDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class JAboutDialog
extends AbstractSimpleDialog

An 'About' dialog which displays information about the host environment, software licenses pertaining to GeoTools (not implemented yet) and, if provided, summary details about your application.

Environment information is obtained from GeoTools.getEnvironmentInfo() and consists of:

The GeoTools jar listing is obtained from GeoTools.getGeoToolsJarInfo() and consists of GeoTools jars (of the active version) on the application's class path.

To have the dialog display details of your own application, you pass them as a String to the dialog constructor as in this example:


 final String appInfo = String.format(
           "GeoFoo: Map your foos in real time %nVersion 0.0.1");

 SwingUtilities.invokeLater(new Runnable() {
     @Override
     public void run() {
         JAboutDialog dialog = new JAboutDialog("About", appInfo);
         DialogUtils.showCentred(dialog);
     }
 });
 
When no application details are provided the 'Application' category will not be shown in the dialog's category list.

Since:
2.7
Author:
Michael Bedward
See Also:
Serialized Form

Nested Class Summary
static class JAboutDialog.Category
           
 
Nested classes/interfaces inherited from class JDialog
JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
 
Nested classes/interfaces inherited from class Window
Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class Dialog
DEFAULT_MODALITY_TYPE
 
Fields inherited from class Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
JAboutDialog()
          Creates a new dialog to display environment information but no application details.
JAboutDialog(String title)
          Creates a new dialog to display environment information but no application details.
JAboutDialog(String title, String applicationInfo)
          Creates a new dialog to display environment information together with application details.
 
Method Summary
protected  JPanel createButtonPanel()
          Creates the button panel with 'Done' and 'Copy to clipboard' buttons.
 JPanel createControlPanel()
          Implemented by the sub-class to provide a panel with controls.
 void onOK()
          Closes the dialog, disposing it.
 
Methods inherited from class AbstractSimpleDialog
closeDialog, initComponents, onCancel, setVisible
 
Methods inherited from class 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 Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack
 
Methods inherited from class Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront
 
Methods inherited from class 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JAboutDialog

public JAboutDialog()
Creates a new dialog to display environment information but no application details.


JAboutDialog

public JAboutDialog(String title)
Creates a new dialog to display environment information but no application details.

Parameters:
title - dialog title

JAboutDialog

public JAboutDialog(String title,
                    String applicationInfo)
Creates a new dialog to display environment information together with application details.

Parameters:
title - dialog title
applicationInfo - the application information to display
Method Detail

createControlPanel

public JPanel createControlPanel()
Implemented by the sub-class to provide a panel with controls.

Specified by:
createControlPanel in class AbstractSimpleDialog
Returns:
panel with controls

onOK

public void onOK()
Closes the dialog, disposing it.

Specified by:
onOK in class AbstractSimpleDialog

createButtonPanel

protected JPanel createButtonPanel()
Creates the button panel with 'Done' and 'Copy to clipboard' buttons.

Overrides:
createButtonPanel in class AbstractSimpleDialog
Returns:
the button panel


Copyright © 1996-2014 Geotools. All Rights Reserved.