Simple API Release Notes

Release 0.6.6
Auguest 12th 2011

We are pleased to announce the release of the Simple Java API for ODF version 0.6.6 today. The improvements in this version include:

Two critical bugs in Navigation API and several other issues are fixed.
Page columns, a page layout feature in text document, are now supported.
Unit test coverage rate increased. This work improves the stability of our API.

You can download it here.

ODF Toolkit has been accepted as Apache incubator project and the move process has been started. The security feature will be included in Apache version. Thanks all of the contributors and users, please continue to pay attention to us in Apache.

Resolved Issues

Bug 334 - Paragraph.setStyleName() doesn't work.
Bug 346 - Test don't work on Linux.
Bug 347 - VariableField doen't register in Component cache.
Bug 348 - Paragraph deleted is not complete.
Bug 349 - Definition of the number of columns in the page and column Break.
Bug 350 - TextNavigation find matched Selection out of range.
Bug 353 - Matching child nodes not honored by Navigation if next sibling matches.
Bug 354 - parameter isMinHeight is not taken into account in the method setHeight (class Row).
Bug 355 - StyleTypeDefinitions.HorizontalAlignmentType has a wrong value, 'justified' should be 'justify'.
Bug 356 - Document.OdfMediaType.TEXT.toString() leads to unreachable code block.
Bug 357 - getFontSizeInPoint() in TextProperties doesn't work.
Bug 358 - TableCellTest.testCellSizeOptimal Unit test failing on MacOS.

Release 0.6.5
July 1st 2011

We are pleased to announce the release of the Simple Java API for ODF version 0.6.5 today. The improvements in this version focus on paragraph and text documents. They are:

Hard page breaks, including append page break at the end of text document and append page break after a reference paragraph.
Headings, including append heading, apply plain text as heading.
Comments, including add comment to a text selection, apply comment to a paragraph.
Paragraph font, get/set paragraph font size, style, color and so on.
Paragraph alignment, get/set paragraph text alignment.
Hyperlinks, including navigation hyperlinks, apply hyperlink to a selection, append hyperlink to paragraph.

An interesting demo is uploaded to the website to show how to use these new features to format a text document.

Resolved Issues

Bug 341 - Component.getComponentByElement (OdfElement element) never return null.
Bug 342 - TextProperties.getTextProperties throws NullPointerException.
Bug 343 - OdfDocument.loadDocument(OdfPackage odfPackage, String internalPath) needs validate "internalPath".
Bug 344 - Enhance hyperlink feature.
Bug 345 - Supply Page Break, Heading, Comment, Paragraph Font and Alignment support.

API changes since 0.6 Release

Method Change List
Note: The first column 'Java class' package is relative to 'org.odftoolkit'.

Previous Class	Previous Method	New Class	New Method
simple.text.Paragraph	TextPElement getOdfElement()	simple.text.Paragraph	TextParagraphElementBase getOdfElement()
simple.text.Paragraph	DefaultStyleHandler getStyleHandler()	simple.text.Paragraph	ParagraphStyleHandler getStyleHandler()
simple.text.Paragraph	Paragraph getInstanceof(TextPElement)	simple.text.Paragraph	Paragraph getInstanceof(TextParagraphElementBase)

Release 0.6
June 1st 2011

We are pleased to announce the release of the Simple Java API for ODF version 0.6 today. A major improvement of this version is the chart API. Now you can add charts to text, spreadsheet and presentation documents with easy-to-use methods. An interesting demo is uploaded to the website to show how to create a presentation/text/spreadsheet document with charts only using Simple ODF API.

We also make some enhancements based on user requests:

Ability to set table cell widths and heights with high precision;
Ability to set validity rules for the values of table cells;
Provide helper methods for Spreadsheet document to get table;
Provide more layout definitions for slides

Resolved Issues

Bug 332 - Nice to have means to set table cell widths and heights with sub-millimeter precision.
Bug 260 - Table cell validate function.
Bug 243 - SpreadsheetDocument needs helper functions to get to Table.
Bug 330 - Supply Chart API Features.

API changes since 0.5.5 Release

Method Change List
Note: The first column 'Java class' package is relative to 'org.odftoolkit'.

Previous Class	Previous Method	New Class	New Method
simple.table.Table	long getWidth()	simple.table.Table	double getWidth()
simple.table.Table	void setWidth(long)	simple.table.Table	void setWidth(double)
simple.table.Column	long getWidth()	simple.table.Column	double getWidth()
simple.table.Column	void setWidth(long)	simple.table.Column	void setWidth(double)
simple.table.Row	long getHeight()	simple.table.Table	double getHeight()
simple.table.Table	void setHeight(long)	simple.table.Table	void setHeight(double)

Release 0.5.5
April 30th 2011

We released the Simple Java API for ODF version 0.5.5 today. In this version, we provide high level methods for image and text span. Now you can add images to text, spreadsheet and presentation documents. The position of the image can be specified by a rectangle, a paragraph or a cell. With text span, you can set a different style to a small unit of the text content. An interesting demo has been upload to website to demonstrate how to add a 2D barcode image to a presentation slide.

