com.virtuosotechnologies.asaph.model
Interface StandardSongBlock

All Superinterfaces:
FieldContainer, SongBlock, SongMember

public interface StandardSongBlock
extends SongBlock

This interface represents a SongBlock that is normally present in a song, but may be omitted in some variations.


Field Summary
 
Fields inherited from interface com.virtuosotechnologies.asaph.model.SongBlock
CHORUS_TYPE, TYPE_FIELD
 
Method Summary
 Set getOmittingVariations()
          Get a set of Variations in which this block is omitted.
 void omitVariation(Variation variation, UndoableEditListener undoListener)
          Add a variation to the set of omitting variations.
 void unOmitVariation(Variation variation, UndoableEditListener undoListener)
          Remove a variation from the set of omitting variations.
 
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongBlock
getIndentLevel, getLineCount, getNextLine, getNthLine, getPreviousLine, getSerializableID, insertLineAfter, insertLineBefore, removeLine, setIndentLevel
 
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
 

Method Detail

getOmittingVariations

public Set getOmittingVariations()
Get a set of Variations in which this block is omitted.

Returns:
Set of Variations

omitVariation

public void omitVariation(Variation variation,
                          UndoableEditListener undoListener)
Add a variation to the set of omitting variations.

Parameters:
variation - Variation under which to omit this block.
undoListener - listener to notify if an undoable edit is generated, or null to suppress generation of undoable edits
Throws:
IllegalArgumentException - variation is not present
NullPointerException - variation was null

unOmitVariation

public void unOmitVariation(Variation variation,
                            UndoableEditListener undoListener)
Remove a variation from the set of omitting variations.

Parameters:
variation - Variation under which to no longer omit this block.
undoListener - listener to notify if an undoable edit is generated, or null to suppress generation of undoable edits
Throws:
IllegalArgumentException - variation is not present
NullPointerException - variation was null