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

Quick Search    Search Deep

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

All Superinterfaces:
SongMember
All Known Subinterfaces:
StringListField

public interface StringList
extends SongMember

This is the string list interface in an Asaph model. It is used in various places to represent an ordered list of strings, each represented by a SimpleString.


Method Summary
 void clear(javax.swing.event.UndoableEditListener undoListener)
          Clear the string list
 SimpleString getNextString(SimpleString reference)
          Get the next string following reference.
 SimpleString getNthString(int n)
          Get the nth string
 SimpleString getPreviousString(SimpleString reference)
          Get the previous string preceding reference.
 int getStringCount()
          Get the number of strings in the list
 SimpleString insertStringAfter(SimpleString after, java.lang.String str, javax.swing.event.UndoableEditListener undoListener)
          Add a string to the list at the given position
 SimpleString insertStringBefore(SimpleString before, java.lang.String str, javax.swing.event.UndoableEditListener undoListener)
          Add a string to the list at the given position
 void removeString(SimpleString str, javax.swing.event.UndoableEditListener undoListener)
          Remove a SimpleString from the list.
 
Methods inherited from interface com.virtuosotechnologies.asaph.model.SongMember
getSong, isDefunct
 

Method Detail

getStringCount

public int getStringCount()
Get the number of strings in the list


getNthString

public SimpleString getNthString(int n)
Get the nth string


getNextString

public SimpleString getNextString(SimpleString reference)
Get the next string following reference. If reference is null, returns the first string. If reference is the last string, returns null;


getPreviousString

public SimpleString getPreviousString(SimpleString reference)
Get the previous string preceding reference. If reference is null, returns the last string. If reference is the first string, returns null;


insertStringBefore

public SimpleString insertStringBefore(SimpleString before,
                                       java.lang.String str,
                                       javax.swing.event.UndoableEditListener undoListener)
Add a string to the list at the given position


insertStringAfter

public SimpleString insertStringAfter(SimpleString after,
                                      java.lang.String str,
                                      javax.swing.event.UndoableEditListener undoListener)
Add a string to the list at the given position


removeString

public void removeString(SimpleString str,
                         javax.swing.event.UndoableEditListener undoListener)
Remove a SimpleString from the list.


clear

public void clear(javax.swing.event.UndoableEditListener undoListener)
Clear the string list