org.geotoolkit.gui.swing
Class About

Object
  Component
      Container
          JComponent
              About

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Dialog

public class About
extends JComponent
implements Dialog

An "About" dialog box. This dialog box contains the application's title and some system informations (Java and OS version, free memory, image readers and writers, running threads, etc.). The application version can be fetched from a Manifest object, usually build from the META-INF/Manifest.mf file. This manifest should contains entries for Implementation-Title, Implementation-Version and Implementation-Vendor values, as suggested in the Java tutorial.

In addition to the above-cited standard entries, the About class understand also an optional Implementation-Date entry. This entry can contains the product date in the "yyyy-MM-dd HH:mm:ss" pattern. If presents, this date will be localized according user's locale and appended to the version number.

If none of the above information is available, then Version.GEOTOOLKIT is used.

Since:

2.0

Version:

3.12

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Module:

display/geotk-widgets-swing (download)

View source code for this class

Nested Class Summary

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

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 JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

About()
Constructs a new dialog box with the Geotk logo.

About(Object logo, Attributes attributes, ThreadGroup tasks)
Constructs a new dialog box from the specified manifest attributes.

About(Object logo, Class<?> application, ThreadGroup tasks)
Constructs a new dialog box for the specified application class.

Method Summary

void	commitEdit() Forces the current values to be taken from the editable fields and set them as the current values.
void	showDialog(Component owner) Popups the dialog box and waits for the user.
boolean	showDialog(Component owner, String title) Popups the dialog box and waits for the user.
protected void	start() Starts a daemon thread updating the information shown in this About widget.
protected void	stop() Frees any resources used by this dialog box.

Methods inherited from class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class Object

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

Constructor Detail

About

public About()

Constructs a new dialog box with the Geotk logo.

About

public About(Object logo,
             Class<?> application,
             ThreadGroup tasks)

Constructs a new dialog box for the specified application class. This constructor uses the class loader for loading the manifest file. It also uses the class package to find the right entry into the manifest.

Parameters:

logo - The application's logo. It may be a JComponent, an Icon object or an resource path (i.e. a file to be fetch in the classpath) as a String.

application - The application's class. Application name will be fetch from the manifest file (META-INF/Manifest.mf).

tasks - Group of running threads, or null if there is none.

About

public About(Object logo,
             Attributes attributes,
             ThreadGroup tasks)

Constructs a new dialog box from the specified manifest attributes.

Parameters:

logo - The application's logo. It may be a JComponent, an Icon object or an resource path (i.e. a file to be fetch in the classpath) as a String.

attributes - The manifest attributes containing application name and version number.

tasks - Group of running threads, or null if there is none.

Method Detail

commitEdit

public void commitEdit()
                throws ParseException

Forces the current values to be taken from the editable fields and set them as the current values. The default implementation does nothing since there is no editable fields in this widget.

Specified by:

commitEdit in interface Dialog

Throws:

ParseException - If at least one values couldn't be commited.

Since:

3.12

See Also:

JFormattedTextField.commitEdit(), JSpinner.commitEdit()

showDialog

public void showDialog(Component owner)

Popups the dialog box and waits for the user. This method always invoke start() before showing the dialog, and stop() after disposing it.

Parameters:

owner - The component which will be the owner of this component.

showDialog

public boolean showDialog(Component owner,
                          String title)

Popups the dialog box and waits for the user. This method always invoke start() before showing the dialog, and stop() after disposing it.

Specified by:

showDialog in interface Dialog

Parameters:

owner - The component which will be the owner of this component.

title - The title to write in the window bar.

Returns:

Always false for this component.

Since:

3.00

start

protected void start()

Starts a daemon thread updating the information shown in this About widget. Updated information include available memory and the list of running tasks. You must invoke the stop() method after start() (typically in a try ... finally construct) in order to free resources. stop() will not be automatically invoked by the garbage collector.

stop

protected void stop()

Frees any resources used by this dialog box. This method must be invoked after start() in order to free resources, since stop() is not invoked automatically by the garbage collector.