Class CL_BarEditorDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.jjazz.cl_editor.spi.CL_BarEditorDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, DisplayTransposableRenderer

public abstract class CL_BarEditorDialog
extends JDialog
implements DisplayTransposableRenderer

A JDialog used to edit a ChordLeadSheet bar.

The Dialog should not directly change the model, it should just return the proposed changes. The calling application will update the model (if dialog returned OK) and manage the undo/redo aspects.

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 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
CL_BarEditorDialog()	Dialog is automatically owned by WindowManager.getDefault().getMainWindow()

Method Summary

Modifier and Type	Method	Description
abstract void	cleanup()	Cleanup references to preset data and dialog results.
abstract List<ChordLeadSheetItem>	getAddedItems()	The new items that should be inserted in the bar.
abstract Map<ChordLeadSheetItem,Object>	getChangedItems()	The Items for which data should be changed.
static CL_BarEditorDialog	getDefault()
abstract int	getDisplayTransposition()
abstract List<ChordLeadSheetItem>	getRemovedItems()	The items that should be removed in the bar.
abstract CLI_Section	getSection()	Return the section which should be inserted, or used to update bar's existing section.
abstract boolean	isExitOk()
abstract void	preset(Preset preset, ChordLeadSheet cls, int barIndex, boolean swing)	Preset the dialog before using it.
abstract void	setDisplayTransposition(int dt)	Must be called before calling preset() to be effective.

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

Constructor Details

CL_BarEditorDialog

public CL_BarEditorDialog()

Dialog is automatically owned by WindowManager.getDefault().getMainWindow()

Method Details

getDefault

public static CL_BarEditorDialog getDefault()

preset

public abstract void preset(Preset preset,
 ChordLeadSheet cls,
 int barIndex,
 boolean swing)

Preset the dialog before using it.

Method must take into account a possible display transposition if it was previously set.

Parameters:

preset -

cls - ChordLeadSheet

barIndex -

swing - If true the bar is in swing mode, eg half-bar position for a 3/4 rhythm is 5/3=1.666...

See Also:

• setDisplayTransposition(int)

isExitOk

public abstract boolean isExitOk()

Returns:

True if dialog was exited OK, false if dialog operation was cancelled.

getSection

public abstract CLI_Section getSection()

Return the section which should be inserted, or used to update bar's existing section.

Returns:

Can be null if section data (name or timesignature) has not changed.

getAddedItems

public abstract List<ChordLeadSheetItem> getAddedItems()

The new items that should be inserted in the bar.

Returns:

Can be empty if no items inserted.

getRemovedItems

public abstract List<ChordLeadSheetItem> getRemovedItems()

The items that should be removed in the bar.

Returns:

Can be empty if no items to remove.

getChangedItems

public abstract Map<ChordLeadSheetItem,Object> getChangedItems()

The Items for which data should be changed.

Returns:

Can be empty. Associate the new data for each changed item.

cleanup

public abstract void cleanup()

Cleanup references to preset data and dialog results.

setDisplayTransposition

public abstract void setDisplayTransposition(int dt)

Must be called before calling preset() to be effective.

Specified by:

setDisplayTransposition in interface DisplayTransposableRenderer

Parameters:

dt -

See Also:

• preset(org.jjazz.cl_editor.spi.Preset, org.jjazz.chordleadsheet.api.ChordLeadSheet, int, boolean)

getDisplayTransposition

public abstract int getDisplayTransposition()

Specified by:

getDisplayTransposition in interface DisplayTransposableRenderer