+ Since version 0.8, new APIs are added to support forms. Because controls are implementation-dependent, the default form provider will follow the capability defined by OpenOffice.org, it may not be fully compatible with other ODF editors. You can use the following code to create a form.
+
+
+ TextDocument textDoc = TextDocument.newTextDocument();
+ Form form = textDoc.createForm("Form1");
+
+
+ Following code shows how to get a form in a text document and remove it.
+
+ Below codes will create a button and add it to the text document with a paragraph as the anchor position. The FrameRectangle specifies an area and the position of this button. The last two parameters are used to specify the control name and the initialized label value.
+
+
+ Paragraph para = doc.addParagraph("Add form button here:");
+ FrameRectangle btnRtg = new FrameRectangle(0.5, 2, 2.9433, 0.5567, SupportedLinearMeasure.IN);
+ Button btn = (Button)form.createButton(para, btnRtg, "Button1", "Push Button 1");
+
+
+ You can get an iterator of the button as follows.
+
+ Below codes will create a text box and add it to the text document with a paragraph as the anchor position. The last parameter are used to specify whether this text box supports multiple-line input.
+
+
+ Paragraph para = doc.addParagraph("Add text box here:");
+ FrameRectangle textBoxRtg = new FrameRectangle(0.5, 0.2846, 2.9432, 0.8567, SupportedLinearMeasure.IN);
+ TextBox textbox = (TextBox)form.createTextBox(para, textBoxRtg, "TextBox1", "Please input your value here", true);
+
+
+ You can get an iterator of the text box as follows.
+
+ Below codes will create a list box and add it to the text document with a paragraph as the anchor position. The fourth parameter is used to specify whether this list box supports multiple selection. And the last parameter is used to specify the visibility of a drop-down list.
+
+
+ Paragraph para = doc.addParagraph("Add list box here:");
+ FrameRectangle listBoxRtg = new FrameRectangle(0.5752, 0.1429, 2.3307, 0.8398, SupportedLinearMeasure.IN);
+ ListBox listBox = (ListBox)form.createListBox(para, listBoxRtg, "ListBox", true, false);
+
+
+ You can get an iterator of the list box as follows.
+
+ Below codes will create a combo box and initialize its entry list with a string array. The last parameter is used to specify the visibility of a drop-down list.
+
Run the following codes will get the text content of the searched String "good" and the corresponding index in the text document.
@@ -68,23 +69,95 @@
pastesource.pasteAtEndOf(item);
}
- Replace String
+ Replace String with String
The following codes replace all the string "replacesource" with the string "replacedest" in the text document.
+The following codes replace all the string "replacesource" with an image. There are two ways to call the replaceWith method. You can use an image URI as parameter.
+
+
+ search2 = null;
+ search2 = newTextNavigation("replacesource", textdoc);
+ while (search2.hasNext()) {
+ TextSelection item= (TextSelection) search2.nextSelection();
+ //Use URI as parameter.
+ item.replaceWith(newURI("image.png"));
+ }
+
+
+Or you can use an Image object as below:
+
+
+ //Use Image as parameter.
+ item.replaceWith(Image.newImage(para, newURI("image.png")));
+
To add reference for a string, you can do like the following codes. Here function addHref is used, the parameter of it is an URL object. The codes add network address "http:www.ibm.com" to the string "network".
Adding comment is a useful function when review document, such as spell check and security check. You can do it like the following codes. Here, function addComment is used, the first parameter is the comment content, the second parameter is the comment author. The codes add a spell suggestion before the string "natwork".
Field Selection is a decorator class of TextSelection, which help user replace a text content with field. Following code can be used to search the document content, and replace with a simple field.
Similar with TextNavigation, TextStyleNavigation has two main functions: getCurrentItem() and hasNext() which is shown in the following codes. The input parameter of TextStyleNavigation constructor is a map of OdfStyleProperty, so here a TreeMap "searchProps" which contains the Style properties is used to construct the TextStyleNavigation object.
+Since version 0.8, new APIs are added to format a table, which will load the formatting from a template table in a foreign document and apply them to corresponding cells of current table. The template table should be a 5*5 table with predefined formatting, includes number format, text format, text alignment, borders and background. The following code will load formatting from a foreign template table - Table1 in TemplateTable.odt, and apply the styles to a new table - Table2 in TargetTable.odt.
+
+ From version 0.8, you can copy contents from a source TextDocument and then insert them to the current TextDocument. The insert position is relative to a reference Paragraph, before or after. You can also choose to copy the styles with the contents or not.
+
To add a new paragraph to a text document, the following codes can be used, the first one add an empty paragraph to the end of the document, and the second one add a new paragraph with the corresponding texts to the document.
@@ -144,11 +159,23 @@
aSection.remove();
+
+ From version 0.8, we support high level APIs to protect a section. You can use the following code to set the protection without a password:
+
+
+ aSection.setProtected(true);
+
+
+ If you want to protect a section with a password, you can use the following code.
+
+ From version 0.8, we support to appoint the page style for the page that follows the added page break. You can get a page style by the name and use it as one parameter when adding a page break.
+
+ From version 0.8, we support high level APIs to add table of content (TOC). You can add TOC before/after a reference paragraph by following code. The first parameter is the reference paragraph, the second parameter specifies where to insert the TOC, "true" means before the reference paragraph, "false" means after the reference paragraph.
+
+ You can also specify the additional paragraph styles applied on the created TOC. The following codes shows how to generate a TOC before a reference paragraph with customized styles.
+