pivot.wtk.text
Class List

java.lang.Object
  extended by pivot.wtk.text.Node
      extended by pivot.wtk.text.Element
          extended by pivot.wtk.text.List
All Implemented Interfaces:
java.lang.Iterable<Node>, Sequence<Node>
Direct Known Subclasses:
BulletedList, NumberedList

public abstract class List
extends Element

Abstract base class for list elements.

TODO Add indent and item spacing properties.

Author:
gbrown

Nested Class Summary
 class List.Item
          Element representing a list item.
 
Nested classes/interfaces inherited from interface pivot.collections.Sequence
Sequence.Search, Sequence.Sort, Sequence.Tree
 
Constructor Summary
List()
           
List(List list, boolean recursive)
           
 
Method Summary
 void insert(Node node, int index)
          Inserts an item into the sequence at a specific index.
 
Methods inherited from class pivot.wtk.text.Element
add, dumpOffsets, get, getCharacterCount, getDescendantAt, getElementListeners, getIndexAt, getLength, getNodeAt, getPathAt, getRange, indexOf, insertRange, iterator, rangeInserted, rangeRemoved, remove, remove, removeRange, update
 
Methods inherited from class pivot.wtk.text.Node
duplicate, getDocumentOffset, getNodeListeners, getOffset, getParent, replaceRange, setOffset, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

List

public List()

List

public List(List list,
            boolean recursive)
Method Detail

insert

public void insert(Node node,
                   int index)
Description copied from interface: Sequence
Inserts an item into the sequence at a specific index.

Specified by:
insert in interface Sequence<Node>
Overrides:
insert in class Element
Parameters:
node - The item to be added to the sequence.
index - The index at which the item should be inserted. Must be a value between 0 and getLength().