org.nanes.slideset.ui

Class PluginInputMatcherFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.nanes.slideset.ui.PluginInputMatcherFrame

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, PluginInputPicker, SlideSetWindow

public class PluginInputMatcherFrame
extends JFrame
implements PluginInputPicker, SlideSetWindow, ActionListener

GUI for assigning SlideSet columns to plugin inputs

Author:

Benjamin Nanes

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	active
private boolean	cancelPressed
private ArrayList<JButton>	constantValOptions The appropriate values menu buttons
private ArrayList<JFormattedTextField>	constantVals The constant value fields
private SlideSet	data
private DataTypeIDService	dtid
private ArrayList<JComboBox>	fields The combo boxes
private static int	gap Padding
private JButton	getHelp Button to view the relevant documentation, if applicable
private net.imagej.ImageJ	ij
private boolean	initialized
private ArrayList<String>	inputNames List of the input names
private ArrayList<JLabel>	labels The parameter labels
private BoxLayout	lman The layout manager
private boolean	okPressed
private ArrayList<ArrayList<Integer>>	optionIndex An index to match choices in each combo box to the appropriate SlideSet column index

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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, 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
PluginInputMatcherFrame(SlideSet data, net.imagej.ImageJ context, DataTypeIDService dtid)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Listener for button actions
void	addInput(String label, String[] choices, Object[] constantRequest, String[] acceptableValues) Add an input to the dialog (before display please)
private void	doComponentLayout() Finalize the dialog before display
void	getInputChoices(ArrayList<Integer> inputChoices, ArrayList<Object> constants) Get chosen options for assignment of each plugin input value.
void	kill() Perform any clean-up functions necessary to close the window.
private JButton	makeParameterOptionsMenu(String[] options, JFormattedTextField field) Create a button and menu to list appropriate values for an input parameter
void	setHelpPath(String helpPath, HelpLoader helpLoader) Register the documentation path for this plugin.
void	setVisible(boolean b)
private void	showAndWait() Show the dialog and wait for a user response
private void	updateControls()
private boolean	wasOKed() Did the user press OK?

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, 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, 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, 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

Methods inherited from interface org.nanes.slideset.ui.SlideSetWindow

addWindowListener

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

data

private final SlideSet data

ij

private final net.imagej.ImageJ ij

dtid

private final DataTypeIDService dtid

active

private boolean active

initialized

private boolean initialized

okPressed

private boolean okPressed

cancelPressed

private boolean cancelPressed

lman

private final BoxLayout lman

The layout manager

gap

private static final int gap

Padding

See Also:

Constant Field Values

fields

private final ArrayList<JComboBox> fields

The combo boxes

constantVals

private final ArrayList<JFormattedTextField> constantVals

The constant value fields

constantValOptions

private final ArrayList<JButton> constantValOptions

The appropriate values menu buttons

labels

private final ArrayList<JLabel> labels

The parameter labels

optionIndex

private final ArrayList<ArrayList<Integer>> optionIndex

An index to match choices in each combo box to the appropriate SlideSet column index

inputNames

private final ArrayList<String> inputNames

List of the input names

getHelp

private JButton getHelp

Button to view the relevant documentation, if applicable

Constructor Detail

PluginInputMatcherFrame

public PluginInputMatcherFrame(SlideSet data,
                               net.imagej.ImageJ context,
                               DataTypeIDService dtid)

Method Detail

addInput

public void addInput(String label,
                     String[] choices,
                     Object[] constantRequest,
                     String[] acceptableValues)

Add an input to the dialog (before display please)

Specified by:

addInput in interface PluginInputPicker

Parameters:

label - Human-readable name of the input, i.e. for labeling a drop-down box.

choices - Human-readable names for each available option for assigning the input value.

constantRequest - If the corresponding option for assigning the input value requires a constant, the default value; otherwise, null. This array must have the same length as choices.

acceptableValues - List of acceptable String values for this input parameter, or null if not applicable (i.e. no list of acceptable values, or parameter does not take a String value).

setHelpPath

public void setHelpPath(String helpPath,
                        HelpLoader helpLoader)

Description copied from interface: PluginInputPicker

Register the documentation path for this plugin. If a documentation path is provided, the PluginInputPicker may provide a way to display it. This method may be called at any point before getInputChoices().

Specified by:

setHelpPath in interface PluginInputPicker

Parameters:

helpPath - Path specifying the documentation resource associated with the plugin whose parameters are being assigned.

helpLoader - HelpLoader which should be used to view the documentation.

getInputChoices

public void getInputChoices(ArrayList<Integer> inputChoices,
                            ArrayList<Object> constants)
                     throws OperationCanceledException

Description copied from interface: PluginInputPicker

Get chosen options for assignment of each plugin input value. This method is invoked after all inputs have been registered. If user input is required, it should block until all selections have been made.

Specified by:

getInputChoices in interface PluginInputPicker

Parameters:

inputChoices - Empty list to be filled with index values of the selected input sources. The order of values corresponds to the order in which the plugin inputs were registered through addInput. The values correspond to the indeces of the selected option in the choices array passed to addInput.

constants - Empty list to be filled with constant values selected, or null if no constant value is required for the selected option.

Throws:

OperationCanceledException - If the user aborts the plugin, for example, by dismissing a dialog box without making the required selections.

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class Window

actionPerformed

public void actionPerformed(ActionEvent e)

Listener for button actions

Specified by:

actionPerformed in interface ActionListener

kill

public void kill()

Description copied from interface: SlideSetWindow

Perform any clean-up functions necessary to close the window. May ask for user input, such as weather to save changes.

Specified by:

kill in interface SlideSetWindow

showAndWait

private void showAndWait()

Show the dialog and wait for a user response

wasOKed

private boolean wasOKed()

Did the user press OK?

updateControls

private void updateControls()

doComponentLayout

private void doComponentLayout()

Finalize the dialog before display

makeParameterOptionsMenu

private JButton makeParameterOptionsMenu(String[] options,
                                         JFormattedTextField field)

Create a button and menu to list appropriate values for an input parameter