com.vividsolutions.jump.workbench.ui

Class AbstractMultiInputDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.vividsolutions.jump.workbench.ui.AbstractMultiInputDialog

All Implemented Interfaces:

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

Direct Known Subclasses:

MultiInputDialog

public abstract class AbstractMultiInputDialog
extends javax.swing.JDialog

Flexible generic dialog to prompt the user typing input parameters. This abstract class includes the logic from original JUMP MultiInputDialog but does not layout components, which is done by implementing classes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTH Flag indicating that the main component will fill the space.
protected java.util.Map	buttonGroupMap
protected java.util.HashMap<java.lang.String,javax.swing.JComponent>	fieldNameToComponentMap
protected CollectionMap	fieldNameToEnableCheckListMap
protected java.util.HashMap	fieldNameToLabelMap
static int	HORIZONTAL Flag indicating that the main component will fill the space.
static int	LEFT_LABEL The label is displayed on the left of the control.
static int	NO_LABEL The label of the control is not displayed.
static java.lang.String	NO_VALID_ATTRIBUTE Attribute combobox message displayed if no valid attribute is available.
static int	NONE Flag indicating that the main component will always use its preferred size.
static int	RIGHT_LABEL The label is displayed on the right of the control.
static int	VERTICAL Flag indicating that the main component will fill the space vertically.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Constructors