We also made some useful enhancements based on user requests:

automatically adjust the table column width based on its text content
allow several paragraphs to be added to a single cell
set whether or not a header/footer is visible
optimize some table methods to improve performance

Resolved Issues

Bug 256 - JavaDoc should be deployed via Maven to the Simple website.
Bug 269 - Desirable column width is calculated in characters on the basis of the size of the data that will go into the table.
Bug 273 - The performance of getRowList/getColumnList is too low, if there is a row element with 65535 repeat number.
Bug 309 - Supply method to set the header/footer visible or not.
Bug 311 - Insert several paragraphs in a cell or several different text in the same paragraph in a cell.
Bug 312 - Allow to set alignment of image in a table cell.
Bug 326 - Something is missing in order to move the object on the sheet.
Bug 327 - Problem with the adding of tables in Footer.
Bug 328 - Performance problem in CellRange constructor when Table.getRowCount() is large.
Bug 329 - Unable to set the column widths of a table with precision.
Bug 333 - Provide convenient methods for image and text span.

API changes since 0.5 Release

Method Change List
Note: The first column 'Java class' package is relative to 'org.odftoolkit'.

Previous Class	Previous Method	New Class	New Method
simple.table.Cell	void setImage(URI)	simple.table.Cell	Image setImage(URI)
simple.table.Cell	Image getImage()	simple.table.Cell	BufferedImage getBufferedImage()

Release 0.5
April 2nd 2011

We released the Simple Java API for ODF version 0.5 today.

In this version, we provides paragraph, field, and text box manipulation methods. - Paragraph methods allow you to create paragraph, get paragraph by index, set the text content, and remove paragraph. - Fields methods allow you to easily add a field to a document, and change the value of a field. We now support data field, time field, chapter field, title field, subject field, author field, page number field, page count field, etc. - Text box methods allow you to add a text box, change the content of text box, and delete a text box.
You can implement powerful document generation scenarios with these API. You can get sample codes from the cookbook for paragraph, field and text box.

Resolved Issues

Bug 307 - Table.getColumnByIndex() throws NullPointerException.
Bug 308 - Remove padding from table in header/footer.
Bug 314 - Navigation API should support find/replace in a specific OdfElement range
Bug 315 - Add Field API to Simple ODF
Bug 316 - Access to header and footer to Standard and First Page.
Bug 317 - Table.getColumnCount() doesn't work when exists table:table-columns
Bug 318 - Provide paragraph functions and its style handling functions.
Bug 319 - Provide frame and text box API.
Bug 320 - Section should provide methods to access paragraph.
Bug 323 - VariableContainer should have a method to get its VariableFields.
Bug 324 - Table unnamed causes a NullPointerException.

API changes since 0.4.5 Release
Method Change List
Note: The first column 'Java class' package is relative to 'org.odftoolkit'.

Previous Class	Previous Method	New Class	New Method
simple.table.CellStyleHandler	getCellStyleElementForRead()	simple.style.DefaultStyleHandler	getStyleElementForRead()
simple.table.CellStyleHandler	getCellStyleElementForWrite()	simple.style.DefaultStyleHandler	getStyleElementForWrite()

Release 0.4.5
March 4th 2011

We are pleased to announce the release of the Simple Java API for ODF version 0.4.5. Major changes in this release include:

We are now using ODFDOM 0.8.7
We have added initial support for footers and headers. Now you can simply get the footer and header of text document and add table/image/string content to footer and header.
We have also improved the performance of copying slides from other presentations (foreign slides). The time to copy a single slide is decreased by 20%, and the time to copy slides with referenced resources is decreased much more. A sample to show the function of copying slides from foreign documents is available in the website.

Resolved Issues

Bug 224 - Setting note for individual cell
Bug 254 - Update Simple API to support ODFDOM 0.8.7
Bug 274 - Create row/column/cell with/without repeat number
Bug 275 - Append row/column with/without previous row/column style
Bug 276 - Cell format type can be auto calculated according to the style of cell
Bug 278 - Adding border to created cell, OutOfMemoryError was throwed about 11,000 records
Bug 284 - Cell.getFont() throws NullPointerException
Bug 290 - Table API doesn't work for Presentation Document
Bug 295 - The Simple API does not work with JDK5
Bug 303 - Performance tuning for foreign slide copy
Bug 304 - Support image and text in footer and header
Bug 305 - A bug that occurs when resizing the column width of a table to 0
Bug 306 - Errors when Locale is set to Germany

There is no API changes in this version.

Release 0.4
January 31st 2011

We are pleased to announce that we are releasing version 0.4 of the Simple Java API for ODF today. In this version, we have added powerful list functions. With these new methods, you can easily add lists to text document and presentation document, with numbering, bullets, or graphic bullets. An interesting code sample of this API is available in the website.
We have also introduced methods to get, copy and paste sections in text documents. Copying and pasting sections are useful when you want to clone a section of a template multiple times for different data. The introduce of list and section functions has been added to cookbook for your reference.
Also, along with various bug fixes we have greatly improved the performance of the table API. Now creating a large table by adding one row after another is 20 times faster than before.

There is no API changes in this version.

