Package org.jjazz.rpcustomeditorfactoryimpl.api

Class RealTimeRpEditorDialog<E>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.jjazz.ss_editor.rpviewer.spi.RpCustomEditor<E>

org.jjazz.rpcustomeditorfactoryimpl.api.RealTimeRpEditorDialog<E>

Type Parameters:

E - RhythmParameter value class

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class RealTimeRpEditorDialog<E>
extends RpCustomEditor<E>
implements PropertyChangeListener

A RpCustomEditor dialog implementation which lets user preview the RP value changes in real time (while the sequence is playing).

The dialog can be customized for a given RhythmParameter via the RealTimeRpEditorPanel panel which provides the RP value editing capability.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.Type

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PREVIEW_MAX_NB_BARS

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
RealTimeRpEditorDialog(RealTimeRpEditorComponent<E> comp)

Method Summary

Modifier and Type	Method	Description
static <T> SongPartContext	buildPreviewContext(SongPartContext sptContext, RhythmParameter<T> rp, T rpValue)	Create a preview SongContext which uses the specified rhythm parameter value.
int	getPreviewMaxNbBars()	Get the maximum number of bars used in the preview.
RhythmParameter<E>	getRhythmParameter()	The RhythmParameter whose value is edited in this dialog.
E	getRpValue()	Get the edited RpValue.
boolean	isExitOk()	Check if dialog was exited using OK
void	preset(E rpValue, SongPartContext sptContext)	Initialize the dialog before being shown.
void	propertyChange(PropertyChangeEvent evt)
void	setPreviewMaxNbBars(int previewMaxNbBars)	Set the maximum number of bars used in the preview.

Methods inherited from class javax.swing.JDialog

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PREVIEW_MAX_NB_BARS

public static final int DEFAULT_PREVIEW_MAX_NB_BARS

See Also:

• Constant Field Values

Constructor Details

RealTimeRpEditorDialog

public RealTimeRpEditorDialog(RealTimeRpEditorComponent<E> comp)

Method Details

getRhythmParameter

public RhythmParameter<E> getRhythmParameter()

Description copied from class: RpCustomEditor

The RhythmParameter whose value is edited in this dialog.

Specified by:

getRhythmParameter in class RpCustomEditor<E>

Returns:

preset

public void preset(E rpValue,
 SongPartContext sptContext)

Description copied from class: RpCustomEditor

Initialize the dialog before being shown.

Specified by:

preset in class RpCustomEditor<E>

Parameters:

rpValue - The RhythmParameter value

getRpValue

public E getRpValue()

Get the edited RpValue.

Specified by:

getRpValue in class RpCustomEditor<E>

Returns:

Value is meaningful only if isExitOk() is true.

isExitOk

public boolean isExitOk()

Check if dialog was exited using OK

Specified by:

isExitOk in class RpCustomEditor<E>

Returns:

False means user cancelled the operation.

getPreviewMaxNbBars

public int getPreviewMaxNbBars()

Get the maximum number of bars used in the preview.

Returns:

the previewMaxNbBars

setPreviewMaxNbBars

public void setPreviewMaxNbBars(int previewMaxNbBars)

Set the maximum number of bars used in the preview.

buildPreviewContext

public static <T> SongPartContext buildPreviewContext(SongPartContext sptContext,
 RhythmParameter<T> rp,
 T rpValue)

Create a preview SongContext which uses the specified rhythm parameter value.

Parameters:

rpValue -

Returns:

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener