jigcell.compare.ui
Class ConfigEditor

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      jigcell.compare.ui.ConfigEditor

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ChangeListener, javax.swing.event.DocumentListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants, IConfigEditor

public class ConfigEditor
extends javax.swing.JDialog
implements java.awt.event.ActionListener, javax.swing.event.ChangeListener, javax.swing.event.DocumentListener, IConfigEditor, java.awt.event.ItemListener

A simple options editor in the style of the Java Beans property editor.

This code is licensed under the DARPA BioCOMP Open Source License. See LICENSE for more details.

Author:

Nicholas Allen

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

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

java.awt.Window.AccessibleAWTWindow

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected static java.lang.String	BUTTON_APPLY Text for apply button
protected static java.lang.String	BUTTON_RESET Text for reset button
protected static java.lang.String	CLIENT_COMPONENTSHOWN Client property for delayed initialization
protected Compare	compare Parent of view
protected InterfaceBuilder	manager Manages the interface for the dialog
protected java.util.List	markers Configuration markers for the owner of this dialog
protected java.util.Map	options Options in this dialog
protected Config	rootConfig Source of config information
protected Config	tabConfig Destination for config information

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

ConfigEditor(Compare compare, ITab owner, java.util.List markers, Config tabConfig)
Creates a new editor for the configuration.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
protected javax.swing.text.Document	addChoiceEditor(java.lang.String name, java.lang.String description, java.lang.Object[] choices, boolean editable) Adds an editor to the interface for selecting from a list of choices.
protected javax.swing.text.Document	addColorEditor(java.lang.String name, java.lang.String description) Adds an editor to the interface for Color data.
protected javax.swing.text.Document	addNumberEditor(java.lang.String name, java.lang.String description) Adds an editor to the interface for numeric data.
void	addOption(java.lang.String name, java.lang.String description, java.lang.Class type) Adds a new option to edit.
void	addOption(java.lang.String name, java.lang.String description, java.lang.Object[] choices, boolean editable, java.lang.Class type) Adds a new option to edit.
protected javax.swing.text.Document	addStringEditor(java.lang.String name, java.lang.String description) Adds an editor to the interface for String data.
void	changedUpdate(javax.swing.event.DocumentEvent e)
javax.swing.JDialog	createConfigDialog() Creates a dialog based configuration editor.
void	insertUpdate(javax.swing.event.DocumentEvent e)
void	itemStateChanged(java.awt.event.ItemEvent e)
void	removeUpdate(javax.swing.event.DocumentEvent e)
protected void	setButtonState(boolean enabled) Controls whether the dialog buttons are enabled.
void	setVisible(boolean b)
void	stateChanged(javax.swing.event.ChangeEvent e)

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_APPLY

protected static final java.lang.String BUTTON_APPLY

Text for apply button

See Also:

Constant Field Values

BUTTON_RESET

protected static final java.lang.String BUTTON_RESET

Text for reset button

See Also:

Constant Field Values

CLIENT_COMPONENTSHOWN

protected static final java.lang.String CLIENT_COMPONENTSHOWN

Client property for delayed initialization

See Also:

Constant Field Values

compare

protected Compare compare

Parent of view

rootConfig

protected Config rootConfig

Source of config information

tabConfig

protected Config tabConfig

Destination for config information

manager

protected InterfaceBuilder manager

Manages the interface for the dialog

markers

protected java.util.List markers

Configuration markers for the owner of this dialog

options

protected java.util.Map options

Options in this dialog

Constructor Detail

ConfigEditor

public ConfigEditor(Compare compare,
                    ITab owner,
                    java.util.List markers,
                    Config tabConfig)

Creates a new editor for the configuration.

Parameters:

compare - Comparator to associate with

owner - Owner of the options

markers - Markers for acessing configuration

tabConfig - Destination config information

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

addOption

public void addOption(java.lang.String name,
                      java.lang.String description,
                      java.lang.Class type)

Adds a new option to edit.

Specified by:

addOption in interface IConfigEditor

Parameters:

name - Name of the option

description - Text description of the option

type - Type of option

addOption

public void addOption(java.lang.String name,
                      java.lang.String description,
                      java.lang.Object[] choices,
                      boolean editable,
                      java.lang.Class type)

Adds a new option to edit.

Specified by:

addOption in interface IConfigEditor

Parameters:

name - Name of the option

description - Text description of the option

choices - Option choices

editable - Whether the option choices are editable

type - Type of option

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

createConfigDialog

public javax.swing.JDialog createConfigDialog()

Creates a dialog based configuration editor. It is preferrable that successive calls to this function return the same editor.

Specified by:

createConfigDialog in interface IConfigEditor

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class java.awt.Component

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

addChoiceEditor

protected javax.swing.text.Document addChoiceEditor(java.lang.String name,
                                                    java.lang.String description,
                                                    java.lang.Object[] choices,
                                                    boolean editable)

Adds an editor to the interface for selecting from a list of choices.

Parameters:

name - Name of the option

description - Text description of the option

choices - Option choices

editable - Whether the option choices are editable

addColorEditor

protected javax.swing.text.Document addColorEditor(java.lang.String name,
                                                   java.lang.String description)

Adds an editor to the interface for Color data.

Parameters:

name - Option name

description - Option description

addNumberEditor

protected javax.swing.text.Document addNumberEditor(java.lang.String name,
                                                    java.lang.String description)

Adds an editor to the interface for numeric data.

Parameters:

name - Option name

description - Option description

addStringEditor

protected javax.swing.text.Document addStringEditor(java.lang.String name,
                                                    java.lang.String description)

Adds an editor to the interface for String data.

Parameters:

name - Option name

description - Option description

setButtonState

protected void setButtonState(boolean enabled)

Controls whether the dialog buttons are enabled.

Parameters:

enabled - Button state