|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents a block of lines in a song. A Song consists of an ordered list of blocks, and each block consists of an ordered list of lines. Blocks also have an indent level.
Field Summary | |
static String |
CHORUS_TYPE
Well-known type value for chorus |
static String |
TYPE_FIELD
Type of block field. |
Method Summary | |
int |
getIndentLevel()
Get the indent level |
int |
getLineCount()
Get the number of lines |
SongLine |
getNextLine(SongLine reference)
Get the next line following reference. |
SongLine |
getNthLine(int n)
Get the nth line |
SongLine |
getPreviousLine(SongLine reference)
Get the previous line preceding reference. |
String |
getSerializableID()
Get a string ID that can be used to serialize references to this SongBlock. |
SongLine |
insertLineAfter(SongLine after,
UndoableEditListener undoListener)
Add a line at the given position. |
SongLine |
insertLineBefore(SongLine before,
UndoableEditListener undoListener)
Add a line at the given position. |
void |
removeLine(SongLine line,
UndoableEditListener undoListener)
Remove the given line. |
void |
setIndentLevel(int indent,
UndoableEditListener undoListener)
Set the indent level |
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember |
getSong, isDefunct |
Methods inherited from interface com.virtuosotechnologies.asaph.model.FieldContainer |
addBinaryField, addBinaryListField, addStringField, addStringListField, getFieldCount, getNamedField, getNextField, getNthField, getPreviousField, removeField |
Field Detail |
public static final String TYPE_FIELD
public static final String CHORUS_TYPE
Method Detail |
public int getIndentLevel()
public int getLineCount()
public SongLine getNthLine(int n)
n
- index
public SongLine getNextLine(SongLine reference)
reference
- reference SongLine
IllegalArgumentException
- reference is not a memberpublic SongLine getPreviousLine(SongLine reference)
reference
- reference SongLine
IllegalArgumentException
- reference is not a memberpublic String getSerializableID()
public 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 SongLine insertLineBefore(SongLine before, UndoableEditListener undoListener)
before
- insert before this line, or at the end if nullundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- before is not a memberpublic SongLine insertLineAfter(SongLine after, UndoableEditListener undoListener)
after
- insert after this line, or at the beginning if nullundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- after is not a memberpublic void removeLine(SongLine line, UndoableEditListener undoListener)
line
- line to removeundoListener
- listener to notify if an undoable edit is generated,
or null to suppress generation of undoable edits
IllegalArgumentException
- line is not present
NullPointerException
- line was null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |