org.youscope.uielements

Class LiveStreamPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.youscope.uielements.ImagePanel

org.youscope.uielements.LiveStreamPanel

All Implemented Interfaces:

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

public class LiveStreamPanel
extends ImagePanel

A panel to configure, start and stop a live stream.

Author:

Moritz Lang

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LiveStreamPanel.ChannelControl Control to select the channel and exposure times.

Nested classes/interfaces inherited from class org.youscope.uielements.ImagePanel

ImagePanel.LineInfo, ImagePanel.LineListener, ImagePanel.PixelInfo, ImagePanel.PixelListener

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 inherited from class org.youscope.uielements.ImagePanel

DEFAULT_BACKGROUND, DEFAULT_DRAW_LINE_COLOR, DEFAULT_FOREGROUND, 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
LiveStreamPanel(YouScopeClient client, YouScopeServer server) Constructor.

Method Summary

Modifier and Type	Method and Description
YouScopeFrameListener	getFrameListener() Returns a frame listener which can be added to the frame to which this panel is added, taking care that the LiveStream automatically stops when the frame closes (and, that it automatically starts when the frame opens, if autostart is set to true).
void	saveSettings() Call this function such that the current channel settings get saved.
void	setAutoStartStream(boolean autostart) If set to true, the stream automatically starts when the window is made visible.
void	setFullScreen(boolean fullScreen) Set to true to show the LiveStream in full-screen mode.
void	setUserChoosesFullScreen(boolean userChooses) Set to true to display a button with which the user can choose on him/herself if the LiveStream should be shown in full-screen mode.
void	snapImage() Snaps a single image with the current settings.
void	startLiveStream() Starts the live stream.
void	stopLiveStream() Stops the live stream.
void	stopLiveStreamAndWait() Stops the live stream.

Methods inherited from class org.youscope.uielements.ImagePanel

addControl, addControl, addLineListener, addPixelListener, clearControls, getNumControls, insertControl, insertControl, isAutoAdjustContrast, paintComponent, removeControl, removeControl, removeLineListener, removePixelListener, setAutoAdjustContrast, setImage, setImage, setNoImageText, setTitle, setUserChoosesAutoAdjustContrast, toFrame

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

Constructor Detail

LiveStreamPanel

public LiveStreamPanel(YouScopeClient client,
                       YouScopeServer server)

Constructor.

Parameters:

client - YouScope client.

server - YouScope server.

Method Detail

setFullScreen

public void setFullScreen(boolean fullScreen)

Set to true to show the LiveStream in full-screen mode. Set to fals again to stop full-sceen again.

Parameters:

fullScreen - True to start, false to stop full-screen.

saveSettings

public void saveSettings()

Call this function such that the current channel settings get saved. When starting a LiveStream again, the same settings will appear.

getFrameListener

public YouScopeFrameListener getFrameListener()

Returns a frame listener which can be added to the frame to which this panel is added, taking care that the LiveStream automatically stops when the frame closes (and, that it automatically starts when the frame opens, if autostart is set to true).

Overrides:

getFrameListener in class ImagePanel

Returns:

Frame listener.

setAutoStartStream

public void setAutoStartStream(boolean autostart)

If set to true, the stream automatically starts when the window is made visible. Note: the stream automatically stops if the frame is hidden. Has only an effect if #toFrame() is used.

Parameters:

autostart - true to automatically start imaging when frame shows up.

setUserChoosesFullScreen

public void setUserChoosesFullScreen(boolean userChooses)

Set to true to display a button with which the user can choose on him/herself if the LiveStream should be shown in full-screen mode. Default is false.

Parameters:

userChooses - True to display fullscreen button.

stopLiveStream

public void stopLiveStream()

Stops the live stream. Does nothing if live stream is not running. The call immediately returns, even if the stopping of the live stream takes longer.

stopLiveStreamAndWait

public void stopLiveStreamAndWait()

Stops the live stream. Does nothing if live stream is not running. The call returns after the live stream has stopped.

snapImage

public void snapImage()

Snaps a single image with the current settings.

startLiveStream

public void startLiveStream()

Starts the live stream. If the live stream is already running, it restarts it.