org.geotools.gui.swing
Class FormatChooser

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.geotools.gui.swing.FormatChooser

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class FormatChooser

extends javax.swing.JPanel

Select the pattern to use for formating numbers, angles or dates. This widget can be used with one of Format objects working with pattern, like DecimalFormat, SimpleDateFormat or AngleFormat.

Since:

2.0

Version:

$Id: FormatChooser.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

protected java.text.Format

format The format to configure by this .

Fields inherited from class javax.swing.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 java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

FormatChooser(java.text.Format format)
Constructs a pattern chooser for the given format.

Method Summary

java.text.Format	getFormat() Returns the current format.
java.lang.String	getPattern() Returns the localized pattern for the current format.
java.lang.Object	getSampleValue() Returns the sample value to format as a "preview" text.
static void	main(java.lang.String[] args) Show this component.
void	setFormat(java.text.Format format) Set the format to configure.
void	setPattern(java.lang.String pattern) Sets the localized pattern for the current format.
void	setSampleValue(java.lang.Object value) Sets the sample value to format as a "preview" text.
boolean	showDialog(java.awt.Component owner, java.lang.String title) Shows a dialog box requesting input from the user.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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 java.lang.Object

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

Field Detail

format

protected java.text.Format format

The format to configure by this .

Constructor Detail

FormatChooser

public FormatChooser(java.text.Format format)
              throws java.lang.IllegalArgumentException

Constructs a pattern chooser for the given format.

Parameters:

format - The format to configure. The default implementation accept instance of DecimalFormat, SimpleDateFormat or AngleFormat.

Throws:

java.lang.IllegalArgumentException - if the format is invalid.

Method Detail

getFormat

public java.text.Format getFormat()

Returns the current format.

setFormat

public void setFormat(java.text.Format format)
               throws java.lang.IllegalArgumentException

Set the format to configure. The default implementation accept instance of DecimalFormat, SimpleDateFormat or AngleFormat. If more format class are wanted, methods getPattern() and setPattern(java.lang.String) should be overriden.

Parameters:

format - The format to congifure.

Throws:

java.lang.IllegalArgumentException - if the format is invalid.

getSampleValue

public java.lang.Object getSampleValue()

Returns the sample value to format as a "preview" text. If no such object is defined, then this method returns .

setSampleValue

public void setSampleValue(java.lang.Object value)
                    throws java.lang.IllegalArgumentException

Sets the sample value to format as a "preview" text. The value should be an object formatable with getFormat().

Parameters:

value - The value to format, or .

Throws:

java.lang.IllegalArgumentException - if the value can't be formatted.

getPattern

public java.lang.String getPattern()
                            throws java.lang.IllegalStateException

Returns the localized pattern for the current format. The default implementation recognize DecimalFormat, SimpleDateFormat and AngleFormat instances.

Returns:

The pattern for the current format.

Throws:

java.lang.IllegalStateException - is the current format is not one of recognized type.

setPattern

public void setPattern(java.lang.String pattern)
                throws java.lang.IllegalStateException,
                       java.lang.IllegalArgumentException

Sets the localized pattern for the current format. The default implementation recognize DecimalFormat, SimpleDateFormat and AngleFormat instances.

Parameters:

pattern - The pattern for the current format.

Throws:

java.lang.IllegalStateException - is the current format is not one of recognized type.

java.lang.IllegalArgumentException - if the specified pattern is invalid.

showDialog

public boolean showDialog(java.awt.Component owner,
                          java.lang.String title)

Shows a dialog box requesting input from the user. The dialog box will be parented to . If is contained into a JDesktopPane, the dialog box will appears as an internal frame. This method can be invoked from any thread (may or may not be the Swing thread).

Parameters:

owner - The parent component for the dialog box, or if there is no parent.

title - The dialog box title.

Returns:

if user pressed the "Ok" button, or otherwise (e.g. pressing "Cancel" or closing the dialog box from the title bar).

main

public static void main(java.lang.String[] args)

Show this component. This method is used mostly in order to check the look of this widget from the command line.