Modifier	Constructor and Description
protected	AbstractMultiInputDialog(java.awt.Frame frame, java.lang.String title, boolean modal)

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComboBox	addAttributeComboBox(java.lang.String fieldName, java.lang.String layerFieldName, AttributeTypeFilter filter, java.lang.String toolTipText) Add a JComboBox containing attributes of the Layer selected in layerFieldName
javax.swing.JButton	addButton(java.lang.String text) Adds a JButton to this dialog.
javax.swing.JButton	addButton(java.lang.String fieldName, java.lang.String text, java.lang.String toolTipText) Adds a JButton to this dialog.
javax.swing.JCheckBox	addCheckBox(java.lang.String fieldName, boolean initialValue) Create a CheckBox to get a boolean value from the user.
javax.swing.JCheckBox	addCheckBox(java.lang.String fieldName, boolean initialValue, java.lang.String toolTipText) Create a CheckBox to get a boolean value from the user.
javax.swing.JComboBox	addComboBox(java.lang.String fieldName, java.lang.Object selectedItem, java.util.Collection items, java.lang.String toolTipText) Adds a JComboBox control to this dialog.
javax.swing.JTextField	addDoubleField(java.lang.String fieldName, double initialValue, int approxWidthInChars) Adds a JTextField control for positive integer inputs.
javax.swing.JTextField	addDoubleField(java.lang.String fieldName, double initialValue, int approxWidthInChars, java.lang.String toolTipText) Adds a JTextField control for double value inputs.
javax.swing.JComboBox	addEditableLayerComboBox(java.lang.String fieldName, Layer initialValue, java.lang.String toolTipText, LayerManager layerManager) Add a JComboBox containing editable layers of a LayerManager.
void	addEnableChecks(java.lang.String fieldName, java.util.Collection enableChecks) Adding enableChecks to the fieldNameToEnableCheckListMap CollectionMap.
javax.swing.JTextField	addIntegerField(java.lang.String fieldName, int initialValue, int approxWidthInChars, java.lang.String toolTipText) Adds a JTextField control for integer inputs.
javax.swing.JLabel	addLabel(java.lang.String text) Adds a JLabel to this dialog.
javax.swing.JComboBox	addLayerComboBox(java.lang.String fieldName, Layer initialValue, LayerManager layerManager) Add a JComboBox containing available layers from the current LayerManager.
javax.swing.JComboBox	addLayerComboBox(java.lang.String fieldName, Layer initialValue, java.lang.String toolTipText, java.util.Collection layers) Add a JComboBox containing any collection of Layers.
javax.swing.JComboBox	addLayerComboBox(java.lang.String fieldName, Layer initialValue, java.lang.String toolTipText, LayerManager layerManager) Add a JComboBox containing available layers from the current LayerManager.
javax.swing.JComboBox	addLayerComboBox(java.lang.String fieldName, java.lang.String toolTipText, LayerManager layerManager, AttributeTypeFilter filter) Add a JComboBox containing layers containing the specified AttributeType.
javax.swing.JTextField	addNonNegativeDoubleField(java.lang.String fieldName, double initialValue, int approxWidthInChars) Adds a JTextField control for positive double value inputs.
javax.swing.JTextField	addNonNegativeDoubleField(java.lang.String fieldName, double initialValue, int approxWidthInChars, java.lang.String toolTipText) Adds a JTextField control for positive double value inputs.
javax.swing.JTextField	addPositiveDoubleField(java.lang.String fieldName, double initialValue, int approxWidthInChars) Adds a JTextField control for positive double value inputs.
javax.swing.JTextField	addPositiveDoubleField(java.lang.String fieldName, double initialValue, int approxWidthInChars, java.lang.String toolTipText) Adds a JTextField control for positive double value inputs.
javax.swing.JTextField	addPositiveIntegerField(java.lang.String fieldName, int initialValue, int approxWidthInChars) Adds a JTextField control for positive integer inputs.
javax.swing.JTextField	addPositiveIntegerField(java.lang.String fieldName, int initialValue, int approxWidthInChars, java.lang.String toolTipText) Adds a JTextField control for positive integer inputs.
javax.swing.JRadioButton	addRadioButton(java.lang.String fieldName, java.lang.String buttonGroupName, boolean initialValue, java.lang.String toolTipText) Adds a RadioButton to the buttonGroupName group.
protected abstract void	addRow()
protected abstract void	addRow(javax.swing.JComponent c)
protected abstract void	addRow(java.lang.String fieldName, javax.swing.JComponent label, javax.swing.JComponent component, EnableCheck[] enableChecks, java.lang.String toolTipText, int labelPos, int fillMode) Adds a row (containing either a control or a label) to the Dialog.
void	addSeparator() Adds a horizontal separator between two set of controls.
javax.swing.JLabel	addSubTitle(java.lang.String text) Adds a JLabel to display a subtitle in the dialog.
javax.swing.JTextArea	addTextAreaField(java.lang.String fieldName, java.lang.String initialValue, int rowNumber, int columnNumber, boolean scrollable, EnableCheck[] enableChecks, java.lang.String toolTipText) Adds a TextArea field.
javax.swing.JTextField	addTextField(java.lang.String fieldName, java.lang.String initialValue, int approxWidthInChars, EnableCheck[] enableChecks, java.lang.String toolTipText) Adds a JTextField control to this dialog.
EnableCheck	createDoubleCheck(java.lang.String fieldName) Check if the control contains a valid Double.
EnableCheck	createIntegerCheck(java.lang.String fieldName) Check if the control contains a valid Integer.
EnableCheck	createNonNegativeCheck(java.lang.String fieldName) Check if the control contains a non-negative Number.
EnableCheck	createPositiveCheck(java.lang.String fieldName) Check if the control contains a positive Number.
boolean	getBoolean(java.lang.String fieldName) Returns selected state for checkboxes, radio buttons.
javax.swing.JCheckBox	getCheckBox(java.lang.String fieldName) Gets JCheckBox component matching this fieldName.
javax.swing.JComboBox	getComboBox(java.lang.String fieldName) Gets JComboBox component matching this fieldName.
double	getDouble(java.lang.String fieldName) Returns double value from a JTextField control.
javax.swing.JFileChooser	getFileChooser(java.lang.String fieldName) Gets JFileChooser component matching this fieldName.
int	getInteger(java.lang.String fieldName) Returns integer value from a JTextField control.
javax.swing.JComponent	getLabel(java.lang.String fieldName) Gets JLabel matching this fieldName.
Layer	getLayer(java.lang.String fieldName) Returns a Layer from a JComboBox control.
javax.swing.JRadioButton	getRadioButton(java.lang.String fieldName) Gets JRadioButton component matching this fieldName.
java.lang.String	getText(java.lang.String fieldName) Gets the string value of a control
void	setFieldEnabled(java.lang.String fieldName, boolean enable)
void	setFieldVisible(java.lang.String fieldName, boolean visible)

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

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

NO_LABEL

public static final int NO_LABEL

The label of the control is not displayed.

See Also:

Constant Field Values

LEFT_LABEL

public static final int LEFT_LABEL

The label is displayed on the left of the control.

See Also:

Constant Field Values

RIGHT_LABEL

public static final int RIGHT_LABEL

The label is displayed on the right of the control.

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

Flag indicating that the main component will fill the space.

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

Flag indicating that the main component will fill the space vertically.

See Also:

Constant Field Values

BOTH

public static final int BOTH

Flag indicating that the main component will fill the space.

See Also:

Constant Field Values

NONE

public static final int NONE

