wxtpages
Class indexTable

java.lang.Object
  extended bywxtpages.indexTable

public class indexTable
extends java.lang.Object

An object of type indexTable holds a set of indexEntries during build. The indexTable is placed in a second phase of the build process.


Constructor Summary
indexTable()
          Creates a new instance of indexTable with a deafult name: _main
indexTable(java.lang.String n)
          Creates a new instance of indexTable
 
Method Summary
 void addEntry(java.lang.String w, unitPage p, java.lang.String f)
          Add a new entry to this indextable, sorted on entry
 java.lang.String getName()
          Get the name of this indexTable
 org.w3c.dom.DocumentFragment makeTable(int cols, unitPage p)
          Make a complete index table with a number of columns
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

indexTable

public indexTable(java.lang.String n)
Creates a new instance of indexTable

Parameters:
n - The name of this table

indexTable

public indexTable()
Creates a new instance of indexTable with a deafult name: _main

Method Detail

getName

public java.lang.String getName()
Get the name of this indexTable

Returns:
The name of this indexTable

addEntry

public void addEntry(java.lang.String w,
                     unitPage p,
                     java.lang.String f)
Add a new entry to this indextable, sorted on entry

Parameters:
w - The word
p - The referenced page
f - The fragment

makeTable

public org.w3c.dom.DocumentFragment makeTable(int cols,
                                              unitPage p)
                                       throws org.w3c.dom.DOMException
Make a complete index table with a number of columns

Parameters:
cols - Number of columns
p - The page that will hold the table
Returns:
a Documentfragment with a prepared indextable
Throws:
org.w3c.dom.DOMException - when something goes wrong