Resolved Issues

Bug 279 - The performance of Table API need enhance, some methods cost too much time
Bug 280 - Supply List API Support in Simple API
Bug 285 - Supply text through line and under line setting support to Font
Bug 291 - Provide high level methods for section

Release 0.3.5
December 24th 2010

Today we released a new version of the Simple Java API for ODF: Release 0.3.5. In this version, we have improved the navigation, text extraction, table and style handling features by fixing bugs and improving the JavaDoc. We also fixed a memory leak issue related to tables.
You may notice that there are no new features in this month's release. Our intent is to alternate "bug fixing" releases with "new feature" release. So next month will be a new feature release (0.4) followed by a bug fixing release (0.4.5), etc.

Resolved Issues

Bug 250 - Table.newTable(Document document, int numRows, int numCols) does not work well
Bug 251 - Table.appendRows throws ClassCastException
Bug 253 - Column.setWidth() don't work for new created table
Bug 255 - cell.setFormatString() and column.setWidth() throw exceptions
Bug 258 - Where documentation says "deprecated" new preferred way should be given
Bug 259 - Setting font style to a spreadsheet cell is incorrectly inherited
Bug 261 - JavaDoc for the TextExtractor needs a lot more prose
Bug 262 - JavaDoc for TextNavigation match() method is confusing
Bug 266 - hasNext() method of TextNavigation apparently is REQUIRED and should not be
Bug 267 - String returned by TextExtractor.getText() has a carriage return (ASCII 13) at the start
Bug 271 - Comments of Table Style API
Bug 272 - Static Map variables in Table lead memory leak

API changes since 0.3 Release
Enum name change list
The enum's defined in org.odftoolkit.simple.style.StyleTypeDefinitions have changed. The prefix "Simple" has been removed.

Note: The first column 'Java class' package is relative to 'org.odftoolkit.simple'.

Class	Enum Previous name	Enum New name
style.StyleTypeDefinitions	SimpleFontStyle	FontStyle
	SimpleHorizontalAlignmentType	HorizontalAlignmentType
	SimpleVerticalAlignmentType	VerticalAlignmentType
	SimpleCellBordersType	CellBordersType

Method name change list
Note: The first column 'Java class' package is relative to 'org.odftoolkit.simple'.

Class	Previous method	New method
common.navigation.Navigation	getCurrentItem()	nextSelection()
common.navigation.TextNavigation	getCurrentItem()	nextSelection()
common.navigation.TextStyleNavigation	getCurrentItem()	nextSelection()
style.Font	setSimpleFontStyle(StyleTypeDefinitions$SimpleFontStyle)	setFontStyle(StyleTypeDefinitions$FontStyle)
	StyleTypeDefinitions.SimpleFontStyle getSimpleFontStyle()	StyleTypeDefinitions$FontStyle getFontStyle()

Method deleted
The locale handling methods in org.odftoolkit.simple.style.Font have been removed in order to simplify the API. Users who want to use advanced functions can use the suggested substitute.

Note: The first column 'Java class' package is relative to 'org.odftoolkit.simple'.

Class	deleted method	suggested substitute
style.Font	Locale setLocale()	CellStyleHandler.setFont(Font font, Locale language)
style.Font	Locale getLocale()	CellStyleHandler.getCountry(ScriptType type),CellStyleHandler.getLanguage(ScriptType type)

Release 0.3
December 1st 2010

We are pleased to announce the 2nd release of the Simple Java API for ODF. In this release. we provided easy-to-use functions for setting the text and border styles in tables, as a first taste of a high-level style API.
We also enhanced the navigation functions. Now the navigation functions work for text, spreadsheet, presentation and chart document. An instructive sample has been added to the website to demonstrate these powerful functions.
There are also a few updates in table cell functions: some functions are enhanced and some functions are marked as "Deprecated". More details are described below.

Resolved Issues

Bug 246- Extend the navigation API under simple.text.search to spreadsheet and presentation.
Bug 247- Provide table methods for presentation document.
Bug 248- setHorizontalAlignment and setVerticalAlignment do not work for new created table.
Bug 249- getRowCount() doesn't work if table:table-rows or table:table-group exits.
Bug 252- Provide high level style methods for table.

API changes since 0.2 Release
Package/Class Change List
Note: The first column 'Java class' package is relative to 'org.odftoolkit'.

Previous Package	Previous Class	New Package	New Class
simple.text.search	Navigation	simple.common.navigation	Navigation
	Selection		Selection
	TextNavigation		TextNavigation
	TextSelection		TextSelection
	TextStyleNavigation		TextStyleNavigation
	InvalidNavigationException		InvalidNavigationException

Release 0.2

Simple Java API for ODF 0.2 has been released on Nov 1th, with table, presentation, and metadata convenient methods moved from ODFDOM into a new package structure. Better documents are provided in this release. The cookbook, JavaDoc and demo codes can be found. You can download the binary jar file from downloads page.
Go to PackageLayer to get an overall introduction of package structure and the API changes from ODFDOM.

General¶

Components¶

Community¶

Development¶

PPMC¶

ASF¶

Simple API Release Notes