Flag indicating that the main component will always use its preferred size.

See Also:

Constant Field Values

NO_VALID_ATTRIBUTE

public static final java.lang.String NO_VALID_ATTRIBUTE

Attribute combobox message displayed if no valid attribute is available.

fieldNameToComponentMap

protected java.util.HashMap<java.lang.String,javax.swing.JComponent> fieldNameToComponentMap

fieldNameToLabelMap

protected java.util.HashMap fieldNameToLabelMap

buttonGroupMap

protected java.util.Map buttonGroupMap

fieldNameToEnableCheckListMap

protected CollectionMap fieldNameToEnableCheckListMap

Constructor Detail

AbstractMultiInputDialog

protected AbstractMultiInputDialog(java.awt.Frame frame,
                        java.lang.String title,
                        boolean modal)

Parameters:

frame - the frame on which to make this dialog modal and centred

title - the title of the dialog box

modal - set if the dialog box is modal or not

Method Detail

createDoubleCheck

public EnableCheck createDoubleCheck(java.lang.String fieldName)

Check if the control contains a valid Double.

createIntegerCheck

public EnableCheck createIntegerCheck(java.lang.String fieldName)

Check if the control contains a valid Integer.

createPositiveCheck

public EnableCheck createPositiveCheck(java.lang.String fieldName)

Check if the control contains a positive Number.

createNonNegativeCheck

public EnableCheck createNonNegativeCheck(java.lang.String fieldName)

Check if the control contains a non-negative Number.

getLabel

public javax.swing.JComponent getLabel(java.lang.String fieldName)

Gets JLabel matching this fieldName.

getComboBox

public javax.swing.JComboBox getComboBox(java.lang.String fieldName)

Gets JComboBox component matching this fieldName.

getCheckBox

public javax.swing.JCheckBox getCheckBox(java.lang.String fieldName)

Gets JCheckBox component matching this fieldName.

getRadioButton

public javax.swing.JRadioButton getRadioButton(java.lang.String fieldName)

Gets JRadioButton component matching this fieldName.

getFileChooser

public javax.swing.JFileChooser getFileChooser(java.lang.String fieldName)

Gets JFileChooser component matching this fieldName.

getText

public java.lang.String getText(java.lang.String fieldName)

Gets the string value of a control

Parameters:

fieldName - control to read

Returns:

the string value of the control

getBoolean

public boolean getBoolean(java.lang.String fieldName)

Returns selected state for checkboxes, radio buttons.

getDouble

public double getDouble(java.lang.String fieldName)

Returns double value from a JTextField control.

getInteger

public int getInteger(java.lang.String fieldName)

Returns integer value from a JTextField control.

getLayer

public Layer getLayer(java.lang.String fieldName)

Returns a Layer from a JComboBox control.

addEnableChecks

public void addEnableChecks(java.lang.String fieldName,
                   java.util.Collection enableChecks)

Adding enableChecks to the fieldNameToEnableCheckListMap CollectionMap.

Parameters:

fieldName - fieldName of the control

enableChecks - EnableCheck array to validate this control input

addTextField

public javax.swing.JTextField addTextField(java.lang.String fieldName,
                                  java.lang.String initialValue,
                                  int approxWidthInChars,
                                  EnableCheck[] enableChecks,
                                  java.lang.String toolTipText)

Adds a JTextField control to this dialog.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

enableChecks - checks to validate the input value

toolTipText - tool tip to help the user

Returns:

the JTextField control added to this dialog

addComboBox

public javax.swing.JComboBox addComboBox(java.lang.String fieldName,
                                java.lang.Object selectedItem,
                                java.util.Collection items,
                                java.lang.String toolTipText)

Adds a JComboBox control to this dialog.

Parameters:

fieldName - field name of the control

selectedItem - initial selected item

items - items displayed in the JComboBox

toolTipText - tool tip to help the user

Returns:

the JComboBox control added to this dialog

addLabel

public javax.swing.JLabel addLabel(java.lang.String text)

Adds a JLabel to this dialog. The label can contain html (e.g. "Bold label for a subtitle")

Parameters:

text - text to display in the JLabel

Returns:

the JLabel added to this dialog

addSubTitle

public javax.swing.JLabel addSubTitle(java.lang.String text)

Adds a JLabel to display a subtitle in the dialog.

Parameters:

text - text to display in the JLabel

Returns:

the JLabel added to this dialog

addButton

