Package org.jjazz.phrase.api.ui

Class PhraseBirdsEyeViewComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jjazz.phrase.api.ui.PhraseBirdsEyeViewComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible

public class PhraseBirdsEyeViewComponent
extends JPanel
implements PropertyChangeListener

A component to show a "bird's eye view" of whole or part of a Phrase.

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.Component

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BAR_GRADATION_LENGTH
static final int	BEAT_GRADATION_LENGTH
static final int	MIN_HEIGHT
static final int	MIN_WIDTH
static final int	PREF_BAR_WIDTH
static final int	PREF_HEIGHT

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

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
PhraseBirdsEyeViewComponent()

Method Summary

Modifier and Type	Method	Description
FloatRange	getBeatRange()	The beat range shown in this component.
String	getLabel()
float	getMarkerPosition()
Phrase	getModel()
int	getShowVelocityMode()	Get the show velocity mode.
TimeSignature	getTimeSignature()	Can be null.
void	paintComponent(Graphics g)
void	propertyChange(PropertyChangeEvent evt)
void	setBeatRange(FloatRange beatRange)	Set the beat range shown in this component.
void	setLabel(String label)	Add a label in the top left corner.
void	setMarkerPosition(float pos)	Set the position of the marker.
void	setModel(Phrase model, TimeSignature ts, FloatRange beatRange)	Set the Phrase model.
void	setShowVelocityMode(int showVelocityMode)	Set the show velocity mode.
void	setTransferHandler(TransferHandler th)	Overridden to also automatically enable mouse drag listener to initiate the drag (if th is not null) .

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MIN_HEIGHT

public static final int MIN_HEIGHT

See Also:

• Constant Field Values

MIN_WIDTH

public static final int MIN_WIDTH

See Also:

• Constant Field Values

PREF_HEIGHT

public static final int PREF_HEIGHT

See Also:

• Constant Field Values

PREF_BAR_WIDTH

public static final int PREF_BAR_WIDTH

See Also:

• Constant Field Values

BAR_GRADATION_LENGTH

public static final int BAR_GRADATION_LENGTH

See Also:

• Constant Field Values

BEAT_GRADATION_LENGTH

public static final int BEAT_GRADATION_LENGTH

See Also:

• Constant Field Values

Constructor Details

PhraseBirdsEyeViewComponent

public PhraseBirdsEyeViewComponent()

Method Details

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

Add a label in the top left corner.

Parameters:

label - if null no label is shown

setMarkerPosition

public void setMarkerPosition(float pos)

Set the position of the marker.

Parameters:

pos - If -1, marker is not shown.

getMarkerPosition

public float getMarkerPosition()

paintComponent

public void paintComponent(Graphics g)

setTransferHandler

public void setTransferHandler(TransferHandler th)

Overridden to also automatically enable mouse drag listener to initiate the drag (if th is not null) .

Overrides:

setTransferHandler in class JComponent

Parameters:

th -

getModel

public Phrase getModel()

getShowVelocityMode

public int getShowVelocityMode()

Get the show velocity mode.

Returns:

See Also:

• setShowVelocityMode(int)

setShowVelocityMode

public void setShowVelocityMode(int showVelocityMode)

Set the show velocity mode.

Parameters:

showVelocityMode - 0=don't show velocity. 1=use variation of the foreground color. 2=use different color shades.

setModel

public void setModel(Phrase model,
 TimeSignature ts,
 FloatRange beatRange)

Set the Phrase model.

Parameters:

model -

ts - If null bar lines will not be drawn

beatRange - Can't be an empty range

getBeatRange

public FloatRange getBeatRange()

The beat range shown in this component.

Returns:

setBeatRange

public void setBeatRange(FloatRange beatRange)

Set the beat range shown in this component.

Parameters:

beatRange - Must be consistent with the model Phrase/TimeSignature

getTimeSignature

public TimeSignature getTimeSignature()

Can be null.

Returns:

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener