Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

virtuoso.asaph.model
Interface ChordSystem  view ChordSystem download ChordSystem.java

All Superinterfaces:
SongMember

public interface ChordSystem
extends SongMember

A system of chords for a song. Most songs will only have one ChordSystem, but some may have multiple, especially if there are alternate tunes.


Method Summary
 ChordSystemKey addAlternateKey(virtuoso.asaph.model.types.Note note, javax.swing.event.UndoableEditListener undoListener)
          Add a new alternate key to the chord system.
 int getAlternateKeyCount()
          Get the number of alternate keys
 SimpleString getKeySignatureType()
          Get a SimpleString containing the key signature type.
 SimpleString getName()
          Get a SimpleString containing the name of the chord system.
 ChordSystemKey getNativeKey()
          Get the ChordSystemKey representing the native key signature.
 ChordSystemKey getNextAlternateKey(ChordSystemKey reference)
          Get the next alternate key following reference.
 ChordSystemKey getPreviousAlternateKey(ChordSystemKey reference)
          Get the previous alternate key preceding reference.
 void removeAlternateKey(ChordSystemKey alternateKey, javax.swing.event.UndoableEditListener undoListener)
          Remove the given alternate key from the chord system.
 
Methods inherited from interface virtuoso.asaph.model.SongMember
isDefunct
 

Method Detail

getName

public SimpleString getName()
Get a SimpleString containing the name of the chord system. Every ChordSystem will have a name, even if it is the empty string.


getKeySignatureType

public SimpleString getKeySignatureType()
Get a SimpleString containing the key signature type. This string is typically the string that gets concatenated to the note to form a key signature. Often it begins with a space. Every ChordSystem will have a key signature type, even if it is the empty string.


getNativeKey

public ChordSystemKey getNativeKey()
Get the ChordSystemKey representing the native key signature.


getAlternateKeyCount

public int getAlternateKeyCount()
Get the number of alternate keys


getNextAlternateKey

public ChordSystemKey getNextAlternateKey(ChordSystemKey reference)
Get the next alternate key following reference. If reference is null, returns the first alternate key. If reference is the last alternate key, returns null;


getPreviousAlternateKey

public ChordSystemKey getPreviousAlternateKey(ChordSystemKey reference)
Get the previous alternate key preceding reference. If reference is null, returns the last alternate key. If reference is the first alternate key, returns null;


addAlternateKey

public ChordSystemKey addAlternateKey(virtuoso.asaph.model.types.Note note,
                                      javax.swing.event.UndoableEditListener undoListener)
Add a new alternate key to the chord system.


removeAlternateKey

public void removeAlternateKey(ChordSystemKey alternateKey,
                               javax.swing.event.UndoableEditListener undoListener)
Remove the given alternate key from the chord system.