|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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,
Chord primary,
Chord[] preceding,
Chord[] following,
UndoableEditListener undoListener)
Add a chord annotation at the given position. |
ChordAnnotation |
insertChordAnnotationBefore(SongLineMember before,
ChordSet cs,
Chord primary,
Chord[] preceding,
Chord[] following,
UndoableEditListener undoListener)
Add a chord annotation at the given position. |
TextString |
insertTextStringAfter(SongLineMember after,
String type,
String str,
UndoableEditListener undoListener)
Add a text string at the given position. |
TextString |
insertTextStringBefore(SongLineMember before,
String type,
String str,
UndoableEditListener undoListener)
Add a text string at the given position. |
void |
removeMember(SongLineMember member,
UndoableEditListener undoListener)
Remove the given member. |
void |
setIndentLevel(int indent,
UndoableEditListener undoListener)
Set the indent level |
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember |
getSong, isDefunct |
Method Detail |
public SongBlock getSongBlock()
public int getIndentLevel()
public int getMemberCount()
public SongLineMember getNthMember(int n)
n
- index
public SongLineMember getNextMember(SongLineMember reference)
reference
- reference SongLineMember
IllegalArgumentException
- reference is not a memberpublic SongLineMember getPreviousMember(SongLineMember reference)
reference
- reference SongLineMember
IllegalArgumentException
- reference is not a memberpublic int getMemberCount(ChordSet set)
set
- ChordSet to filter by, or null for no chords
public SongLineMember getNthMember(int n, ChordSet set)
n
- indexset
- ChordSet to filter by, or null for no chords
public SongLineMember getNextMember(SongLineMember reference, ChordSet set)
reference
- reference SongLineMemberset
- ChordSet to filter by, or null for no chords
IllegalArgumentException
- reference is not a memberpublic SongLineMember getPreviousMember(SongLineMember reference, ChordSet set)
reference
- reference SongLineMemberset
- ChordSet to filter by, or null for no chords
IllegalArgumentException
- reference is not a memberpublic void setIndentLevel(int indent, UndoableEditListener undoListener)
indent
- new indent levelundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable editspublic TextString insertTextStringBefore(SongLineMember before, String type, String str, UndoableEditListener undoListener)
before
- insert before this member, or at the end if nulltype
- type of stringstr
- string valueundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- before is not a member
NullPointerException
- str or type was nullpublic TextString insertTextStringAfter(SongLineMember after, String type, String str, UndoableEditListener undoListener)
after
- insert after this member, or at the beginning if nulltype
- type of stringstr
- string valueundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- after is not a member
NullPointerException
- str or type was nullpublic ChordAnnotation insertChordAnnotationBefore(SongLineMember before, ChordSet cs, Chord primary, Chord[] preceding, Chord[] following, UndoableEditListener undoListener)
before
- insert before this member, or at the end if nullcs
- ChordSet for the annotation. May not be null.primary
- primary chord for the annotation. May not be null.preceding
- array of preceding chords. May be null.following
- array of following chords. May be null.undoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- before or cs is not a member
NullPointerException
- cs was nullpublic ChordAnnotation insertChordAnnotationAfter(SongLineMember after, ChordSet cs, Chord primary, Chord[] preceding, Chord[] following, UndoableEditListener undoListener)
after
- insert after this member, or at the beginning if nullcs
- ChordSet for the annotation. May not be null.primary
- primary chord for the annotation. May not be null.preceding
- array of preceding chords. May be null.following
- array of following chords. May be null.undoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- after or cs is not a member
NullPointerException
- cs was nullpublic void removeMember(SongLineMember member, UndoableEditListener undoListener)
member
- member to removeundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- member is not a member
NullPointerException
- member was null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |