at.mug.iqm.api.gui

Class ROILayerSelectorPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

at.mug.iqm.api.gui.ROILayerSelectorPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ROILayerSelectorPanel
extends JPanel

This panel represents all control elements for a stack of ROI layers.

Author:

Philipp Kainz

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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 IDrawingLayer	currentLayer The currently selected layer.
private ROILayerWidget	currentWidget The currently selected widget.
private ILookPanel	displayPanel The ILookPanel managed by this instance.
private JLayeredPane	layerPane A list of all existing ROI layers.
private ArrayList<IDrawingLayer>	layers All layers of the managed ILookPanel.
private JLabel	lblAdd
private JLabel	lblHideAll
private JLabel	lblMoveDown
private JLabel	lblMoveUp
private JLabel	lblRemove
private JLabel	lblShowAll
private static org.apache.log4j.Logger	logger A custom class logger.
private int	selectedLayerIndex The currently selected layer index.
private Box	selectorContainer A container for the control elements.
private ButtonGroup	selectorGroup A button group for all radio buttons.
private static long	serialVersionUID The UID for serialization.
private ArrayList<ROILayerWidget>	widgets An ordered list of ROILayerWidgets.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ROILayerSelectorPanel() Create the panel.
ROILayerSelectorPanel(ILookPanel lookPanel) Generate a new layer selection panel for the given look panel in order to manage the ROIs.

Method Summary

Modifier and Type	Method and Description
protected IDrawingLayer	addLayer(String name, boolean immediateRepaint) Add a layer widget to the end of the layer list (on top of all others).
private void	cleanDrawingLayersFromPane() Removes all instances of IDrawingLayer ayers from the JLayeredPane.
private void	cleanUp(int zOrder) Cleans all traces for a layer according to the given z-order.
IDrawingLayer	createDefaultLayer() Creates the default layer (0).
IDrawingLayer	createLayer() Creates a new layer to draw on.
IDrawingLayer	createLayer(String name) Creates a new layer with a given name to draw on.
IDrawingLayer	getCurrentLayer() Gets the currently selected layer.
ImageLayer	getImageLayer() Gets the image layer, which is located below all ROI layers.
IDrawingLayer	getLayer(int zOrder) Get a layer by the its z-order.
JLayeredPane	getLayerPane() Get the layered pane of the managed look panel.
List<IDrawingLayer>	getLayers() Get a list of all layers.
ILookPanel	getLookPanel() Gets the reference to the look panel, this selector widget is associated with.
void	hideAllLayers() Hides all layers from the display.
protected ROILayerWidget	highlightWidget(int selectedIndex) This method selects the layer at the specified index and de-selects all other layers.
private void	initialize() (Re)-initializes the component.
static void	main(String[] args)
void	moveLayerDown() Moves the selected layer one position downwards.
void	moveLayerUp() Moves the selected layer one position upwards.
protected void	reIndexLayers() Re-indexes the layers with running numbers as z-orders.
void	removeLayer(int zOrder) Removes a specified layer from the list.
protected void	removeWidget(int zOrder, boolean immediateRepaint) Remove the selector widget at a corresponding zOrder from the container.
IDrawingLayer	replaceLayers(List<IDrawingLayer> layers) Replaces all layers with a new list of layers.
IDrawingLayer	resetLayers() Entirely removes all layers and creates a new default layer.
IDrawingLayer	selectLayer(int zOrder) Selects and highlights the layer at the given zOrder position.
void	setLayerPane(JLayeredPane layerPane) Set the layered pane.
void	setLayerToFront(DefaultDrawingLayer layer) Sets the layer to front and repaints the active layer.
void	showAllLayers() Shows all layers from the display.
void	swapLayers(int sourceIndex, int destinationIndex) Swap the source index with the destination index for the widgets and the layers.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, 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, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, 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, getPeer, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, 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

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

logger

private static final org.apache.log4j.Logger logger

A custom class logger.

lblAdd

private JLabel lblAdd

lblRemove

private JLabel lblRemove

lblMoveUp

private JLabel lblMoveUp

lblMoveDown

private JLabel lblMoveDown

selectorGroup

private ButtonGroup selectorGroup

A button group for all radio buttons.

displayPanel

private ILookPanel displayPanel

The ILookPanel managed by this instance.

widgets

private ArrayList<ROILayerWidget> widgets

An ordered list of ROILayerWidgets. Greater indices indicate greater z-order.

selectedLayerIndex

private int selectedLayerIndex

The currently selected layer index.

currentLayer

private IDrawingLayer currentLayer

The currently selected layer.

currentWidget

private ROILayerWidget currentWidget

The currently selected widget.

layers

private ArrayList<IDrawingLayer> layers

All layers of the managed ILookPanel. The Integer is the z-order of the corresponding layer.

layerPane

private JLayeredPane layerPane

