Skip navigation links

DEPRECATED Simple Java API for ODF (Simple ODF) - removed in v0.10

See: Description

Packages 
Package Description
org.odftoolkit.simple
Provide high level methods to frequently used ODF documents.
org.odftoolkit.simple.chart
Provide convenient methods to manipulate chart in ODF text, presentation and spreadsheet document.
org.odftoolkit.simple.common
Provide text extraction and fields methods to all ODF documents and elements.
org.odftoolkit.simple.common.field
Provide convenient methods to manipulate Fields in ODF text document.
org.odftoolkit.simple.common.navigation
Provide classes to operate the content and style of the selected text content.
org.odftoolkit.simple.draw
Provide high level methods to manipulate draw frame and text box.
org.odftoolkit.simple.form  
org.odftoolkit.simple.meta
Provide classes to access the metadata of ODF documents.
org.odftoolkit.simple.presentation
Provide high level methods to ODF presentation documents.
org.odftoolkit.simple.style
Provide convenient methods to handle style definitions in ODF document.
org.odftoolkit.simple.table
Provide convenient methods to manipulate table in ODF text and spreadsheet document.
org.odftoolkit.simple.text
Provide convenient methods to manipulate frequently used structures in ODF text document, such as list and section.
org.odftoolkit.simple.text.list
Provide convenient methods to handle list in ODF document.

The Simple API is deprecated and removed in the 0.10 release.


The Simple Java API for ODF builds upon the lower-level ODFDOM DOM and Package layer to provide an easy-to-use, high-level Java API for creating, modifying and extracting data from Open Document Format documents.

Simple Java API for ODF

Packages introduction

The design principle is "make users easily to locate the functions they want".

Document methods

For each frequently used document type, there is a class under package "org.odftoolkit.simple" to provide high level methods to manipulate this kind of documents.

Specific methods for different mimetype

For each frequently used mimetype, their is a package to contain the high level methods for this kind of mimetype, such as org.odftoolkit.simple.text and org.odftoolkit.simple.presentation. The packages for different mimetype contain:

  • The frequently used features functions, such as org.odftoolkit.simpleodf.chart will contain the function related with chart, org.odftoolkit.simpleodf.text will contain the function related with text content.
  • Specific functions for different mimetypes, for example, the navigation API is put in package "org.odftoolkit.simpleodf.text.search".

Features methods

there are some packages defined for important common features available for all kinds of documents, such as table, meta and style. The packages for common features will contain the methods for specific features.

Common methods

There is another package named "org.odftoolkit.simpleodf.common", which contains functions that are not related with a specific document type nor a specific feature. For example, the text extractor functions are put in this package.

Further Information

For further Information about Simple Java API for ODF and related topics please visit following pages:
  1. Simple Java API
  2. OpenDocument v1.2 specification - part 1: OpenDocument Schema
  3. OpenDocument v1.2 specification - part 3: Packages
  4. ODFDOM

Copyright © 2010–2018 Apache Software Foundation; Copyright © 2018–2020 The Document Foundation. All rights reserved.