SongBlock

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> virtuosotechnologies >> asaph >> [ model overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.virtuosotechnologies.asaph.model.SongBlock

SOURCE |

Download com.virtuosotechnologies.asaph.model.SongBlock

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.virtuosotechnologies.asaph.model
Interface SongBlock

All Superinterfaces:: SongMember

All Known Subinterfaces:: AddedSongBlock, StandardSongBlock

public interface SongBlock
extends SongMember

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.

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.

java.lang.String getSerializableID()
          Get a string ID that can be used to serialize references to this SongBlock.

SongLine insertLineAfter(SongLine after, javax.swing.event.UndoableEditListener undoListener)
          Add a line at the given position.

SongLine insertLineBefore(SongLine before, javax.swing.event.UndoableEditListener undoListener)
          Add a line at the given position.

void removeLine(SongLine line, javax.swing.event.UndoableEditListener undoListener)
          Remove the given line.

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

getIndentLevel

public int getIndentLevel()

Get the indent level

getLineCount

public int getLineCount()

Get the number of lines

getNthLine

public SongLine getNthLine(int n)

Get the nth line

getNextLine

public SongLine getNextLine(SongLine reference)

Get the next line following reference. If reference is null, returns the first line. If reference is the last line, returns null;

getPreviousLine

public SongLine getPreviousLine(SongLine reference)

Get the previous line preceding reference. If reference is null, returns the last line. If reference is the first line, returns null;

getSerializableID

public java.lang.String getSerializableID()

Get a string ID that can be used to serialize references to this SongBlock. The ID is guaranteed to be unique among SongBlocks within the owning Song, and will remain the same for the same SongBlock across different executions of the tool. However, two SongBlocks from different Songs may have the same string ID, and the same string ID may be shared between SongBlocks, Variations and ChordSets within the same Song.

setIndentLevel

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

Set the indent level

insertLineBefore

public SongLine insertLineBefore(SongLine before,
                                 javax.swing.event.UndoableEditListener undoListener)

Add a line at the given position.

insertLineAfter

public SongLine insertLineAfter(SongLine after,
                                javax.swing.event.UndoableEditListener undoListener)