writer2latex.latex

Class IndexConverter


public class IndexConverter
extends ConverterHelper

This class handles indexes (table of contents, list of tables, list of illustrations, object index, user index, alphabetical index, bibliography) as well as their associated index marks.

Field Summary

Fields inherited from class writer2latex.latex.ConverterHelper

config, ofr, palette

Constructor Summary

IndexConverter(OfficeReader ofr, Config config, ConverterPalette palette)
Construct a new IndexConverter.

Method Summary

void
appendDeclarations(LaTeXDocumentPortion pack, LaTeXDocumentPortion decl)
Append declarations needed by the IndexConverter to the preamble.
void
flushIndexMarks(LaTeXDocumentPortion ldp, Context oc)
BibTeXDocument
getBibTeXDocument()
Get the BibTeX document, if any (the document is only created if it's specified in the configuration *and* the document contains bibliographic data).
void
handleAlphabeticalIndex(Element node, LaTeXDocumentPortion ldp, Context oc)
Process Alphabetical Index (text:alphabetical-index tag)
void
handleAlphabeticalIndexMark(Element node, LaTeXDocumentPortion ldp, Context oc)
Process an Alphabetical Index Mark (text:alphabetical-index-mark{-start} tag)
void
handleBibliography(Element node, LaTeXDocumentPortion ldp, Context oc)
Process Bibliography (text:bibliography tag)
void
handleBibliographyMark(Element node, LaTeXDocumentPortion ldp, Context oc)
Process a Bibliography Mark (text:bibliography-mark tag)
void
handleLOF(Element node, LaTeXDocumentPortion ldp, Context oc)
Process List of Illustrations (text:list-of-illustrations tag)
void
handleLOT(Element node, LaTeXDocumentPortion ldp, Context oc)
Process List of Tables (text:list-of-tables tag)
void
handleObjectIndex(Element node, LaTeXDocumentPortion ldp, Context oc)
Process Object Index (text:object index tag)
void
handleTOC(Element node, LaTeXDocumentPortion ldp, Context oc)
Process Table of Contents (text:table-of-content tag)
void
handleUserIndex(Element node, LaTeXDocumentPortion ldp, Context oc)
Process User Index (text:user-index tag)

Methods inherited from class writer2latex.latex.ConverterHelper

appendDeclarations

Constructor Details

IndexConverter

public IndexConverter(OfficeReader ofr,
                      Config config,
                      ConverterPalette palette)
Construct a new IndexConverter.
Parameters:

Method Details

appendDeclarations

public void appendDeclarations(LaTeXDocumentPortion pack,
                               LaTeXDocumentPortion decl)
Append declarations needed by the IndexConverter to the preamble.
Overrides:
appendDeclarations in interface ConverterHelper
Parameters:

flushIndexMarks

public void flushIndexMarks(LaTeXDocumentPortion ldp,
                            Context oc)

getBibTeXDocument

public BibTeXDocument getBibTeXDocument()
Get the BibTeX document, if any (the document is only created if it's specified in the configuration *and* the document contains bibliographic data).
Returns:
the BiBTeXDocument, or null if it does not exist.

handleAlphabeticalIndex

public void handleAlphabeticalIndex(Element node,
                                    LaTeXDocumentPortion ldp,
                                    Context oc)
Process Alphabetical Index (text:alphabetical-index tag)
Parameters:

handleAlphabeticalIndexMark

public void handleAlphabeticalIndexMark(Element node,
                                        LaTeXDocumentPortion ldp,
                                        Context oc)
Process an Alphabetical Index Mark (text:alphabetical-index-mark{-start} tag)
Parameters:

handleBibliography

public void handleBibliography(Element node,
                               LaTeXDocumentPortion ldp,
                               Context oc)
Process Bibliography (text:bibliography tag)
Parameters:

handleBibliographyMark

public void handleBibliographyMark(Element node,
                                   LaTeXDocumentPortion ldp,
                                   Context oc)
Process a Bibliography Mark (text:bibliography-mark tag)
Parameters:

handleLOF

public void handleLOF(Element node,
                      LaTeXDocumentPortion ldp,
                      Context oc)
Process List of Illustrations (text:list-of-illustrations tag)
Parameters:

handleLOT

public void handleLOT(Element node,
                      LaTeXDocumentPortion ldp,
                      Context oc)
Process List of Tables (text:list-of-tables tag)
Parameters:

handleObjectIndex

public void handleObjectIndex(Element node,
                              LaTeXDocumentPortion ldp,
                              Context oc)
Process Object Index (text:object index tag)
Parameters:

handleTOC

public void handleTOC(Element node,
                      LaTeXDocumentPortion ldp,
                      Context oc)
Process Table of Contents (text:table-of-content tag)
Parameters:

handleUserIndex

public void handleUserIndex(Element node,
                            LaTeXDocumentPortion ldp,
                            Context oc)
Process User Index (text:user-index tag)
Parameters: