org.openimaj.vis

Class VisualisationImpl<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openimaj.vis.VisualisationImpl<T>

Type Parameters:

T - The type of the data to be visualised

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AnimatedVisualisationListener, Visualisation<T>, VisualisationImageProvider

Direct Known Subclasses:

AudioOverviewVisualisation, AudioSpectrogram, AudioWaveform, BarVisualisationBasic, HeatMap, TimelineObjectAdapter, XYPlotVisualisation

public abstract class VisualisationImpl<T>
extends JPanel
implements ComponentListener, Visualisation<T>, AnimatedVisualisationListener

A top level class for visualisations. This class handles the creation of an image (MBFImage) for drawing the visualisation into. It also makes the visualisation available as a Swing JPanel and, using showWindow(String), allows the visualisation to be displayed in a window.

This class is abstract - it does not know how to paint the data on which it is typed. It is therefore necessary to subclass this class with specific implementations of visualisations for specific types. To do this, override the update() method in this class to draw the visualisation into the visImage member. The implementation of the update() method may call Component.repaint() if it so wishes to update any displays of the data. This is called automatically when setData(Object) is called to update the data object.

The class also allows for linking visualisations so that one visualisation can draw on top of another visualisation's output. However, the visualisations do not affect each other's visualisation images. If you call the constructor that takes a visualisation, this visualisation will become an overlay of the given visualisation. Each time the underlying visualisation is updated, a copy of the visualisation is stored in this visualisation for drawing as a background. This means that this visualisation can update more often than the underlying visualisation, however, it can be slow if the underlying visualisation updates often because it's making a copy of the image.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

See Also:

Serialized Form

Created:

27 Jul 2012

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
protected boolean	clearBeforeDraw Whether to clear the image before redrawing
protected T	data The data to be visualised
protected MBFImage	visImage The visualisation image

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

Modifier	Constructor and Description
protected	VisualisationImpl() Default constructor
	VisualisationImpl(int width, int height) Create a new visualisation with the given width and height
	VisualisationImpl(VisualisationImpl<?> overlayOn) Create a new visualisation using an existing image.

Method Summary

Modifier and Type	Method and Description
void	addOverlay(VisualisationImpl<?> v) Add an overlay to this visualisation
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
Dimension	getRequiredSize() Get the current required size of the vis
MBFImage	getVisualisationImage() Returns the image to which the bars will be drawn.
boolean	isAllowResize() Whether this visualisation can be resized.
void	newVisualisationAvailable(AnimatedVisualisationProvider avp) Called by the AnimatedVisualisationProvider when a new visualisation is available to drawn (but hasn't been drawn yet).
void	paint(Graphics g)
void	removeOverlay(VisualisationImpl<?> v) Remove the given overlay from this visualisation
void	setAllowResize(boolean allowResize) Set whether this visualisation can be resized.
void	setClearBeforeDraw(boolean tf) Sets whether to clear the image before drawing.
void	setData(T data) Set the data to be visualised.
void	setRequiredSize(Dimension d) Set the required size of the vis
JFrame	showWindow(String title) Show a window containing this visualisation
abstract void	update() Called to update the visualisation.
void	update(Graphics g)
void	updateVis() Call to force and update of the visualisation
void	updateVis(MBFImage overlay) Update the visualisation using the given image as the base image on which to overlay.

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

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

visImage

protected MBFImage visImage

The visualisation image

data

protected T data

The data to be visualised

clearBeforeDraw

protected boolean clearBeforeDraw

Whether to clear the image before redrawing

Constructor Detail

VisualisationImpl

protected VisualisationImpl()

Default constructor

VisualisationImpl

public VisualisationImpl(int width,
                         int height)

Create a new visualisation with the given width and height

Parameters:

width - The width

height - The height

VisualisationImpl

public VisualisationImpl(VisualisationImpl<?> overlayOn)

Create a new visualisation using an existing image.

Parameters:

overlayOn - The visualisation on which to overlay

Method Detail

addOverlay

public void addOverlay(VisualisationImpl<?> v)

Add an overlay to this visualisation

Parameters:

v - The visualisation to overlay on this visualisation

removeOverlay

public void removeOverlay(VisualisationImpl<?> v)

Remove the given overlay from this visualisation

Parameters:

v - The visualisation to remove

update

public abstract void update()

Called to update the visualisation. This method can expect the visImage member to be available and of the correct size. The method simply needs to draw the visualisation to this MBFImage. You should wrap any drawing code in a synchronized block, synchronized on the visImage - this stops the image being repainted to the screen half way through drawing.

Update is called from the paint() method so should ideally not force a repaint() as this will call a continuous repaint loop.

updateVis

public void updateVis()

Call to force and update of the visualisation

Specified by:

updateVis in interface VisualisationImageProvider

updateVis

public void updateVis(MBFImage overlay)

Update the visualisation using the given image as the base image on which to overlay.

Parameters:

overlay - The overlay

setData

public void setData(T data)

Set the data to be visualised.

Specified by:

setData in interface Visualisation<T>

Parameters:

data - The data to be visualised

getVisualisationImage

public MBFImage getVisualisationImage()

Returns the image to which the bars will be drawn.

Specified by:

getVisualisationImage in interface VisualisationImageProvider

Returns:

The image

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

See Also:

JComponent.paint(java.awt.Graphics)

update

public void update(Graphics g)

Overrides:

update in class JComponent

See Also:

JComponent.update(java.awt.Graphics)

showWindow

public JFrame showWindow(String title)

Show a window containing this visualisation

Parameters:

title - The title of the window

Returns:

The window that was created

isAllowResize

public boolean isAllowResize()

Whether this visualisation can be resized.

Returns:

TRUE if this visualisation can be resized.

setAllowResize

public void setAllowResize(boolean allowResize)

Set whether this visualisation can be resized.

Parameters:

allowResize - TRUE to allow the visualisation to be resizable

setRequiredSize

public void setRequiredSize(Dimension d)

Set the required size of the vis

Specified by:

setRequiredSize in interface VisualisationImageProvider

Parameters:

d - The required size

getRequiredSize

public Dimension getRequiredSize()

Get the current required size of the vis

Returns:

The required size

setClearBeforeDraw

public void setClearBeforeDraw(boolean tf)

Sets whether to clear the image before drawing. Has no effect if fade drawing is used.

Parameters:

tf - TRUE to clear the image

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

newVisualisationAvailable

public void newVisualisationAvailable(AnimatedVisualisationProvider avp)

Called by the AnimatedVisualisationProvider when a new visualisation is available to drawn (but hasn't been drawn yet).

Specified by:

newVisualisationAvailable in interface AnimatedVisualisationListener

Parameters:

avp - The source of the event

See Also:

AnimatedVisualisationListener.newVisualisationAvailable(org.openimaj.vis.AnimatedVisualisationProvider)