|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object writer2latex.latex.ConverterHelper writer2latex.latex.NoteConverter
public class NoteConverter
This class handles conversion of footnotes and endnotes, including
references. It takes advantage of the packages endnotes.sty
and perpage.sty
if allowed in the configuration.
Field Summary |
---|
Fields inherited from class writer2latex.latex.ConverterHelper |
---|
config, ofr, palette |
Constructor Summary | |
---|---|
NoteConverter(OfficeReader ofr,
LaTeXConfig config,
ConverterPalette palette)
|
Method Summary | |
---|---|
void |
addEndnoteName(java.lang.String sName)
Add an endnote name. |
void |
addFootnoteName(java.lang.String sName)
Add a footnote name. |
void |
appendDeclarations(LaTeXDocumentPortion pack,
LaTeXDocumentPortion decl)
Append declarations needed by the NoteConverter to
the preamble. |
void |
flushFootnotes(LaTeXDocumentPortion ldp,
Context oc)
Flush the queue of postponed footnotes |
void |
handleEndnote(org.w3c.dom.Element node,
LaTeXDocumentPortion ldp,
Context oc)
Process an endnote (text:endnote tag) |
void |
handleEndnoteRef(org.w3c.dom.Element node,
LaTeXDocumentPortion ldp,
Context oc)
Process an endnote reference (text:endnote-ref tag) |
void |
handleFootnote(org.w3c.dom.Element node,
LaTeXDocumentPortion ldp,
Context oc)
Process a footnote (text:footnote tag) |
void |
handleFootnoteRef(org.w3c.dom.Element node,
LaTeXDocumentPortion ldp,
Context oc)
Process a footnote reference (text:footnote-ref tag) |
void |
handleNoteRef(org.w3c.dom.Element node,
LaTeXDocumentPortion ldp,
Context oc)
Process a note reference (text:note-ref tag, oasis) |
void |
insertEndnotes(LaTeXDocumentPortion ldp)
Insert the endnotes into the documents. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NoteConverter(OfficeReader ofr, LaTeXConfig config, ConverterPalette palette)
Method Detail |
---|
public void appendDeclarations(LaTeXDocumentPortion pack, LaTeXDocumentPortion decl)
Append declarations needed by the NoteConverter
to
the preamble.
appendDeclarations
in class ConverterHelper
pack
- the LaTeXDocumentPortion
to which
declarations of packages should be added (\\usepackage
).decl
- the LaTeXDocumentPortion
to which
other declarations should be added.public void handleFootnote(org.w3c.dom.Element node, LaTeXDocumentPortion ldp, Context oc)
Process a footnote (text:footnote tag)
node
- The element containing the footnoteldp
- the LaTeXDocumentPortion
to which
LaTeX code should be addedoc
- the current contextpublic void flushFootnotes(LaTeXDocumentPortion ldp, Context oc)
public void handleEndnote(org.w3c.dom.Element node, LaTeXDocumentPortion ldp, Context oc)
Process an endnote (text:endnote tag)
node
- The element containing the endnoteldp
- the LaTeXDocumentPortion
to which
LaTeX code should be addedoc
- the current contextpublic void insertEndnotes(LaTeXDocumentPortion ldp)
Insert the endnotes into the documents.
ldp
- the LaTeXDocumentPortion
to which
the endnotes should be added.public void handleNoteRef(org.w3c.dom.Element node, LaTeXDocumentPortion ldp, Context oc)
Process a note reference (text:note-ref tag, oasis)
node
- The element containing the note referenceldp
- the LaTeXDocumentPortion
to which
LaTeX code should be addedoc
- the current contextpublic void handleFootnoteRef(org.w3c.dom.Element node, LaTeXDocumentPortion ldp, Context oc)
Process a footnote reference (text:footnote-ref tag)
node
- The element containing the footnote referenceldp
- the LaTeXDocumentPortion
to which
LaTeX code should be addedoc
- the current contextpublic void handleEndnoteRef(org.w3c.dom.Element node, LaTeXDocumentPortion ldp, Context oc)
Process an endnote reference (text:endnote-ref tag)
node
- The element containing the endnote referenceldp
- the LaTeXDocumentPortion
to which
LaTeX code should be addedoc
- the current contextpublic void addFootnoteName(java.lang.String sName)
Add a footnote name. The method handleFootnote
includes
a \label
only if the footnote name is already known to the
NoteConverter
. Hence this method is invoked by the prepass
for each footnote reference. The end result is, that only necessary
labels will be included.
sName
- the name (id) of the footnotepublic void addEndnoteName(java.lang.String sName)
Add an endnote name. The method handleEndnote
includes
a \label
only if the endnote name is already known to the
NoteConverter
. Hence this method is invoked by the prepass
for each endnote reference. The end result is, that only necessary
labels will be included.
sName
- the name (id) of the endnote
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |