Package org.jjazz.song.api

Class StructuralChangeListener

java.lang.Object

org.jjazz.song.api.StructuralChangeListener

All Implemented Interfaces:

PropertyChangeListener, EventListener, ClsChangeListener, SgsChangeListener

public class StructuralChangeListener
extends Object
implements ClsChangeListener, SgsChangeListener, PropertyChangeListener

A song listener to detect a structural change in the song: bar added or removed, time signature changed, section moved.

Chord symbols changes or rhythm parameter changes are not structural changes.

The listener automatically unregisters itself if song is closed.

Constructor Summary

Constructors

Constructor	Description
StructuralChangeListener(Song song, ChangeListener listener)	Create a listener for structural changes in the song.

Method Summary

Modifier and Type	Method	Description
void	authorizeChange(ClsChangeEvent e)	Some change events might need to be authorized by all listeners before being processed by chordLeadSheetChanged().
void	authorizeChange(SgsChangeEvent e)	Some change events might need to be authorized by all listeners before being processed by songStructureChanged().
void	chordLeadSheetChanged(ClsChangeEvent event)	Process the change.
void	cleanup()
void	propertyChange(PropertyChangeEvent evt)
void	songStructureChanged(SgsChangeEvent event)	Process the change.

Methods inherited from class java.lang.Object

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

Constructor Details

StructuralChangeListener

public StructuralChangeListener(Song song,
 ChangeListener listener)

Create a listener for structural changes in the song.

Parameters:

song -

listener - Called when a structural change occured.

Method Details

cleanup

public void cleanup()

authorizeChange

public void authorizeChange(ClsChangeEvent e)
                     throws UnsupportedEditException

Description copied from interface: ClsChangeListener

Some change events might need to be authorized by all listeners before being processed by chordLeadSheetChanged().

Specified by:

authorizeChange in interface ClsChangeListener

Parameters:

e - The change to authorize.

Throws:

UnsupportedEditException - Listener shall throw this exception if change is not acceptable. Exception message might be shown to user to explain the problem.

chordLeadSheetChanged

public void chordLeadSheetChanged(ClsChangeEvent event)

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

authorizeChange

public void authorizeChange(SgsChangeEvent e)
                     throws UnsupportedEditException

Description copied from interface: SgsChangeListener

Some change events might need to be authorized by all listeners before being processed by songStructureChanged().

Specified by:

authorizeChange in interface SgsChangeListener

Parameters:

e - The change to authorize.

Throws:

UnsupportedEditException - Listener shall throw this exception if change is not acceptable. Exception message might be shown to user to explain the problem.

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

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener