Class SongMetaEvents

java.lang.Object

org.jjazz.song.api.SongMetaEvents

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, ClsChangeListener, SgsChangeListener

public class SongMetaEvents
extends Object
implements ClsChangeListener, SgsChangeListener, PropertyChangeListener, VetoableChangeListener

A helper class which listens to lower-level Song/ChordLeadSheet/SongStructure change events to provide higher-level song change events.

Whenever possible change events are fired when all low-level changes are complete, in order to minimize the number of fired events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SongMetaEvents.ClsSourceActionEvent	A special ClsActionEvent which stores its related SgsActionEvent sub-events.
static class	SongMetaEvents.SgsSourceActionEvent	A special SgsActionEvent which stores its related ClsActionEvent sub-events.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_CLS_SGS_API_CHANGE_COMPLETE	Fired when the song modification initiated by a ChordLeadSheet/SongStructure API method is complete.
static final String	PROP_MUSIC_GENERATION	Fired when the "musical content" of the song is modified, i.e. any related music generation process should be updated or restarted.
static final String	PROP_SONG_STRUCTURE	Fired when at least one song bar was added/removed/moved, or a time signature was changed.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l)
void	chordLeadSheetChanged(ClsChangeEvent event)	Process the change.
static SongMetaEvents	getInstance(Song song)
Song	getSong()
void	propertyChange(PropertyChangeEvent e)
void	removePropertyChangeListener(PropertyChangeListener l)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener l)
void	songStructureChanged(SgsChangeEvent event)	Process the change.
void	vetoableChange(PropertyChangeEvent e)

Methods inherited from class java.lang.Object

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

Field Details

PROP_CLS_SGS_API_CHANGE_COMPLETE

public static final String PROP_CLS_SGS_API_CHANGE_COMPLETE

Fired when the song modification initiated by a ChordLeadSheet/SongStructure API method is complete.

OldValue=the source ClsSourceActionEvent/SgsSourceActionEvent that initially triggered the change.
NewValue=the optional associated data

See Also:

• Constant Field Values

PROP_MUSIC_GENERATION

public static final String PROP_MUSIC_GENERATION

Fired when the "musical content" of the song is modified, i.e. any related music generation process should be updated or restarted.

Source changes might contain e.g. chord symbol changes, inserted bars, rhythm parameter value changes -but not a section name change. Because a rhythm generation engine might adjust the generated music to the tempo, a song tempo change is considered as a musical content change.

OldValue=the Song property name or the source ClsSourceActionEvent/SgsSourceActionEvent that initially triggered the musical change.
NewValue=the optional associated data

See Also:

• Constant Field Values

PROP_SONG_STRUCTURE

public static final String PROP_SONG_STRUCTURE

Fired when at least one song bar was added/removed/moved, or a time signature was changed.

OldValue=the source ClsSourceActionEvent/SgsSourceActionEvent that initially triggered the change.
NewValue=the optional associated data

See Also:

• Constant Field Values

Method Details

getInstance

public static SongMetaEvents getInstance(Song song)

getSong

public Song getSong()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
 PropertyChangeListener l)

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

vetoableChange

public void vetoableChange(PropertyChangeEvent e)
                    throws PropertyVetoException

Specified by:

vetoableChange in interface VetoableChangeListener

Throws:

PropertyVetoException

chordLeadSheetChanged

public void chordLeadSheetChanged(ClsChangeEvent event)
                           throws UnsupportedEditException

Description copied from interface: ClsChangeListener

Process the change.

Note that this method might be called outside of the EDT.

Specified by:

chordLeadSheetChanged in interface ClsChangeListener

Parameters:

event -

Throws:

UnsupportedEditException - If a ClsVetoableChangeEvent is not authorized by a listener.

songStructureChanged

public void songStructureChanged(SgsChangeEvent event)

Description copied from interface: SgsChangeListener

Process the change.

Note that this method might be called outside of the EDT.

Specified by:

songStructureChanged in interface SgsChangeListener

Parameters:

event -