writer2latex.office

Class TocReader


public class TocReader
extends java.lang.Object

The class reads a text:table-of-content element.

Constructor Summary

TocReader(Element onode)
Initialize the TocReader with a table of content node.

Method Summary

Element
getIndexBody()
Return the generated content of this toc, if available
int
getIndexSourceStyleLevel(String sStyleName)
Get the level associated with a specific index source style
Set
getIndexSourceStyles()
Get a set view of all index source styles
Element
getIndexTitleTemplate()
Get the index title template for this toc
String
getName()
Get the (section) name for this toc
int
getOutlineLevel()
Get max outline level for this toc
String
getStyleName()
Get the (section) style name for this toc
Element
getTocEntryTemplate(int nLevel)
Get the entry template for this toc at a specific level
boolean
isByChapter()
Is this toc by chapter?
boolean
useIndexMarks()
Do we use toc marks in this toc?
boolean
useIndexSourceStyles()
Do we use additional styles in this toc?
boolean
useOutlineLevel()
Do we use outline (headings) in this toc?

Constructor Details

TocReader

public TocReader(Element onode)
Initialize the TocReader with a table of content node.
Parameters:
onode - a text:table-of-content

Method Details

getIndexBody

public Element getIndexBody()
Return the generated content of this toc, if available
Returns:
the text:index-body element

getIndexSourceStyleLevel

public int getIndexSourceStyleLevel(String sStyleName)
Get the level associated with a specific index source style
Parameters:
sStyleName - the style name of the index source style
Returns:
the level or -1 if the style is not used in this toc

getIndexSourceStyles

public Set getIndexSourceStyles()
Get a set view of all index source styles
Returns:
a set of all index source style names

getIndexTitleTemplate

public Element getIndexTitleTemplate()
Get the index title template for this toc
Returns:
the text:index-title-template element, or null

getName

public String getName()
Get the (section) name for this toc
Returns:
the name of the toc

getOutlineLevel

public int getOutlineLevel()
Get max outline level for this toc
Returns:
max outline level

getStyleName

public String getStyleName()
Get the (section) style name for this toc
Returns:
name of the section style to use for this toc

getTocEntryTemplate

public Element getTocEntryTemplate(int nLevel)
Get the entry template for this toc at a specific level
Parameters:
nLevel - the outline level
Returns:
the text:table-of-content-entry-template element, or null

isByChapter

public boolean isByChapter()
Is this toc by chapter?
Returns:
true if the scope is a chapter only

useIndexMarks

public boolean useIndexMarks()
Do we use toc marks in this toc?
Returns:
true if toc marks should be used

useIndexSourceStyles

public boolean useIndexSourceStyles()
Do we use additional styles in this toc?
Returns:
true if additional styles should be used

useOutlineLevel

public boolean useOutlineLevel()
Do we use outline (headings) in this toc?
Returns:
true if headings should be used