Package org.jjazz.ss_editor.sptviewer.api

Class SptViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jjazz.ss_editor.sptviewer.api.SptViewer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public abstract class SptViewer
extends JPanel

A base class for SongPart viewers.

Must keep itself updated by listening to model changes. User actions are sent to the controller.

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

Method Summary

Modifier and Type	Method	Description
abstract void	cleanup()
abstract DefaultRpViewerRendererFactory	getDefaultRpRendererFactory()
abstract SongPart	getModel()
abstract Rectangle	getRpViewerRectangle(RhythmParameter<?> rp)
abstract SptViewerSettings	getSettings()
abstract int	getZoomHFactor()
abstract int	getZoomVFactor()
abstract void	setController(SptViewerMouseListener controller)
abstract void	setFocusOnRpViewer(RhythmParameter<?> rp)
abstract void	setMultiSelectMode(boolean b, boolean first)
abstract void	setNameVisible(boolean b)
abstract void	setRhythmVisible(boolean b)	True by default.
abstract void	setSelected(boolean b)
abstract void	setSelected(RhythmParameter<?> rp, boolean b)
abstract void	setTimeSignatureVisible(boolean b)
abstract void	setVisibleRps(List<RhythmParameter<?>> rps)
abstract void	setZoomHFactor(int factor)	Horizontal zoom factor.
abstract void	setZoomVFactor(int factor)	Vertical zoom factor.
abstract void	showPlaybackPoint(boolean show, Position pos)	Show a playback point in the editor at specified position.

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

Constructor Details

SptViewer

public SptViewer()

Method Details

getModel

public abstract SongPart getModel()

getSettings

public abstract SptViewerSettings getSettings()

getDefaultRpRendererFactory

public abstract DefaultRpViewerRendererFactory getDefaultRpRendererFactory()

setController

public abstract void setController(SptViewerMouseListener controller)

setSelected

public abstract void setSelected(boolean b)

setSelected

public abstract void setSelected(RhythmParameter<?> rp,
 boolean b)

setZoomHFactor

public abstract void setZoomHFactor(int factor)

Horizontal zoom factor.

Parameters:

factor - 0=min zoom (bird's view), 100=max zoom

getZoomHFactor

public abstract int getZoomHFactor()

setZoomVFactor

public abstract void setZoomVFactor(int factor)

Vertical zoom factor.

Parameters:

factor - 0=min zoom (bird's view), 100=max zoom

getZoomVFactor

public abstract int getZoomVFactor()

setFocusOnRpViewer

public abstract void setFocusOnRpViewer(RhythmParameter<?> rp)

setVisibleRps

public abstract void setVisibleRps(List<RhythmParameter<?>> rps)

getRpViewerRectangle

public abstract Rectangle getRpViewerRectangle(RhythmParameter<?> rp)

setRhythmVisible

public abstract void setRhythmVisible(boolean b)

True by default.

Parameters:

b -

setMultiSelectMode

public abstract void setMultiSelectMode(boolean b,
 boolean first)

Parameters:

b - True if this SptViewer is this Spt is part of a multi-selection

first - True if this SptViewer is the first Spt of a multi-selection

setNameVisible

public abstract void setNameVisible(boolean b)

setTimeSignatureVisible

public abstract void setTimeSignatureVisible(boolean b)

cleanup

public abstract void cleanup()

showPlaybackPoint

public abstract void showPlaybackPoint(boolean show,
 Position pos)

Show a playback point in the editor at specified position.

Parameters:

show - Show/hide the playback point.

pos - The position within the SongStructure model. Not used if b==false.