com.virtuosotechnologies.asaph.model
Interface ChordSetKey

All Superinterfaces:

SongMember

public interface ChordSetKey

extends SongMember

Specification of a key that a ChordSet could be in.

Method Summary

SimpleString	getInfoString() Get a SimpleString containing description info for the ChordSetKey.
Note	getKeyNote() Get the note for key signature.
void	setKeyNote(Note note, UndoableEditListener undoListener) Set the note for key signature

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

getSong, isDefunct

Method Detail

getInfoString

public SimpleString getInfoString()

Get a SimpleString containing description info for the ChordSetKey. Every ChordSetKey has a description, even if it is the empty string.

Returns:

description info SimpleString

getKeyNote

public Note getKeyNote()

Get the note for key signature. The note should normally never be null, but this method may return null if the data is corrupted.

Returns:

key signature note

setKeyNote

public void setKeyNote(Note note,
                       UndoableEditListener undoListener)

Set the note for key signature

Parameters:

note - new note

undoListener - listener to notify if an undoable edit is generated, or null to suppress generation of undoable edits

Throws:

NullPointerException - note was null