writer2latex.office

Class LoftReader

public class LoftReader extends Object

The class reads a text:illustration-index or text:table-index element.

Constructor Summary
LoftReader(Element onode)

Initialize the LoftReader with a illustration/table index node

Method Summary
StringgetCaptionSequenceName()

Get the sequence name to use for the caption

ElementgetIndexBody()

Return the generated content of this loft, if available

ElementgetIndexTitleTemplate()

Get the index title template for this loft

ElementgetLoftEntryTemplate(int nLevel)

Get the entry template for this loft at a specific level

StringgetName()

Get the (section) name for this loft

StringgetStyleName()

Get the (section) style name for this loft

booleanisByChapter()

Is this loft by chapter?

booleanisTableIndex()

Is this a table index or a figure index?

booleanuseCaption()

Is this loft generated by captions?

Constructor Detail

LoftReader

public LoftReader(Element onode)

Initialize the LoftReader with a illustration/table index node

Parameters: onode a text:*-index

Method Detail

getCaptionSequenceName

public String getCaptionSequenceName()

Get the sequence name to use for the caption

Returns: the name of the caption

getIndexBody

public Element getIndexBody()

Return the generated content of this loft, if available

Returns: the text:index-body element

getIndexTitleTemplate

public Element getIndexTitleTemplate()

Get the index title template for this loft

Returns: the text:index-title-template element, or null

getLoftEntryTemplate

public Element getLoftEntryTemplate(int nLevel)

Get the entry template for this loft at a specific level

Parameters: nLevel the outline level

Returns: the text:table-of-content-entry-template element, or null

getName

public String getName()

Get the (section) name for this loft

Returns: the name of the loft

getStyleName

public String getStyleName()

Get the (section) style name for this loft

Returns: name of the section style to use for this loft

isByChapter

public boolean isByChapter()

Is this loft by chapter?

Returns: true if the scope is a chapter only

isTableIndex

public boolean isTableIndex()

Is this a table index or a figure index?

Returns: true if it's a table index

useCaption

public boolean useCaption()

Is this loft generated by captions? (otherwise: by object names)

Returns: true if we use captions