org.deepsymmetry.beatlink.data

Class WaveformPreviewComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.deepsymmetry.beatlink.data.WaveformPreviewComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class WaveformPreviewComponent
extends JComponent

Provides a convenient way to draw a waveform preview in a user interface, including annotations like the current time and minute markers (if you supply TrackMetadata so the total length can be determined), and cue markers (if you also supply a CueList). 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, which includes beat grids for translating beat numbers into track time.

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

Modifier and Type	Field and Description
static Color	BRIGHT_PLAYED The color for brighter sections of the already-played section of the playback progress bar.
static Color	DIM_PLAYED The color for darker sections of the already-played section of the playback progress bar.
static Color	DIM_UNPLAYED The color for the darker sections of hte not-yet-played sections of the playback progress bar.
static Color	INTENSE_COLOR The color at which segments of the waveform marked most intense are drawn.
static Color	NORMAL_COLOR The color at which non-intense waveform segments are drawn.

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
WaveformPreviewComponent(int player) Create a view which updates itself to reflect the track loaded on a particular player, and that player's playback progress.
WaveformPreviewComponent(WaveformPreview preview, TrackMetadata metadata) 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
Dimension	getMaximumSize()
Dimension	getMinimumSize()
Dimension	getPreferredSize()
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	setWaveformPreview(WaveformPreview preview, TrackMetadata metadata) 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, getNextFocusableComponent, getPopupLocation, 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

Field Detail

INTENSE_COLOR

public static final Color INTENSE_COLOR

The color at which segments of the waveform marked most intense are drawn.

NORMAL_COLOR

public static final Color NORMAL_COLOR

The color at which non-intense waveform segments are drawn.

BRIGHT_PLAYED

public static final Color BRIGHT_PLAYED

The color for brighter sections of the already-played section of the playback progress bar.

DIM_PLAYED

public static final Color DIM_PLAYED

The color for darker sections of the already-played section of the playback progress bar.

DIM_UNPLAYED

public static final Color DIM_UNPLAYED

The color for the darker sections of hte not-yet-played sections of the playback progress bar.

Constructor Detail

WaveformPreviewComponent

public WaveformPreviewComponent(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

WaveformPreviewComponent

public WaveformPreviewComponent(WaveformPreview preview,
                                TrackMetadata metadata)

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

Parameters:

preview - the waveform preview to display

metadata - information about the track whose waveform we are drawing, so we can translate times into positions

Method Detail

setPlaybackPosition

public void setPlaybackPosition(long milliseconds)

Set the current playback position. Will cause part of the component to be redrawn if the position has changed (and we have the TrackMetadata we need to translate the time into a position in the component). 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

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

setWaveformPreview

public void setWaveformPreview(WaveformPreview preview,
                               TrackMetadata metadata)

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:

preview - the waveform preview to display

metadata - information about the track whose waveform we are drawing, so we can translate times into positions

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

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

getMaximumSize

public Dimension getMaximumSize()

Overrides:

getMaximumSize in class JComponent

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

toString

public String toString()

Overrides:

toString in class Component