com.vividsolutions.jump.workbench.ui

Class MultiInputDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.vividsolutions.jump.workbench.ui.AbstractMultiInputDialog

com.vividsolutions.jump.workbench.ui.MultiInputDialog

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:

DialogParameters, DualPaneInputDialog, MultiTabInputDialog

public class MultiInputDialog
extends AbstractMultiInputDialog

Flexible generic dialog for prompting the user to type in several values. This Dialog is a refactoring of the previous vividsolutions MultiInputDialog

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
protected OKCancelApplyPanel	okCancelApplyPanel

Fields inherited from class com.vividsolutions.jump.workbench.ui.AbstractMultiInputDialog

BOTH, buttonGroupMap, fieldNameToComponentMap, fieldNameToEnableCheckListMap, fieldNameToLabelMap, HORIZONTAL, LEFT_LABEL, NO_LABEL, NO_VALID_ATTRIBUTE, NONE, RIGHT_LABEL, VERTICAL

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addOKCancelApplyPanelActionListener(java.awt.event.ActionListener actionListener)
void	addRow()
void	addRow(javax.swing.JComponent component)
void	addRow(java.lang.String fieldName, javax.swing.JComponent component, EnableCheck[] enableChecks, java.lang.String toolTipText)
void	addRow(java.lang.String fieldName, javax.swing.JComponent label, javax.swing.JComponent component, EnableCheck[] enableChecks, java.lang.String toolTipText, int labelPos, int fillMode) Add a row to the current JPanel.
void	addRow(java.lang.String fieldName, javax.swing.JLabel label, javax.swing.JComponent component, EnableCheck[] enableChecks, java.lang.String toolTipText)
void	addRow(java.lang.String fieldName, javax.swing.JLabel label, javax.swing.JTextField component, EnableCheck[] enableChecks, java.lang.String toolTipText)
MultiInputDialogConsole	getConsole()
javax.swing.JPanel	getCurrentPanel()
MultiInputDialogInfoPanel	getDescriptionPanel()
void	indentLabel(java.lang.String fieldName) Indent the label of a field with a MatteBorder having the width of a JCheckBox and the color of the component background.
static void	main(java.lang.String[] args)
void	setApplyVisible(boolean applyVisible)
void	setCancelVisible(boolean cancelVisible)
void	setCurrentPanel(javax.swing.JPanel panel)
void	setInset(int inset)
protected void	setMainComponent()
void	setSideBarDescription(java.lang.String description)
void	setSideBarImage(javax.swing.Icon icon)
void	setVisible(boolean visible)
void	showConsole()
void	startNewColumn() Deprecated.
boolean	wasApplyPressed()
boolean	wasOKPressed()

Methods inherited from class com.vividsolutions.jump.workbench.ui.AbstractMultiInputDialog

addAttributeComboBox, addButton, addButton, addCheckBox, addCheckBox, addComboBox, addDoubleField, addDoubleField, addEditableLayerComboBox, addEnableChecks, addIntegerField, addLabel, addLayerComboBox, addLayerComboBox, addLayerComboBox, addLayerComboBox, addNonNegativeDoubleField, addNonNegativeDoubleField, addPositiveDoubleField, addPositiveDoubleField, addPositiveIntegerField, addPositiveIntegerField, addRadioButton, addSeparator, addSubTitle, addTextAreaField, addTextField, createDoubleCheck, createIntegerCheck, createNonNegativeCheck, createPositiveCheck, getBoolean, getCheckBox, getComboBox, getDouble, getFileChooser, getInteger, getLabel, getLayer, getRadioButton, getText, setFieldEnabled, setFieldVisible

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, 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

okCancelApplyPanel

protected final OKCancelApplyPanel okCancelApplyPanel

Constructor Detail

MultiInputDialog

public MultiInputDialog(java.awt.Frame frame,
                java.lang.String title,
                boolean modal)

Parameters:

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

MultiInputDialog

public MultiInputDialog()

Method Detail

setMainComponent

protected void setMainComponent()

getCurrentPanel

public javax.swing.JPanel getCurrentPanel()

Returns:

the JPanel where new Rows are added

setCurrentPanel

public void setCurrentPanel(javax.swing.JPanel panel)

Parameters:

panel - the JPanel where new Rows are added

getConsole

public MultiInputDialogConsole getConsole()

Returns:

the MultiInputDialogConsole panel.

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - if true, the MultiInputDialog will be visible.

getDescriptionPanel

public MultiInputDialogInfoPanel getDescriptionPanel()

Returns:

the MultiInputDialogInfoPanel.

setSideBarImage

public void setSideBarImage(javax.swing.Icon icon)

setSideBarDescription

public void setSideBarDescription(java.lang.String description)

showConsole

public void showConsole()

setApplyVisible

public void setApplyVisible(boolean applyVisible)

setCancelVisible

public void setCancelVisible(boolean cancelVisible)

wasApplyPressed

public boolean wasApplyPressed()

wasOKPressed

public boolean wasOKPressed()

addOKCancelApplyPanelActionListener

public void addOKCancelApplyPanelActionListener(java.awt.event.ActionListener actionListener)

addRow

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

Add a row to the current JPanel. The GridBagLayout is used as follows :

• For JCheckBox, JRadioButton and JLabel and JPanel the component spreads over 3 columns. Empty label is in the fourth column.
• For JComboBox and JTextField, label is in first column and component in second column. Third and fourth column or empty.

|---|------------------------|----------------------|-----|---| | 0 | 1 | 2 | 3 | 4 | |---|-----------------------------------------------------|---| | | JChekBox with label associated | | |---|-----------------------------------------------------|---| | | JRadioButton with label associated | | |---|-----------------------------------------------------|---| | | JLabel | | |---|-----------------------------------------------------|---| | | JPanel | | |---|------------------------|----------------------------|---| | | Label | JComboBox | | |---|------------------------|----------------------------|---| | | Label | JTextField | | |---|------------------------|----------------------|-----|---| /** Adds a row (containing either a control or a label) to the Dialog.

Specified by:

addRow in class AbstractMultiInputDialog

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 -

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

public void addRow(java.lang.String fieldName,
          javax.swing.JComponent component,
          EnableCheck[] enableChecks,
          java.lang.String toolTipText)

addRow

public void addRow(java.lang.String fieldName,
          javax.swing.JLabel label,
          javax.swing.JTextField component,
          EnableCheck[] enableChecks,
          java.lang.String toolTipText)

addRow

public void addRow(java.lang.String fieldName,
          javax.swing.JLabel label,
          javax.swing.JComponent component,
          EnableCheck[] enableChecks,
          java.lang.String toolTipText)

addRow

public void addRow(javax.swing.JComponent component)

Specified by:

addRow in class AbstractMultiInputDialog

addRow

public void addRow()

Specified by:

addRow in class AbstractMultiInputDialog

setInset

public void setInset(int inset)

indentLabel

public void indentLabel(java.lang.String fieldName)

Indent the label of a field with a MatteBorder having the width of a JCheckBox and the color of the component background. This helps to align JCheckBox label (text on the right of the CheckBox) with other component labels (text on the left of the component).

Parameters:

fieldName - the field to indent

startNewColumn

public void startNewColumn()

Deprecated.

main

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