public javax.swing.JButton addButton(java.lang.String fieldName,
                            java.lang.String text,
                            java.lang.String toolTipText)

Adds a JButton to this dialog. Action associated to this JButton must be defined.

Parameters:

fieldName - will be used for the label text on the left of the button

text - text to display in the JButton

toolTipText -

Returns:

the JButton added to this dialog

addButton

public javax.swing.JButton addButton(java.lang.String text)

Adds a JButton to this dialog. Action associated to this JButton must be defined.

Parameters:

text - text to display in the JButton

Returns:

the JButton added to this dialog

addSeparator

public void addSeparator()

Adds a horizontal separator between two set of controls.

addIntegerField

public javax.swing.JTextField addIntegerField(java.lang.String fieldName,
                                     int initialValue,
                                     int approxWidthInChars,
                                     java.lang.String toolTipText)

Adds a JTextField control for integer inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

toolTipText - tool tip to help the user

Returns:

the JTextField control added to this dialog

addPositiveIntegerField

public javax.swing.JTextField addPositiveIntegerField(java.lang.String fieldName,
                                             int initialValue,
                                             int approxWidthInChars,
                                             java.lang.String toolTipText)

Adds a JTextField control for positive integer inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

toolTipText - tool tip to help the user

Returns:

the JTextField control added to this dialog

addPositiveIntegerField

public javax.swing.JTextField addPositiveIntegerField(java.lang.String fieldName,
                                             int initialValue,
                                             int approxWidthInChars)

Adds a JTextField control for positive integer inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

Returns:

the JTextField control added to this dialog

addDoubleField

public javax.swing.JTextField addDoubleField(java.lang.String fieldName,
                                    double initialValue,
                                    int approxWidthInChars)

Adds a JTextField control for positive integer inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

Returns:

the JTextField control added to this dialog

addDoubleField

public javax.swing.JTextField addDoubleField(java.lang.String fieldName,
                                    double initialValue,
                                    int approxWidthInChars,
                                    java.lang.String toolTipText)

Adds a JTextField control for double value inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

toolTipText - tool tip to help the user

Returns:

the JTextField control added to this dialog

addPositiveDoubleField

public javax.swing.JTextField addPositiveDoubleField(java.lang.String fieldName,
                                            double initialValue,
                                            int approxWidthInChars,
                                            java.lang.String toolTipText)

Adds a JTextField control for positive double value inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

Returns:

the JTextField control added to this dialog

addPositiveDoubleField

public javax.swing.JTextField addPositiveDoubleField(java.lang.String fieldName,
                                            double initialValue,
                                            int approxWidthInChars)

Adds a JTextField control for positive double value inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

Returns:

the JTextField control added to this dialog

addNonNegativeDoubleField

public javax.swing.JTextField addNonNegativeDoubleField(java.lang.String fieldName,
                                               double initialValue,
                                               int approxWidthInChars,
                                               java.lang.String toolTipText)

Adds a JTextField control for positive double value inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

toolTipText - tool tip text associated with this text field

Returns:

the JTextField control added to this dialog

addNonNegativeDoubleField

public javax.swing.JTextField addNonNegativeDoubleField(java.lang.String fieldName,
                                               double initialValue,
                                               int approxWidthInChars)

Adds a JTextField control for positive double value inputs.

Parameters:

fieldName - field name of the control

initialValue - initial value of the control

approxWidthInChars - approximative width of the control in characters

Returns:

the JTextField control added to this dialog

addLayerComboBox

public javax.swing.JComboBox addLayerComboBox(java.lang.String fieldName,
                                     Layer initialValue,
                                     java.lang.String toolTipText,
                                     java.util.Collection layers)

Add a JComboBox containing any collection of Layers.

Parameters:

fieldName - field name of the control

initialValue - default layer visible in the combo box

toolTipText - tool tip text associated with this combo box

layers - layers to be proposed in the combo box

Returns:

the JComboBox

addLayerComboBox

public javax.swing.JComboBox addLayerComboBox(java.lang.String fieldName,
                                     Layer initialValue,
                                     LayerManager layerManager)

Add a JComboBox containing available layers from the current LayerManager.

Parameters:

fieldName - field name of the control

initialValue - default layer visible in the combo box

layerManager - the LayerManager providing layers to the combo box

Returns:

the JComboBox

addLayerComboBox

public javax.swing.JComboBox addLayerComboBox(java.lang.String fieldName,
                                     Layer initialValue,
                                     java.lang.String toolTipText,
                                     LayerManager layerManager)

