org.deepsymmetry.beatlink.data

Class WaveformDetailComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.deepsymmetry.beatlink.data.WaveformDetailComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class WaveformDetailComponent
extends JComponent

Provides a convenient way to draw waveform detail in a user interface, including annotations like the location at the current time, and cue point markers (if you supply TrackMetadata so their location can be determined), and beat markers (if you also supply a BeatGrid). Can also be configured to automatically update itself to reflect the state of a specified player, showing the current track, playback state, and position, as long as it is able to load appropriate metadata.

See Also:

Serialized Form

Nested Class Summary

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 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
WaveformDetailComponent(int player) Create a view which updates itself to reflect the track loaded on a particular player, and that player's playback progress.
WaveformDetailComponent(WaveformDetail waveform, TrackMetadata metadata, BeatGrid beatGrid) Create a view which draws a specific waveform, even if it is not currently loaded in a player.

Method Summary

Modifier and Type	Method and Description
static Color	cueColor(CueList.Entry entry) Determine the color to use to draw a cue list entry.
Dimension	getMinimumSize()
protected void	paintComponent(Graphics g)
void	setMonitoredPlayer(int player) Configures the player whose current track waveforms and status will automatically be reflected.
void	setPlaybackPosition(long milliseconds) Set the current playback position.
void	setPlaying(boolean playing) Set whether the player holding the waveform is playing, which changes the indicator color to white from red.
void	setScale(int scale) Set the zoom scale of the view.
void	setWaveform(WaveformDetail waveform, TrackMetadata metadata, BeatGrid beatGrid) Change the waveform preview being drawn.
String	toString()

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, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI

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, getAccessibleContext, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

WaveformDetailComponent

public WaveformDetailComponent(int player)

Create a view which updates itself to reflect the track loaded on a particular player, and that player's playback progress.

Parameters:

player - the player number to monitor, or zero if it should start out monitoring no player

WaveformDetailComponent

public WaveformDetailComponent(WaveformDetail waveform,
                               TrackMetadata metadata,
                               BeatGrid beatGrid)

Create a view which draws a specific waveform, even if it is not currently loaded in a player.

Parameters:

waveform - the waveform detail to display

metadata - information about the track whose waveform we are drawing, so we can draw cues and memory points

beatGrid - the locations of the beats, so they can be drawn

Method Detail

setPlaybackPosition

public void setPlaybackPosition(long milliseconds)

Set the current playback position. Will cause the component to be redrawn if the position has changed. This will be quickly overruled if a player is being monitored, but can be used in other contexts.

Parameters:

milliseconds - how far into the track has been played

setScale

public void setScale(int scale)

Set the zoom scale of the view. a value of (the smallest allowed) draws the waveform at full scale. Larger values combine more and more segments into a single column of pixels, zooming out to see more at once.

Parameters:

scale - the number of waveform segments that should be averaged into a single column of pixels

Throws:

IllegalArgumentException - if scale is less than 1 or greater than 256

setPlaying

public void setPlaying(boolean playing)

Set whether the player holding the waveform is playing, which changes the indicator color to white from red.

Parameters:

playing - if true, draw the position marker in white, otherwise red

setWaveform

public void setWaveform(WaveformDetail waveform,
                        TrackMetadata metadata,
                        BeatGrid beatGrid)

Change the waveform preview being drawn. This will be quickly overruled if a player is being monitored, but can be used in other contexts.

Parameters:

waveform - the waveform detail to display

metadata - information about the track whose waveform we are drawing, so we can draw cue and memory points

beatGrid - the locations of the beats, so they can be drawn

setMonitoredPlayer

public void setMonitoredPlayer(int player)

Configures the player whose current track waveforms and status will automatically be reflected. Whenever a new track is loaded on that player, the waveform and metadata will be updated, and the current playback position and state of the player will be reflected by the component.

Parameters:

player - the player number to monitor, or zero if monitoring should stop

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

cueColor

public static Color cueColor(CueList.Entry entry)

Determine the color to use to draw a cue list entry. Hot cues are green, ordinary memory points are red, and loops are orange.

Parameters:

entry - the entry being drawn

Returns:

the color with which it should be represented.

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

toString

public String toString()

Overrides:

toString in class Component