A list of all existing ROI layers.

selectorContainer

private Box selectorContainer

A container for the control elements.

lblHideAll

private JLabel lblHideAll

lblShowAll

private JLabel lblShowAll

Constructor Detail

ROILayerSelectorPanel

public ROILayerSelectorPanel()

Create the panel.

ROILayerSelectorPanel

public ROILayerSelectorPanel(ILookPanel lookPanel)

Generate a new layer selection panel for the given look panel in order to manage the ROIs.

Parameters:

lookPanel -

Method Detail

hideAllLayers

public void hideAllLayers()

Hides all layers from the display.

showAllLayers

public void showAllLayers()

Shows all layers from the display.

highlightWidget

protected ROILayerWidget highlightWidget(int selectedIndex)

This method selects the layer at the specified index and de-selects all other layers.

Parameters:

selectedIndex - the z-order of the layer

Returns:

the highlighted widget at the specified position

removeWidget

protected void removeWidget(int zOrder,
                            boolean immediateRepaint)

Remove the selector widget at a corresponding zOrder from the container.

Parameters:

zOrder -

immediateRepaint -

createDefaultLayer

public IDrawingLayer createDefaultLayer()

Creates the default layer (0).

createLayer

public IDrawingLayer createLayer()

Creates a new layer to draw on.

Returns:

a new layer on top of all others

createLayer

public IDrawingLayer createLayer(String name)

Creates a new layer with a given name to draw on.

Returns:

a new layer on top of all others, identified by name

resetLayers

public IDrawingLayer resetLayers()

Entirely removes all layers and creates a new default layer.

initialize

private void initialize()

(Re)-initializes the component.

cleanDrawingLayersFromPane

private void cleanDrawingLayersFromPane()

Removes all instances of IDrawingLayer ayers from the JLayeredPane.

replaceLayers

public IDrawingLayer replaceLayers(List<IDrawingLayer> layers)

Replaces all layers with a new list of layers.

Parameters:

layers - the list of new layers, if null the list will be replaced by a single default layer

Returns:

a reference to the active drawing layer

addLayer

protected IDrawingLayer addLayer(String name,
                                 boolean immediateRepaint)

Add a layer widget to the end of the layer list (on top of all others).

Parameters:

name - the name of the layer

immediateRepaint - a flag whether the GUI shall be repainted immediately after adding the layer widget

Returns:

a reference to the latest generated layer

selectLayer

public IDrawingLayer selectLayer(int zOrder)

Selects and highlights the layer at the given zOrder position. The current layer is set to the selected one.

Parameters:

zOrder - the position of the layer in the stack

Returns:

the layer located at the given position

Throws:

NoSuchElementException - if the zOrder is not within the stack

getLayer

public IDrawingLayer getLayer(int zOrder)

Get a layer by the its z-order. Getting the element by this method does not select the layer until it is not present and is being created. Furthermore, it does not change the current layer variable, i.e. getCurrentLayer() does not return the same layer as this method.

Parameters:

zOrder - the index of the layer

Returns:

the layer, if it exists, or a new layer on top of all others otherwise

removeLayer

public void removeLayer(int zOrder)

Removes a specified layer from the list.

Parameters:

zOrder - the index of the layer

cleanUp

private void cleanUp(int zOrder)

Cleans all traces for a layer according to the given z-order.

Parameters:

zOrder -

moveLayerDown

public void moveLayerDown()

Moves the selected layer one position downwards. This action has no effect, if the bottommost element is selected.

moveLayerUp

public void moveLayerUp()

Moves the selected layer one position upwards. This action has no effect, if the topmost element is selected.

swapLayers

public void swapLayers(int sourceIndex,
                       int destinationIndex)

Swap the source index with the destination index for the widgets and the layers.

Parameters:

sourceIndex -

destinationIndex -

getLayers

public List<IDrawingLayer> getLayers()

Get a list of all layers.

Returns:

a list of all layers

getCurrentLayer

public IDrawingLayer getCurrentLayer()

Gets the currently selected layer.

Returns:

the current layer

getLookPanel

public ILookPanel getLookPanel()

Gets the reference to the look panel, this selector widget is associated with.

Returns:

the look panel

reIndexLayers

protected void reIndexLayers()

Re-indexes the layers with running numbers as z-orders.

getImageLayer

public ImageLayer getImageLayer()

Gets the image layer, which is located below all ROI layers.

Returns:

the image layer instance

getLayerPane

public JLayeredPane getLayerPane()

Get the layered pane of the managed look panel.

Returns:

the JLayeredPane

setLayerPane

public void setLayerPane(JLayeredPane layerPane)

Set the layered pane.

Parameters:

layerPane -

setLayerToFront

public void setLayerToFront(DefaultDrawingLayer layer)

Sets the layer to front and repaints the active layer.

Parameters:

layer -

main

public static void main(String[] args)