Class SgsVetoableChangeEvent

java.lang.Object

org.jjazz.songstructure.api.event.SgsChangeEvent

org.jjazz.songstructure.api.event.SgsVetoableChangeEvent

public class SgsVetoableChangeEvent
extends SgsChangeEvent

A special vetoable event sent before performing a SongStructure change that can be vetoed by its listeners.

For example replaceSongParts() can be vetoed by a listener if there is not enough Midi channels.

All the SongStructure methods which throw UnsupportedEditException send a SgsVetoableChangeEvent. The listener is responsible to analyze the passed SgsChangeEvent and throw an UnsupportedEditException (with an user error message) to veto the change.

See Also:

• SongStructure
• UnsupportedEditException

Constructor Summary

Constructors

Constructor	Description
SgsVetoableChangeEvent(SongStructure src, SgsChangeEvent changeEvent)

Method Summary

Modifier and Type	Method	Description
SgsChangeEvent	getChangeEvent()

Methods inherited from class org.jjazz.songstructure.api.event.SgsChangeEvent

getSongPart, getSongParts, getSource, sortSongParts

Methods inherited from class java.lang.Object

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

Constructor Details

SgsVetoableChangeEvent

public SgsVetoableChangeEvent(SongStructure src,
 SgsChangeEvent changeEvent)

Method Details

getChangeEvent

public SgsChangeEvent getChangeEvent()

Returns:

The event corresponding to the change about to be performed -unless it is vetoed by a listener.