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

Quick Search    Search Deep

com.virtuosotechnologies.asaph.standardmodel
Class StdChordSetKey  view StdChordSetKey download StdChordSetKey.java

java.lang.Object
  extended bycom.virtuosotechnologies.lib.base.LinkedObject
      extended bycom.virtuosotechnologies.asaph.standardmodel.BaseSongMember
          extended bycom.virtuosotechnologies.asaph.standardmodel.StdChordSetKey
All Implemented Interfaces:
com.virtuosotechnologies.asaph.model.ChordSetKey, com.virtuosotechnologies.asaph.model.SongMember

class StdChordSetKey
extends BaseSongMember
implements com.virtuosotechnologies.asaph.model.ChordSetKey

Standard implementation of ChordSetKey


Nested Class Summary
(package private)  class StdChordSetKey.ParseHandler
           
 
Field Summary
private  StdSimpleString infoString_
           
private  com.virtuosotechnologies.asaph.model.notation.Note keyNote_
           
 
Fields inherited from class com.virtuosotechnologies.lib.base.LinkedObject
 
Constructor Summary
(package private) StdChordSetKey(StdChordSet parent, com.virtuosotechnologies.asaph.model.notation.Note keyNote, java.lang.String infoString)
           
 
Method Summary
 com.virtuosotechnologies.asaph.model.SimpleString getInfoString()
          Get a SimpleString containing description info for the ChordSetKey.
 com.virtuosotechnologies.asaph.model.notation.Note getKeyNote()
          Get the note for key signature.
 com.virtuosotechnologies.asaph.model.Song getSong()
          Returns the Song containing this SongMember.
(package private)  void internalClearDefunct()
           
(package private)  BaseSongMember internalGetParent()
           
(package private)  void internalReportUndoableEdit(javax.swing.event.UndoableEditListener undoListener, javax.swing.undo.UndoableEdit edit)
           
(package private)  void internalSetDefunct()
           
 boolean isDefunct()
          Returns true if this object is defunct-- that is, if it or any of its ancestors has been removed.
 void setKeyNote(com.virtuosotechnologies.asaph.model.notation.Note note, javax.swing.event.UndoableEditListener undoListener)
          Set the note for key signature
(package private)  void unparse(com.virtuosotechnologies.lib.xml.XMLUnparser unparser, java.lang.String element)
           
 
Methods inherited from class com.virtuosotechnologies.lib.base.LinkedObject
getNext, getPrevious, linkThisAfter, linkThisBefore, unlinkThis
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember
getSong, isDefunct
 

Field Detail

infoString_

private StdSimpleString infoString_

keyNote_

private com.virtuosotechnologies.asaph.model.notation.Note keyNote_
Constructor Detail

StdChordSetKey

StdChordSetKey(StdChordSet parent,
               com.virtuosotechnologies.asaph.model.notation.Note keyNote,
               java.lang.String infoString)
Method Detail

unparse

void unparse(com.virtuosotechnologies.lib.xml.XMLUnparser unparser,
             java.lang.String element)
       throws java.io.IOException

getInfoString

public com.virtuosotechnologies.asaph.model.SimpleString getInfoString()
Get a SimpleString containing description info for the ChordSetKey. Every ChordSetKey has a description, even if it is the empty string.

Specified by:
getInfoString in interface com.virtuosotechnologies.asaph.model.ChordSetKey

getKeyNote

public com.virtuosotechnologies.asaph.model.notation.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.

Specified by:
getKeyNote in interface com.virtuosotechnologies.asaph.model.ChordSetKey

setKeyNote

public void setKeyNote(com.virtuosotechnologies.asaph.model.notation.Note note,
                       javax.swing.event.UndoableEditListener undoListener)
Set the note for key signature

Specified by:
setKeyNote in interface com.virtuosotechnologies.asaph.model.ChordSetKey

internalSetDefunct

void internalSetDefunct()

internalClearDefunct

void internalClearDefunct()

internalReportUndoableEdit

void internalReportUndoableEdit(javax.swing.event.UndoableEditListener undoListener,
                                javax.swing.undo.UndoableEdit edit)

internalGetParent

BaseSongMember internalGetParent()

isDefunct

public boolean isDefunct()
Returns true if this object is defunct-- that is, if it or any of its ancestors has been removed. If this returns true, the behavior of any other methods on this object is undefined.

Specified by:
isDefunct in interface com.virtuosotechnologies.asaph.model.SongMember

getSong

public com.virtuosotechnologies.asaph.model.Song getSong()
Returns the Song containing this SongMember. If this member is defunct, this will return the song that contained this member before the member was defuncted.

Specified by:
getSong in interface com.virtuosotechnologies.asaph.model.SongMember