org.youscope.uielements

Class ImagePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.youscope.uielements.ImagePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

LiveStreamPanel

public class ImagePanel
extends javax.swing.JPanel

Easy to use resizeable panel to display an image. Provides a convenient method to display the image in a frame.

Author:

Moritz Lang

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImagePanel.LineInfo Information about a drawn line in the image.
static interface	ImagePanel.LineListener Listener which gets informed about a currently drawn line in the image.
static class	ImagePanel.PixelInfo Information about a pixel in the image.
static interface	ImagePanel.PixelListener Listener which gets informed about the currently hovered pixel in the image.

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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
static java.awt.Color	DEFAULT_BACKGROUND Default background color of the image panel.
static java.awt.Color	DEFAULT_DRAW_LINE_COLOR Default color of lines in image to measure distances.
static java.awt.Color	DEFAULT_FOREGROUND Default foreground (text) color of the image panel.
protected YouScopeFrame	frame

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
ImagePanel(YouScopeClient client) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addControl(java.lang.String title, java.awt.Component component) Adds a component with the given title to the end of the menu containing all controls.
void	addControl(java.lang.String title, java.awt.Component component, boolean resizable) Adds a component with the given title to the end of the menu containing all controls.
void	addLineListener(ImagePanel.LineListener listener) Adds a listener which gets informed over lines drawn in the image.
void	addPixelListener(ImagePanel.PixelListener listener) Adds a listener which gets informed over which pixels the user hovers with the mouse.
void	clearControls() Removes all added controls.
YouScopeFrameListener	getFrameListener() Returns a frame listener which can be added to the frame to which this panel is added, taking care of all default behavior.
int	getNumControls() Returns the number of controls in the menu containing all controls.
void	insertControl(java.lang.String title, java.awt.Component component, int index) Adds a component with the given title to the menu containing all controls at the given index.
void	insertControl(java.lang.String title, java.awt.Component component, int index, boolean resizable) Adds a component with the given title to the menu containing all controls at the given index.
boolean	isAutoAdjustContrast() Returns if the contrast should be automatically adjusted whenever a new image is set.
void	paintComponent(java.awt.Graphics grp)
void	removeControl(java.awt.Component component) Removes a previously added control.
void	removeControl(int index) Removes the control at the given index.
void	removeLineListener(ImagePanel.LineListener listener) Removes a previously added line listener.
void	removePixelListener(ImagePanel.PixelListener listener) Removes a previously added pixel listener.
void	setAutoAdjustContrast(boolean autoAdjustContrast) Sets if the contrast should be automatically adjusted whenever a new image is set.
void	setImage(java.awt.image.BufferedImage bufferedImage) Sets the image which should be displayed.
void	setImage(ImageEvent<?> imageEvent) Sets the image which should be displayed.
void	setNoImageText(java.lang.String noImageText) Sets the text which should be displayed if no image is available, yet.
void	setTitle(java.lang.String title) Sets the title of the frame, which is opened by toFrame().
void	setUserChoosesAutoAdjustContrast(boolean userChoosesAutoAdjustContrast) Set to true to display a checkbox with which the user can choose on him/herself if the contrast should be automatically adjusted when a new image arrives.
YouScopeFrame	toFrame() Convenient method to show this panel in a frame.

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

DEFAULT_BACKGROUND

public static final java.awt.Color DEFAULT_BACKGROUND

Default background color of the image panel.

DEFAULT_FOREGROUND

public static final java.awt.Color DEFAULT_FOREGROUND

Default foreground (text) color of the image panel.

DEFAULT_DRAW_LINE_COLOR

public static final java.awt.Color DEFAULT_DRAW_LINE_COLOR

Default color of lines in image to measure distances.

frame

protected YouScopeFrame frame

Constructor Detail

ImagePanel

public ImagePanel(YouScopeClient client)

Constructor.

Parameters:

client - YouScope client.

Method Detail

addPixelListener

public void addPixelListener(ImagePanel.PixelListener listener)

Adds a listener which gets informed over which pixels the user hovers with the mouse.

Parameters:

listener - Pixel listener to add.

removePixelListener

public void removePixelListener(ImagePanel.PixelListener listener)

Removes a previously added pixel listener.

Parameters:

listener - Pixel listener to remove.

addLineListener

public void addLineListener(ImagePanel.LineListener listener)

