Class SgsChangeEvent

java.lang.Object
org.jjazz.songstructure.api.event.SgsChangeEvent
Direct Known Subclasses:
RpValueChangedEvent, SptAddedEvent, SptRemovedEvent, SptRenamedEvent, SptResizedEvent, SptRhythmParentSectionChangedEvent
public class SgsChangeEvent extends Object
Describe a change in a SongStructure.

  • Constructor Details

  • Method Details

    • getSongPart

      public SongPart getSongPart()
      Returns:
      The first SongPart, i.e. which has the lowest startBarIndex. Can be null.

    • getSongParts

      public List<SongPart> getSongParts()
      Returns:
      A list of SongParts ordered by startBarIndex (lowest first). Can be empty.

    • getSource

      public SongStructure getSource()

    • setIsUndo

      public void setIsUndo()
      Set isUndo to true.

    • setIsRedo

      public void setIsRedo()
      Set isRedo to true.

    • isUndo

      public boolean isUndo()
      True if this is an undo event, i.e. this event's change was just undone.
      Returns:
      See Also:

    • isRedo

      public boolean isRedo()
      True if this is a redo event, i.e. this event's change was just redone.
      Returns:
      See Also:

    • isUndoOrRedo

      public boolean isUndoOrRedo()

    • getRhythms

      public Set<Rhythm> getRhythms(boolean excludeAdaptedRhythms)
      The unique rhythms used by the SongParts.
      Parameters:
      excludeAdaptedRhythms - If true and an AdaptedRhythm is found, return its source rhythm instead
      Returns:

    • addSongPartChanges

      public void addSongPartChanges(List<PropertyChangeEvent> changes)
      Add some SongPart change events generated by this change.
      Parameters:
      changes -

    • getSongPartChanges

      public List<PropertyChangeEvent> getSongPartChanges()
      Get the SongPart change events generated by this change.
      Returns:
      Can be empty

    • sortSongParts

      public static List<SongPart> sortSongParts(Collection<SongPart> spts)
      Return a sorted unmodifiable list.
      Parameters:
      spts -
      Returns: