writer2latex.api
Interface ContentEntry

All Known Implementing Classes:
ContentEntryImpl

public interface ContentEntry

This interface represents a content entry, that is a named reference to a position within the output document.


Method Summary
 OutputFile getFile()
          Get the file associated with the entry
 int getLevel()
          Get the outline level of this ContentEntry.
 java.lang.String getTarget()
          Get the name of a target within the file, if any
 java.lang.String getTitle()
          Get the title for this entry
 

Method Detail

getLevel

int getLevel()
Get the outline level of this ContentEntry. The top level is 1 (entries corresponding to indexes are considered top level). Note that intermediate levels may be missing (e.g. a heading of level 3 may follow immediately after a heading of level 1).

Returns:
the outline level

getTitle

java.lang.String getTitle()
Get the title for this entry

Returns:
the title

getFile

OutputFile getFile()
Get the file associated with the entry

Returns:
the output file

getTarget

java.lang.String getTarget()
Get the name of a target within the file, if any

Returns:
the target name, or null if no target is needed