Adds a listener which gets informed over lines drawn in the image.

Parameters:

listener - Line listener to add.

removeLineListener

public void removeLineListener(ImagePanel.LineListener listener)

Removes a previously added line listener.

Parameters:

listener - Line listener to remove.

setAutoAdjustContrast

public void setAutoAdjustContrast(boolean autoAdjustContrast)

Sets if the contrast should be automatically adjusted whenever a new image is set.

Parameters:

autoAdjustContrast - True if automatic adjustment should be activated.

isAutoAdjustContrast

public boolean isAutoAdjustContrast()

Returns if the contrast should be automatically adjusted whenever a new image is set.

Returns:

True if automatic adjustment should be activated.

setUserChoosesAutoAdjustContrast

public void setUserChoosesAutoAdjustContrast(boolean userChoosesAutoAdjustContrast)

Set to true to display a checkbox with which the user can choose on him/herself if the contrast should be automatically adjusted when a new image arrives. Default is false. This does only make sense if it can be expected that more than one image can arrive at all.

Parameters:

userChoosesAutoAdjustContrast - True to display checkbox.

addControl

public void addControl(java.lang.String title,
                       java.awt.Component component)

Adds a component with the given title to the end of the menu containing all controls.

Parameters:

title - Title of the control.

component - The control element.

addControl

public void addControl(java.lang.String title,
                       java.awt.Component component,
                       boolean resizable)

Adds a component with the given title to the end of the menu containing all controls.

Parameters:

title - Title of the control.

component - The control element.

resizable - True if the control can take up excess vertical space.

insertControl

public void insertControl(java.lang.String title,
                          java.awt.Component component,
                          int index)
                   throws java.lang.IndexOutOfBoundsException

Adds a component with the given title to the menu containing all controls at the given index.

Parameters:

title - Title of the control.

component - The control element.

index - index where to add control. Must be greater or equal to 0, and smaller or equal to getNumControls().

Throws:

java.lang.IndexOutOfBoundsException - Thrown if index is invalid.

insertControl

public void insertControl(java.lang.String title,
                          java.awt.Component component,
                          int index,
                          boolean resizable)
                   throws java.lang.IndexOutOfBoundsException

Adds a component with the given title to the menu containing all controls at the given index.

Parameters:

title - Title of the control.

component - The control element.

index - index where to add control. Must be greater or equal to 0, and smaller or equal to getNumControls().

resizable - True if the control can take up excess vertical space.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if index is invalid.

getNumControls

public int getNumControls()

Returns the number of controls in the menu containing all controls.

Returns:

number of controls

removeControl

public void removeControl(int index)
                   throws java.lang.IndexOutOfBoundsException

Removes the control at the given index.

Parameters:

index - index of the control. Must be greater or equal to 0, and smaller than getNumControls().

Throws:

java.lang.IndexOutOfBoundsException - Thrown if index is invalid.

removeControl

public void removeControl(java.awt.Component component)

Removes a previously added control. Does nothing if control does not exist.

Parameters:

component - The control to remove.

clearControls

public void clearControls()

Removes all added controls.

paintComponent

public void paintComponent(java.awt.Graphics grp)

Overrides:

paintComponent in class javax.swing.JComponent

getFrameListener

public YouScopeFrameListener getFrameListener()

Returns a frame listener which can be added to the frame to which this panel is added, taking care of all default behavior. Listener is automatically added if toFrame() is used.

Returns:

Frame listener.

setNoImageText

public void setNoImageText(java.lang.String noImageText)

Sets the text which should be displayed if no image is available, yet. Set to null to not display any text.

Parameters:

noImageText - Text to display if no images are available.

toFrame

public YouScopeFrame toFrame()

Convenient method to show this panel in a frame. The frame is not made visible and has a default title.

Returns:

The frame containing this panel.

setImage

public void setImage(java.awt.image.BufferedImage bufferedImage)

Sets the image which should be displayed.

Parameters:

bufferedImage - Image which should be displayed.

setImage

public void setImage(ImageEvent<?> imageEvent)

Sets the image which should be displayed.

Parameters:

imageEvent - Image which should be displayed.

setTitle

public void setTitle(java.lang.String title)

Sets the title of the frame, which is opened by toFrame(). Has no effect when using this panel directly.

Parameters:

title - Title of the frame.