writer2latex.office
public class OfficeReader extends Object
This class reads and collects global information about an OOo document. This includes styles, forms, information about indexes and references etc.
Constructor Summary | |
---|---|
OfficeReader(OfficeDocument oooDoc, boolean bAllParagraphsAreSoft) Constructor; read a document |
Method Summary | |
---|---|
void | addFigureSequenceName(String sName) Add a sequence name for figure captions. OpenDocument has a very weak notion of figure captions: A caption is a paragraph containing a text:sequence element. |
void | addTableSequenceName(String sName) Add a sequence name for table captions. OpenDocument has a very weak notion of table captions: A caption is a paragraph containing a text:sequence element. |
StyleWithProperties | getCellStyle(String sName) |
OfficeStyleFamily | getCellStyles() |
static int | getCharacterCount(Node node) Counts the number of characters (text nodes) in this element
excluding footnotes etc. |
StyleWithProperties | getColumnStyle(String sName) |
OfficeStyleFamily | getColumnStyles() |
Element | getContent() Get the content element In the old file format this means the In the OpenDocument format this means a |
StyleWithProperties | getDefaultCellStyle() |
StyleWithProperties | getDefaultDrawingPageStyle() |
StyleWithProperties | getDefaultFrameStyle() |
StyleWithProperties | getDefaultParStyle() |
StyleWithProperties | getDefaultPresentationStyle() |
StyleWithProperties | getDrawingPageStyle(String sName) |
OfficeStyleFamily | getDrawingPageStyles() |
PropertySet | getEndnotesConfiguration() |
MasterPage | getFirstMasterPage() Returns the first master page used in the document. |
FontDeclaration | getFontDeclaration(String sName) Get a specific font declaration |
OfficeStyleFamily | getFontDeclarations() Get the collection of all font declarations. |
PropertySet | getFootnotesConfiguration() |
FormsReader | getForms() Get the forms belonging to this document. |
StyleWithProperties | getFrameStyle(String sName) |
OfficeStyleFamily | getFrameStyles() |
StyleWithProperties | getHeadingStyle(int nLevel) Returns the paragraph style associated with headings of a specific level. |
ListStyle | getListStyle(String sName) |
OfficeStyleFamily | getListStyles() |
MasterPage | getMasterPage(String sName) |
OfficeStyleFamily | getMasterPages() |
ListStyle | getOutlineStyle() |
PageLayout | getPageLayout(String sName) |
OfficeStyleFamily | getPageLayouts() |
StyleWithProperties | getParStyle(String sName) |
OfficeStyleFamily | getParStyles() |
StyleWithProperties | getPresentationStyle(String sName) |
OfficeStyleFamily | getPresentationStyles() |
StyleWithProperties | getRowStyle(String sName) |
OfficeStyleFamily | getRowStyles() |
StyleWithProperties | getSectionStyle(String sName) |
OfficeStyleFamily | getSectionStyles() |
String | getSequenceFromRef(String sRefName) Get the sequence name associated with a reference name |
String | getSequenceName(Element par) Get the sequence name associated with a paragraph |
TableReader | getTableReader(Element node) Read a table from a table:table node |
StyleWithProperties | getTableStyle(String sName) |
OfficeStyleFamily | getTableStyles() |
String | getTextContent(Node node) |
StyleWithProperties | getTextStyle(String sName) |
OfficeStyleFamily | getTextStyles() |
TocReader | getTocReader(Element onode) Returns a reader for a specific toc |
boolean | hasBookmarkRefTo(String sName) Is there a reference to this bookmark? |
boolean | hasEndnoteRefTo(String sId) Is there a reference to this endnote? |
boolean | hasFootnoteRefTo(String sId) Is there a reference to this footnote id? |
boolean | hasLinkTo(String sName) Is there a link to this sequence anchor name? |
boolean | hasReferenceRefTo(String sName) Is there a reference to this reference mark? |
boolean | hasSequenceRefTo(String sId) Is there a reference to this sequence field? |
static boolean | isDrawElement(Node node) Checks, if a node is an element in the draw namespace |
boolean | isFigureSequenceName(String sName) Does this sequence name belong to a lof? |
boolean | isIndexSourceStyle(String sStyleName) Is this style used in some toc as an index source style? |
boolean | isInPackage(String sUrl) Checks whether this url is internal to the package |
static boolean | isNoteElement(Node node) Checks, if a node is an element representing a note (footnote/endnote) |
boolean | isOpenDocument() Is this an OASIS OpenDocument or an OOo 1.0 document? |
boolean | isPackageFormat() Checks whether or not this document is in package format |
boolean | isPresentation() Is this a presentation document? |
static boolean | isSingleParagraph(Node node) Checks, if this node contains at most one element, and that this is a
paragraph. |
boolean | isSpreadsheet() Is this a spreadsheet document? |
static boolean | isTableElement(Node node) Checks, if a node is an element in the table namespace |
boolean | isTableSequenceName(String sName) Does this sequence name belong to a lot? |
boolean | isText() Is this an text document? |
static boolean | isTextElement(Node node) Checks, if a node is an element in the text namespace |
static boolean | isWhitespace(String s) Checks, if this text is whitespace |
static boolean | isWhitespaceContent(Node node) Checks, if the only text content of this node is whitespace |
Add a sequence name for figure captions.
OpenDocument has a very weak notion of figure captions: A caption is a paragraph containing a text:sequence element. Moreover, the only source to identify which sequence number to use is the list(s) of figures. If there's no list of figures, captions cannot be identified. Thus this method lets the user add a sequence name to identify the figure captions.
Parameters: sName the name to add
Add a sequence name for table captions.
OpenDocument has a very weak notion of table captions: A caption is a paragraph containing a text:sequence element. Moreover, the only source to identify which sequence number to use is the list(s) of tables. If there's no list of tables, captions cannot be identified. Thus this method lets the user add a sequence name to identify the table captions.
Parameters: sName the name to add
Parameters: node the node to count in
Returns: the number of characters
Get the content element
In the old file format this means the office:body
element
In the OpenDocument format this means a office:text
,
office:spreadsheet
or office:presentation
element.
Returns: the content Element
Returns the first master page used in the document. If no master page is used explicitly, the first master page found in the styles is returned. Returns null if no master pages exists.
Returns: a MasterPage
object representing the master page
Get a specific font declaration
Parameters: sName the name of the font declaration
Returns: a FontDeclaration
representing the font
Get the collection of all font declarations.
Returns: the OfficeStyleFamily
of font declarations
Get the forms belonging to this document.
Returns: a FormsReader
representing the forms
Returns the paragraph style associated with headings of a specific
level. Returns null
if no such style is known.
In principle, different styles can be used for each heading, in practice the same (soft) style is used for all headings of a specific level.
Parameters: nLevel the level of the heading
Returns: a StyleWithProperties
object representing the style
Get the sequence name associated with a reference name
Parameters: sRefName the reference name to use
Returns: the sequence name or null
Get the sequence name associated with a paragraph
Parameters: par the paragraph to look up
Returns: the sequence name or null
Read a table from a table:table node
Parameters: node the table:table Element node
Returns: a TableReader
object representing the table
Returns a reader for a specific toc
Parameters: onode the text:table-of-content-node
Returns: the reader, or null
Is there a reference to this bookmark?
Parameters: sName the name of the bookmark
Returns: true if there is a reference
Is there a reference to this endnote?
Parameters: sId the id of the endnote
Returns: true if there is a reference
Is there a reference to this footnote id?
Parameters: sId the id of the footnote
Returns: true if there is a reference
Is there a link to this sequence anchor name?
Parameters: sName the name of the anchor
Returns: true if there is a link
Is there a reference to this reference mark?
Parameters: sName the name of the
Returns: true if there is a reference
Is there a reference to this sequence field?
Parameters: sId the id of the sequence field
Returns: true if there is a reference
Parameters: node the node to check
Returns: true if this is a draw element
Does this sequence name belong to a lof?
Parameters: sName the name of the sequence
Returns: true if it belongs to an index
Is this style used in some toc as an index source style?
Parameters: sStyleName the name of the style
Returns: true if this is an index source style
Parameters: sUrl the url to check
Returns: true if the url is internal to the package
Parameters: node the node to check
Returns: true if this is a note element
Is this an OASIS OpenDocument or an OOo 1.0 document?
Returns: true if it's an OASIS OpenDocument
Returns: true if it's in package format
Is this a presentation document?
Returns: true if it's a presentation document
Parameters: node the node to check
Returns: true if the node contains a single paragraph or nothing
Is this a spreadsheet document?
Returns: true if it's a spreadsheet document
Parameters: node the node to check
Returns: true if this is a table element
Does this sequence name belong to a lot?
Parameters: sName the name of the sequence
Returns: true if it belongs to an index
Is this an text document?
Returns: true if it's a text document
Parameters: node the node to check
Returns: true if this is a text element
Checks, if this text is whitespace
Parameters: s the String to check
Returns: true if the String contains whitespace only
Checks, if the only text content of this node is whitespace
Parameters: node the node to check (should be a paragraph node or a child of a paragraph node)
Returns: true if the node contains whitespace only