Add a JComboBox containing available layers from the current LayerManager.

Parameters:

fieldName - field name of the control

initialValue - default layer visible in the combo box

toolTipText - tool tip text associated with this combo box

layerManager - the LayerManager providing layers to the combo box

Returns:

the JComboBox

addEditableLayerComboBox

public javax.swing.JComboBox addEditableLayerComboBox(java.lang.String fieldName,
                                             Layer initialValue,
                                             java.lang.String toolTipText,
                                             LayerManager layerManager)

Add a JComboBox containing editable layers of a LayerManager.

Parameters:

fieldName - field name of the control

initialValue - default layer visible in the combo box

toolTipText - tool tip text associated with this combo box

layerManager - the LayerManager providing layers to the combo box

Returns:

the JComboBox

addLayerComboBox

public javax.swing.JComboBox addLayerComboBox(java.lang.String fieldName,
                                     java.lang.String toolTipText,
                                     LayerManager layerManager,
                                     AttributeTypeFilter filter)

Add a JComboBox containing layers containing the specified AttributeType.

Parameters:

fieldName - field name of the control

toolTipText - tool tip text associated with this combo box

layerManager - the LayerManager providing layers to the combo box

filter - a filter to select layers with specified AttributeTypes

Returns:

the JComboBox

addAttributeComboBox

public javax.swing.JComboBox addAttributeComboBox(java.lang.String fieldName,
                                         java.lang.String layerFieldName,
                                         AttributeTypeFilter filter,
                                         java.lang.String toolTipText)

Add a JComboBox containing attributes of the Layer selected in layerFieldName

Parameters:

fieldName - field name for the attribute

layerFieldName - field name of the ComboBox used to choose the layer

filter - filter valid attributes from their type

toolTipText -

Returns:

the JComboBox

addCheckBox

public javax.swing.JCheckBox addCheckBox(java.lang.String fieldName,
                                boolean initialValue)

Create a CheckBox to get a boolean value from the user.

Parameters:

fieldName - field name of the control

initialValue - default boolean value

Returns:

the JCheckBox

addCheckBox

public javax.swing.JCheckBox addCheckBox(java.lang.String fieldName,
                                boolean initialValue,
                                java.lang.String toolTipText)

Create a CheckBox to get a boolean value from the user.

Parameters:

fieldName - field name of the control

initialValue - default boolean value

toolTipText - tool tip text associated with this check box

Returns:

the JCheckBox

addRadioButton

public javax.swing.JRadioButton addRadioButton(java.lang.String fieldName,
                                      java.lang.String buttonGroupName,
                                      boolean initialValue,
                                      java.lang.String toolTipText)

Adds a RadioButton to the buttonGroupName group.

Parameters:

fieldName - field name of the control

buttonGroupName - buttonGroupName of this RadioButton

initialValue - default boolean value

toolTipText - tool tip text associated with this check box

Returns:

the JRadioButton

addTextAreaField

public javax.swing.JTextArea addTextAreaField(java.lang.String fieldName,
                                     java.lang.String initialValue,
                                     int rowNumber,
                                     int columnNumber,
                                     boolean scrollable,
                                     EnableCheck[] enableChecks,
                                     java.lang.String toolTipText)

Adds a TextArea field.

Parameters:

fieldName - field name of the control

initialValue - default boolean value

rowNumber - initial row number

columnNumber - initial column number

scrollable - if true, the textArea is embeded into a JScrollPane

enableChecks - checks to validate the input value

toolTipText - tool tip text associated with this check box

Returns:

the JTextArea

addRow

protected abstract void addRow(java.lang.String fieldName,
          javax.swing.JComponent label,
          javax.swing.JComponent component,
          EnableCheck[] enableChecks,
          java.lang.String toolTipText,
          int labelPos,
          int fillMode)

Adds a row (containing either a control or a label) to the Dialog.

Parameters:

fieldName - field name of the control (used as a key)

label - label of the control

component - the control itself (may also be a label or a separator)

enableChecks - checks to validate inputs

toolTipText - ToolTip text

labelPos - 0, 1 or 2 depending on whether the label is hidden, on the left side or on the right side of the component

fillMode - true if the component must fill the available space

addRow

protected abstract void addRow(javax.swing.JComponent c)

addRow

protected abstract void addRow()

setFieldEnabled

public void setFieldEnabled(java.lang.String fieldName,
                   boolean enable)

setFieldVisible

public void setFieldVisible(java.lang.String fieldName,
                   boolean visible)