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

Quick Search    Search Deep

com.virtuosotechnologies.asaph.model
Interface SongLine  view SongLine download SongLine.java

All Superinterfaces:
SongMember

public interface SongLine
extends SongMember

This interface represents a line in a song. A line is made up of a sequence of SongLineMembers, which are strings, comments or chord annotations. Lines are contained within SongBlocks.


Method Summary
 int getIndentLevel()
          Get the indent level
 int getMemberCount()
          Get the number of members
 int getMemberCount(ChordSet set)
          Get the number of members in the given chord set
 SongLineMember getNextMember(SongLineMember reference)
          Get the next member following reference.
 SongLineMember getNextMember(SongLineMember reference, ChordSet set)
          Get the next member following reference.
 SongLineMember getNthMember(int n)
          Get the nth member
 SongLineMember getNthMember(int n, ChordSet set)
          Get the nth member
 SongLineMember getPreviousMember(SongLineMember reference)
          Get the previous member preceding reference.
 SongLineMember getPreviousMember(SongLineMember reference, ChordSet set)
          Get the previous member preceding reference.
 SongBlock getSongBlock()
          Get the containing song block
 ChordAnnotation insertChordAnnotationAfter(SongLineMember after, ChordSet cs, com.virtuosotechnologies.asaph.model.notation.Chord primary, com.virtuosotechnologies.asaph.model.notation.Chord[] preceding, com.virtuosotechnologies.asaph.model.notation.Chord[] following, javax.swing.event.UndoableEditListener undoListener)
          Add a chord annotation at the given position.
 ChordAnnotation insertChordAnnotationBefore(SongLineMember before, ChordSet cs, com.virtuosotechnologies.asaph.model.notation.Chord primary, com.virtuosotechnologies.asaph.model.notation.Chord[] preceding, com.virtuosotechnologies.asaph.model.notation.Chord[] following, javax.swing.event.UndoableEditListener undoListener)
          Add a chord annotation at the given position.
 CommentString insertCommentStringAfter(SongLineMember after, java.lang.String str, javax.swing.event.UndoableEditListener undoListener)
          Add a comment string at the given position.
 CommentString insertCommentStringBefore(SongLineMember before, java.lang.String str, javax.swing.event.UndoableEditListener undoListener)
          Add a comment string at the given position.
 TextString insertTextStringAfter(SongLineMember after, java.lang.String str, javax.swing.event.UndoableEditListener undoListener)
          Add a text string at the given position.
 TextString insertTextStringBefore(SongLineMember before, java.lang.String str, javax.swing.event.UndoableEditListener undoListener)
          Add a text string at the given position.
 void removeMember(SongLineMember member, javax.swing.event.UndoableEditListener undoListener)
          Remove the given member.
 void setIndentLevel(int indent, javax.swing.event.UndoableEditListener undoListener)
          Set the indent level
 
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember
getSong, isDefunct
 

Method Detail

getSongBlock

public SongBlock getSongBlock()
Get the containing song block


getIndentLevel

public int getIndentLevel()
Get the indent level


getMemberCount

public int getMemberCount()
Get the number of members


getNthMember

public SongLineMember getNthMember(int n)
Get the nth member


getNextMember

public SongLineMember getNextMember(SongLineMember reference)
Get the next member following reference. If reference is null, returns the first member. If reference is the last member, returns null;


getPreviousMember

public SongLineMember getPreviousMember(SongLineMember reference)
Get the previous member preceding reference. If reference is null, returns the last member. If reference is the first member, returns null;


getMemberCount

public int getMemberCount(ChordSet set)
Get the number of members in the given chord set


getNthMember

public SongLineMember getNthMember(int n,
                                   ChordSet set)
Get the nth member


getNextMember

public SongLineMember getNextMember(SongLineMember reference,
                                    ChordSet set)
Get the next member following reference. If reference is null, returns the first member. If reference is the last member, returns null;


getPreviousMember

public SongLineMember getPreviousMember(SongLineMember reference,
                                        ChordSet set)
Get the previous member preceding reference. If reference is null, returns the last member. If reference is the first member, returns null;


setIndentLevel

public void setIndentLevel(int indent,
                           javax.swing.event.UndoableEditListener undoListener)
Set the indent level


insertTextStringBefore

public TextString insertTextStringBefore(SongLineMember before,
                                         java.lang.String str,
                                         javax.swing.event.UndoableEditListener undoListener)
Add a text string at the given position.


insertTextStringAfter

public TextString insertTextStringAfter(SongLineMember after,
                                        java.lang.String str,
                                        javax.swing.event.UndoableEditListener undoListener)
Add a text string at the given position.


insertCommentStringBefore

public CommentString insertCommentStringBefore(SongLineMember before,
                                               java.lang.String str,
                                               javax.swing.event.UndoableEditListener undoListener)
Add a comment string at the given position.


insertCommentStringAfter

public CommentString insertCommentStringAfter(SongLineMember after,
                                              java.lang.String str,
                                              javax.swing.event.UndoableEditListener undoListener)
Add a comment string at the given position.


insertChordAnnotationBefore

public ChordAnnotation insertChordAnnotationBefore(SongLineMember before,
                                                   ChordSet cs,
                                                   com.virtuosotechnologies.asaph.model.notation.Chord primary,
                                                   com.virtuosotechnologies.asaph.model.notation.Chord[] preceding,
                                                   com.virtuosotechnologies.asaph.model.notation.Chord[] following,
                                                   javax.swing.event.UndoableEditListener undoListener)
Add a chord annotation at the given position.


insertChordAnnotationAfter

public ChordAnnotation insertChordAnnotationAfter(SongLineMember after,
                                                  ChordSet cs,
                                                  com.virtuosotechnologies.asaph.model.notation.Chord primary,
                                                  com.virtuosotechnologies.asaph.model.notation.Chord[] preceding,
                                                  com.virtuosotechnologies.asaph.model.notation.Chord[] following,
                                                  javax.swing.event.UndoableEditListener undoListener)
Add a chord annotation at the given position.


removeMember

public void removeMember(SongLineMember member,
                         javax.swing.event.UndoableEditListener undoListener)
Remove the given member.