ChordSet

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> virtuosotechnologies >> asaph >> [ model overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.virtuosotechnologies.asaph.model.ChordSet

SOURCE |

Download com.virtuosotechnologies.asaph.model.ChordSet

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.virtuosotechnologies.asaph.model
Interface ChordSet

All Superinterfaces:: SongMember

public interface ChordSet
extends SongMember

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

Method Summary

ChordSetKey addAlternateKey(com.virtuosotechnologies.asaph.model.notation.Note note, javax.swing.event.UndoableEditListener undoListener)
          Add a new alternate key to the chord set.

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 set.

ChordSetKey getNativeKey()
          Get the ChordSetKey representing the native key signature.

ChordSetKey getNextAlternateKey(ChordSetKey reference)
          Get the next alternate key following reference.

ChordSetKey getPreviousAlternateKey(ChordSetKey reference)
          Get the previous alternate key preceding reference.

java.lang.String getSerializableID()
          Get a string ID that can be used to serialize references to this ChordSet.

void removeAlternateKey(ChordSetKey alternateKey, javax.swing.event.UndoableEditListener undoListener)
          Remove the given alternate key from the chord set.

Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember

getSong, isDefunct

Method Detail

getName

public SimpleString getName()

Get a SimpleString containing the name of the chord set. Every ChordSet 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 ChordSet will have a key signature type, even if it is the empty string.

getNativeKey

public ChordSetKey getNativeKey()

Get the ChordSetKey representing the native key signature.

getAlternateKeyCount

public int getAlternateKeyCount()

Get the number of alternate keys

getNextAlternateKey

public ChordSetKey getNextAlternateKey(ChordSetKey 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 ChordSetKey getPreviousAlternateKey(ChordSetKey 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;

getSerializableID

public java.lang.String getSerializableID()

Get a string ID that can be used to serialize references to this ChordSet. The ID is guaranteed to be unique among ChordSets within the owning Song, and will remain the same for the same ChordSet across different executions of the tool. However, two ChordSets from different Songs may have the same string ID, and the same string ID may be shared between SongBlocks, Variations and ChordSets within the same Song.

addAlternateKey

public ChordSetKey addAlternateKey(com.virtuosotechnologies.asaph.model.notation.Note note,
                                   javax.swing.event.UndoableEditListener undoListener)

Add a new alternate key to the chord set.

removeAlternateKey

public void removeAlternateKey(ChordSetKey alternateKey,
                               javax.swing.event.UndoableEditListener undoListener)

Remove the given alternate key from the chord set.