Package adams.gui.visualization.annotator

Class AnnotationPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.visualization.annotator.AnnotationPanel

All Implemented Interfaces:

TickListener, ImageObserver, MenuContainer, Serializable, Accessible

public class AnnotationPanel
extends adams.gui.core.BasePanel
implements TickListener

An Annotation panel that allows for the manual, i.e. non-toggleable, input from a binding

Version:

$Revision$

Author:

sjb90

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	Description
static int	BORDER_THICKNESS	The thickness of the border around the button
protected adams.gui.action.AbstractBaseAction	m_Action	the action to perform when the binding is activate
protected Binding	m_Binding	The binding this panel manages
protected adams.gui.core.BaseButton	m_Button	a button to indicate when a binding is pressed or toggled on
protected long	m_Interval	The Interval which this toggle runs at
protected boolean	m_IsToggleable	a bool to say if this is a toggleable binding or not
protected boolean	m_IsToggled	a bool to say if this binding is currently toggled on
protected List<AnnotationListener>	m_Listeners	The list of listeners registered with this panel
protected VLCjDirectRenderPanel	m_VideoPlayer	The video player we're annotating for
static Color	OFF_COLOUR	the off colour for a togglable button's boarder
static Color	ON_COLOUR	the on colour for a togglable button's boarder

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	Description
AnnotationPanel()

Method Summary

Modifier and Type	Method	Description
protected adams.gui.action.AbstractBaseAction	addKeyBinding(Binding binding)	Adds a binding to the panel
void	addListener(AnnotationListener listener)	Adds a listener to this panel
void	configureAnnotationPanel(Binding binding, VLCjDirectRenderPanel videoPlayer)	Constructs a AnnotationPanel
protected void	finishInit()
long	getInterval()
protected void	initGUI()
protected void	initialize()
protected void	makeStep(Date timestamp)	Creates a step for a given timestamp and alerts the listeners
protected void	notifyListeners(Step step)	Notifies all listeners
void	tickHappened(TickEvent e)	Called by the object the listener is registered with to aleart the Ticklistener that a tick has happened

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, 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, 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, requestFocus, 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BORDER_THICKNESS

public static final int BORDER_THICKNESS

The thickness of the border around the button

See Also:

Constant Field Values

OFF_COLOUR

public static final Color OFF_COLOUR

the off colour for a togglable button's boarder

ON_COLOUR

public static final Color ON_COLOUR

the on colour for a togglable button's boarder

m_Listeners

protected List<AnnotationListener> m_Listeners

The list of listeners registered with this panel

m_Binding

protected Binding m_Binding

The binding this panel manages

m_VideoPlayer

protected VLCjDirectRenderPanel m_VideoPlayer

The video player we're annotating for

m_Action

protected adams.gui.action.AbstractBaseAction m_Action

the action to perform when the binding is activate

m_Interval

protected long m_Interval

The Interval which this toggle runs at

m_IsToggleable

protected boolean m_IsToggleable

a bool to say if this is a toggleable binding or not

m_IsToggled

protected boolean m_IsToggled

a bool to say if this binding is currently toggled on

m_Button

protected adams.gui.core.BaseButton m_Button

a button to indicate when a binding is pressed or toggled on

Constructor Detail

AnnotationPanel

public AnnotationPanel()

Method Detail

configureAnnotationPanel

public void configureAnnotationPanel(Binding binding,
                                     VLCjDirectRenderPanel videoPlayer)

Constructs a AnnotationPanel

Parameters:

binding - the binding this panel manages

makeStep

protected void makeStep(Date timestamp)

Creates a step for a given timestamp and alerts the listeners

Parameters:

timestamp - the timestamp for the step

initialize

protected void initialize()

Overrides:

initialize in class adams.gui.core.BasePanel

initGUI

protected void initGUI()

Overrides:

initGUI in class adams.gui.core.BasePanel

finishInit

protected void finishInit()

Overrides:

finishInit in class adams.gui.core.BasePanel

addListener

public void addListener(AnnotationListener listener)

Adds a listener to this panel

Parameters:

listener - the listener to add

addKeyBinding

protected adams.gui.action.AbstractBaseAction addKeyBinding(Binding binding)

Adds a binding to the panel

Parameters:

binding - : binding to add

Returns:

notifyListeners

protected void notifyListeners(Step step)

Notifies all listeners

Parameters:

step - the step to send in the notification

tickHappened

public void tickHappened(TickEvent e)

Description copied from interface: TickListener

Called by the object the listener is registered with to aleart the Ticklistener that a tick has happened

Specified by:

tickHappened in interface TickListener

Parameters:

e - an event that contains information about the tick

getInterval

public long getInterval()

Specified by:

getInterval in interface TickListener