Class SingleOrMultipleInputImageSelectionPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.xinapse.image.SingleOrMultipleInputImageSelectionPanel

All Implemented Interfaces:

PreferencesSettable, ImageObserver, MenuContainer, Serializable, Accessible

public class SingleOrMultipleInputImageSelectionPanel
extends JPanel
implements PreferencesSettable

A JPanel for selecting a single or multiple input images, depending on a user-selection.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields inherited from class JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
SingleOrMultipleInputImageSelectionPanel(MessageShower messageShower, String prefsNodeName)	Creates a new SingleOrMultipleInputImageSelectionPanel with messages going to the MessageShower.

Method Summary

Modifier and Type	Method	Description
void	clearFiles()	Clears the currently-set files names, so that the file names are un-initialised.
ReadableImage[]	getInputImages()	Returns the input images set in this SingleOrMultipleInputImageSelectionPanel.
boolean	isSingleInputImage()	Returns whether configured with a single input image.
void	savePreferences(Preferences prefs)	Save the current settings to the user Preferences at the given node name.
void	setDefaults()	Set the default values.
void	setEnabled(boolean b)
void	setInputImageConfiguration(Boolean isSingleInputImage)	Sets the configuration to have a single input image.
void	showError(String errorMessage)	Show an error message (in case the current settings are invalid).

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

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

Constructor Details

SingleOrMultipleInputImageSelectionPanel

public SingleOrMultipleInputImageSelectionPanel(MessageShower messageShower,
 String prefsNodeName)

Creates a new SingleOrMultipleInputImageSelectionPanel with messages going to the MessageShower.

Parameters:

messageShower - the MessageShower that will receive messages.

prefsNodeName - the Preferences node name that will be used to set the initial state.

Method Details

getInputImages

public ReadableImage[] getInputImages()
                               throws InvalidArgumentException

Returns the input images set in this SingleOrMultipleInputImageSelectionPanel.

Returns:

the input images set in this SingleOrMultipleInputImageSelectionPanel.

Throws:

InvalidArgumentException - if the image(s) have not been set, or if the input image(s) cannot be opened.

isSingleInputImage

public boolean isSingleInputImage()

Returns whether configured with a single input image.

Returns:

true if configured for a single input image; false if configured for multiple input images.

setInputImageConfiguration

public void setInputImageConfiguration(Boolean isSingleInputImage)

Sets the configuration to have a single input image. Simulates the user clicking the appropriate buttons to set the configuration.

Parameters:

isSingleInputImage - if null, does nothing to the single/multiple input image configuration.

• If Boolean.TRUE, sets a single input image configuration.
• If Boolean.FALSE, sets a multiple input images configuration.

setDefaults

public void setDefaults()

Description copied from interface: PreferencesSettable

Set the default values.

Specified by:

setDefaults in interface PreferencesSettable

savePreferences

public void savePreferences(Preferences prefs)

Description copied from interface: PreferencesSettable

Save the current settings to the user Preferences at the given node name.

Specified by:

savePreferences in interface PreferencesSettable

Parameters:

prefs - the Preferences to which the current settings will be saved.

clearFiles

public void clearFiles()

Clears the currently-set files names, so that the file names are un-initialised.

showError

public void showError(String errorMessage)

Description copied from interface: PreferencesSettable

Show an error message (in case the current settings are invalid).

Specified by:

showError in interface PreferencesSettable

Parameters:

errorMessage - the message to show.

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class JComponent