You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2015/03/30 07:51:24 UTC
svn commit: r1669997 [42/49] - in
/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs: ./
org/apache/pdfbox/contentstream/ org/apache/pdfbox/contentstream/class-use/
org/apache/pdfbox/contentstream/operator/
org/apache/pdfbox/contentstream/opera...
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:39 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:02 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -107,68 +107,7 @@
<tr class="rowColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></strong></code>
-<div class="block">This represents an outline in a pdf document.</div>
-</td>
-</tr>
-</tbody>
-</table>
-<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
-<caption><span>Methods in <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline</a> that return <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a></span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Method and Description</th>
-</tr>
-<tbody>
-<tr class="altColor">
-<td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a></code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getParent()">getParent</a></strong>()</code>
-<div class="block">Get the parent of this object.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a></code></td>
-<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#getParent()">getParent</a></strong>()</code>
-<div class="block">Get the parent of this object.</div>
-</td>
-</tr>
-</tbody>
-</table>
-<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
-<caption><span>Methods in <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline</a> with parameters of type <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a></span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Method and Description</th>
-</tr>
-<tbody>
-<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#setFirstChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">setFirstChild</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> outlineNode)</code>
-<div class="block">Set the first child, this will be maintained by this class.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#setLastChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">setLastChild</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> outlineNode)</code>
-<div class="block">Set the last child, this will be maintained by this class.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#setNextSibling(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">setNextSibling</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> outlineNode)</code>
-<div class="block">Set the next sibling, this will be maintained by this class.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#setParent(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">setParent</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> parent)</code>
-<div class="block">Set the parent of this object, this is maintained by these objects and should not
- be called by any clients of PDFBox code.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#setPreviousSibling(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">setPreviousSibling</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> outlineNode)</code>
-<div class="block">Set the previous sibling, this will be maintained by this class.</div>
+<div class="block">This represents an outline item in a pdf document.</div>
</td>
</tr>
</tbody>
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:38 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:01 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:38 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:01 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -89,13 +89,13 @@
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></td>
<td class="colLast">
-<div class="block">This represents an outline in a pdf document.</div>
+<div class="block">This represents an outline item in a pdf document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a></td>
<td class="colLast">
-<div class="block">This represents an node in an outline in a pdf document.</div>
+<div class="block">Base class for a node in the outline of a PDF document.</div>
</td>
</tr>
</tbody>
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:38 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:01 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline Class Hierarchy (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -75,13 +75,17 @@
<ul>
<li type="circle">java.lang.<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><span class="strong">Object</span></a>
<ul>
-<li type="circle">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline"><span class="strong">PDOutlineNode</span></a> (implements org.apache.pdfbox.pdmodel.common.<a href="../../../../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a>)
+<li type="circle">org.apache.pdfbox.pdmodel.common.<a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html" title="class in org.apache.pdfbox.pdmodel.common"><span class="strong">PDDictionaryWrapper</span></a> (implements org.apache.pdfbox.pdmodel.common.<a href="../../../../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a>)
+<ul>
+<li type="circle">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline"><span class="strong">PDOutlineNode</span></a>
<ul>
<li type="circle">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDDocumentOutline.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline"><span class="strong">PDDocumentOutline</span></a></li>
<li type="circle">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline"><span class="strong">PDOutlineItem</span></a></li>
</ul>
</li>
</ul>
+</li>
+</ul>
</li>
</ul>
</div>
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:39 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:03 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Uses of Package org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -89,10 +89,8 @@
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><a href="#org.apache.pdfbox.util">org.apache.pdfbox.util</a></td>
-<td class="colLast">
-<div class="block">This package contains utility classes that are used by the PDFBox project.</div>
-</td>
+<td class="colFirst"><a href="#org.apache.pdfbox.text">org.apache.pdfbox.text</a></td>
+<td class="colLast"> </td>
</tr>
</tbody>
</table>
@@ -125,29 +123,29 @@
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.html#org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a>
-<div class="block">This represents an outline in a pdf document.</div>
+<div class="block">This represents an outline item in a pdf document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html#org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a>
-<div class="block">This represents an node in an outline in a pdf document.</div>
+<div class="block">Base class for a node in the outline of a PDF document.</div>
</td>
</tr>
</tbody>
</table>
</li>
-<li class="blockList"><a name="org.apache.pdfbox.util">
+<li class="blockList"><a name="org.apache.pdfbox.text">
<!-- -->
</a>
<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
-<caption><span>Classes in <a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline</a> used by <a href="../../../../../../../org/apache/pdfbox/util/package-summary.html">org.apache.pdfbox.util</a></span><span class="tabEnd"> </span></caption>
+<caption><span>Classes in <a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline</a> used by <a href="../../../../../../../org/apache/pdfbox/text/package-summary.html">org.apache.pdfbox.text</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
-<td class="colOne"><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.html#org.apache.pdfbox.util">PDOutlineItem</a>
-<div class="block">This represents an outline in a pdf document.</div>
+<td class="colOne"><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.html#org.apache.pdfbox.text">PDOutlineItem</a>
+<div class="block">This represents an outline item in a pdf document.</div>
</td>
</tr>
</tbody>
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:37 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:00 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PDAcroForm (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -37,7 +37,7 @@
</div>
<div class="subNav">
<ul class="navList">
-<li>Prev Class</li>
+<li><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/FieldUtils.html" title="class in org.apache.pdfbox.pdmodel.interactive.form"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html" title="class in org.apache.pdfbox.pdmodel.interactive.form"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
@@ -163,7 +163,7 @@ implements <a href="../../../../../../or
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code><a href="../../../../../../org/apache/pdfbox/cos/COSString.html" title="class in org.apache.pdfbox.cos">COSString</a></code></td>
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getDefaultAppearance()">getDefaultAppearance</a></strong>()</code>
<div class="block">Get the default appearance.</div>
</td>
@@ -195,7 +195,7 @@ implements <a href="../../../../../../or
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getFields()">getFields</a></strong>()</code>
-<div class="block">This will return all of the fields in the document.</div>
+<div class="block">This will return all of the documents root fields.</div>
</td>
</tr>
<tr class="altColor">
@@ -215,91 +215,103 @@ implements <a href="../../../../../../or
</td>
</tr>
<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#hasXFA()">hasXFA</a></strong>()</code>
+<div class="block">This will tell if the AcroForm has XFA content.</div>
+</td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#importFDF(org.apache.pdfbox.pdmodel.fdf.FDFDocument)">importFDF</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.apache.pdfbox.pdmodel.fdf">FDFDocument</a> fdf)</code>
<div class="block">This method will import an entire FDF document into the PDF document
that this acroform is part of.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#isAppendOnly()">isAppendOnly</a></strong>()</code>
<div class="block">Determines if AppendOnly is set.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#isCachingFields()">isCachingFields</a></strong>()</code>
<div class="block">This will tell if this acro form is caching the fields.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#isNeedAppearances()">isNeedAppearances</a></strong>()</code>
<div class="block">Get the value of NeedAppearances.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#isSignaturesExist()">isSignaturesExist</a></strong>()</code>
<div class="block">Determines if SignaturesExist is set.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setAppendOnly(boolean)">setAppendOnly</a></strong>(boolean appendOnly)</code>
<div class="block">Set the AppendOnly bit.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setCacheFields(boolean)">setCacheFields</a></strong>(boolean cache)</code>
<div class="block">This will tell this form to cache the fields into a Map structure
for fast access via the getField method.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> daValue)</code>
<div class="block">Set the default appearance.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setDefaultResources(org.apache.pdfbox.pdmodel.PDResources)">setDefaultResources</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/PDResources.html" title="class in org.apache.pdfbox.pdmodel">PDResources</a> dr)</code>
<div class="block">This will set the default resources for the acroform.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setFields(java.util.List)">setFields</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a>> fields)</code>
-<div class="block">Set the fields that are part of this AcroForm.</div>
+<div class="block">Set the documents root fields.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setNeedAppearances(java.lang.Boolean)">setNeedAppearances</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> value)</code>
<div class="block">Set the NeedAppearances value.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setQ(int)">setQ</a></strong>(int q)</code>
<div class="block">This will set the quadding/justification of the text.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setSignaturesExist(boolean)">setSignaturesExist</a></strong>(boolean signaturesExist)</code>
<div class="block">Set the SignaturesExist bit.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setXFA(org.apache.pdfbox.pdmodel.interactive.form.PDXFAResource)">setXFA</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDXFAResource.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDXFAResource</a> xfa)</code>
<div class="block">Set the XFA resource, this is only used for PDF 1.5+ forms.</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html#xfaIsDynamic()">xfaIsDynamic</a></strong>()</code>
+<div class="block">This will tell if the AcroForm is a dynamic XFA form.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -411,9 +423,15 @@ implements <a href="../../../../../../or
<li class="blockList">
<h4>getFields</h4>
<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a>> getFields()</pre>
-<div class="block">This will return all of the fields in the document. The type
- will be a org.apache.pdfbox.pdmodel.field.PDField.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>A list of all the fields.</dd></dl>
+<div class="block">This will return all of the documents root fields.
+
+ A field might have children that are fields (non-terminal field) or does not
+ have children which are fields (terminal fields).
+
+ The fields within an AcroForm are organized in a tree structure. The documents root fields
+ might either be terminal fields, non-terminal fields or a mixture of both. Non-terminal fields
+ mark branches which contents can be retrieved using <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getKids()"><code>PDFieldTreeNode.getKids()</code></a>.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>A list of the documents root fields.</dd></dl>
</li>
</ul>
<a name="setFields(java.util.List)">
@@ -423,8 +441,8 @@ implements <a href="../../../../../../or
<li class="blockList">
<h4>setFields</h4>
<pre>public void setFields(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a>> fields)</pre>
-<div class="block">Set the fields that are part of this AcroForm.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fields</code> - The fields that are part of this form.</dd></dl>
+<div class="block">Set the documents root fields.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fields</code> - The fields that are part of the documents root fields.</dd></dl>
</li>
</ul>
<a name="setCacheFields(boolean)">
@@ -476,7 +494,7 @@ implements <a href="../../../../../../or
<ul class="blockList">
<li class="blockList">
<h4>getDefaultAppearance</h4>
-<pre>public <a href="../../../../../../org/apache/pdfbox/cos/COSString.html" title="class in org.apache.pdfbox.cos">COSString</a> getDefaultAppearance()</pre>
+<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefaultAppearance()</pre>
<div class="block">Get the default appearance.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the DA element of the dictionary object</dd></dl>
</li>
@@ -551,6 +569,28 @@ implements <a href="../../../../../../or
<dt><span class="strong">Returns:</span></dt><dd>The cos object that matches this Java object.</dd></dl>
</li>
</ul>
+<a name="hasXFA()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasXFA</h4>
+<pre>public boolean hasXFA()</pre>
+<div class="block">This will tell if the AcroForm has XFA content.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the AcroForm is an XFA form</dd></dl>
+</li>
+</ul>
+<a name="xfaIsDynamic()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>xfaIsDynamic</h4>
+<pre>public boolean xfaIsDynamic()</pre>
+<div class="block">This will tell if the AcroForm is a dynamic XFA form.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the AcroForm is a dynamic XFA form</dd></dl>
+</li>
+</ul>
<a name="getXFA()">
<!-- -->
</a>
@@ -669,7 +709,7 @@ implements <a href="../../../../../../or
</div>
<div class="subNav">
<ul class="navList">
-<li>Prev Class</li>
+<li><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/FieldUtils.html" title="class in org.apache.pdfbox.pdmodel.interactive.form"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html" title="class in org.apache.pdfbox.pdmodel.interactive.form"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDButton.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDButton.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDButton.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDButton.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:37 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:00 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PDButton (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -141,23 +141,17 @@ extends <a href="../../../../../../org/a
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_NO_TOGGLE_TO_OFF">FLAG_NO_TOGGLE_TO_OFF</a></strong></code>
-<div class="block">A Ff flag.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_PUSHBUTTON">FLAG_PUSHBUTTON</a></strong></code>
<div class="block">A Ff flag.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_RADIO">FLAG_RADIO</a></strong></code>
<div class="block">A Ff flag.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_RADIOS_IN_UNISON">FLAG_RADIOS_IN_UNISON</a></strong></code>
<div class="block">A Ff flag.</div>
@@ -175,12 +169,13 @@ extends <a href="../../../../../../org/a
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
-<th class="colFirst" scope="col">Modifier</th>
-<th class="colLast" scope="col">Constructor and Description</th>
+<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected </code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#PDButton(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDButton</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> acroForm,
+<td class="colOne"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#PDButton(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">PDButton</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> theAcroForm)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#PDButton(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDButton</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> acroForm,
<a href="../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> field,
<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a> parentNode)</code>
<div class="block">Constructor.</div>
@@ -202,15 +197,51 @@ extends <a href="../../../../../../org/a
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#getDefaultValue()">getDefaultValue</a></strong>()</code>
+<div class="block">Get the value of the "DV" entry.</div>
+</td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#getOptions()">getOptions</a></strong>()</code>
-<div class="block">This will get the option values "Opt" entry of the pdf button.</div>
+<div class="block">This will get the option values - the "Opt" entry.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#isPushButton()">isPushButton</a></strong>()</code>
+<div class="block">Determines if push button bit is set.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#isRadioButton()">isRadioButton</a></strong>()</code>
+<div class="block">Determines if radio button bit is set.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setDefaultValue(java.lang.String)">setDefaultValue</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code>
+<div class="block">Set the fields default value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setOptions(java.util.List)">setOptions</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> options)</code>
-<div class="block">Set the field options values.</div>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setOptions(java.util.List)">setOptions</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> values)</code>
+<div class="block">This will set the options.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setPushButton(boolean)">setPushButton</a></strong>(boolean pushbutton)</code>
+<div class="block">Set the push button bit.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setRadioButton(boolean)">setRadioButton</a></strong>(boolean radiobutton)</code>
+<div class="block">Set the radio button bit.</div>
</td>
</tr>
</table>
@@ -226,7 +257,7 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#createField(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">createField</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#findKid(java.lang.String[], int)">findKid</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getAcroForm()">getAcroForm</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getActions()">getActions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getAlternateFieldName()">getAlternateFieldName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getAsTextStream(org.apache.pdfbox.cos.COSBase)">getAsTextStream</a>, <a href="../../../../../../org/ap
ache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getCOSObject()">getCOSObject</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDefaultValue()">getDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDictionary()">getDictionary</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getFullyQualifiedName()">getFullyQualifiedName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getInheritableAttribute(org.apache.pdfbox.cos.COSName)">getInheritableAttribute</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getInheritableAttributesNode(org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode, org.apache.pdfbox.cos.COSName)">getInheritableAttributesNode</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeN
ode.html#getKids()">getKids</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getMappingName()">getMappingName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getParent()">getParent</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getPartialName()">getPartialName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getValue()">getValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getWidget()">getWidget</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#importFDF(org.apache.pdfbox.pdmodel.fdf.FDFField)">importFDF</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#isNoExport()">isNoExport</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDF
ieldTreeNode.html#isReadonly()">isReadonly</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#isRequired()">isRequired</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#removeInheritableAttribute(org.apache.pdfbox.cos.COSName)">removeInheritableAttribute</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setAcroForm(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">setAcroForm</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setAlternateFieldName(java.lang.String)">setAlternateFieldName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setDefaultValue(java.lang.String)">setDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setFieldFlags(int)">setFieldFlags</a>, <a href="../../../../../../org/apa
che/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setInheritableAttribute(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.cos.COSBase)">setInheritableAttribute</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setKids(java.util.List)">setKids</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setMappingName(java.lang.String)">setMappingName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setNoExport(boolean)">setNoExport</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setParent(org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">setParent</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setPartialName(java.lang.String)">setPartialName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setRead
only(boolean)">setReadonly</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setRequired(boolean)">setRequired</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setValue(java.lang.String)">setValue</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#createField(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">createField</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#findKid(java.lang.String[], int)">findKid</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getAcroForm()">getAcroForm</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getActions()">getActions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getAlternateFieldName()">getAlternateFieldName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getAsTextStream(org.apache.pdfbox.cos.COSBase)">getAsTextStream</a>, <a href="../../../../../../org/ap
ache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getCOSObject()">getCOSObject</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDictionary()">getDictionary</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getFullyQualifiedName()">getFullyQualifiedName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getInheritableAttribute(org.apache.pdfbox.cos.COSName)">getInheritableAttribute</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getInheritableAttributesNode(org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode, org.apache.pdfbox.cos.COSName)">getInheritableAttributesNode</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getKids()">getKids</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getMapp
ingName()">getMappingName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getParent()">getParent</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getPartialName()">getPartialName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getValue()">getValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getWidget()">getWidget</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#importFDF(org.apache.pdfbox.pdmodel.fdf.FDFField)">importFDF</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#isNoExport()">isNoExport</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#isReadonly()">isReadonly</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNo
de.html#isRequired()">isRequired</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#removeInheritableAttribute(org.apache.pdfbox.cos.COSName)">removeInheritableAttribute</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setAcroForm(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">setAcroForm</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setAlternateFieldName(java.lang.String)">setAlternateFieldName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setFieldFlags(int)">setFieldFlags</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setInheritableAttribute(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.cos.COSBase)">setInheritableAttribute</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setKids(java.u
til.List)">setKids</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setMappingName(java.lang.String)">setMappingName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setNoExport(boolean)">setNoExport</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setParent(org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">setParent</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setPartialName(java.lang.String)">setPartialName</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setReadonly(boolean)">setReadonly</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setRequired(boolean)">setRequired</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setValue(java.lang.String
)">setValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -249,17 +280,6 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Field Detail</h3>
-<a name="FLAG_NO_TOGGLE_TO_OFF">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>FLAG_NO_TOGGLE_TO_OFF</h4>
-<pre>public static final int FLAG_NO_TOGGLE_TO_OFF</pre>
-<div class="block">A Ff flag.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.pdfbox.pdmodel.interactive.form.PDButton.FLAG_NO_TOGGLE_TO_OFF">Constant Field Values</a></dd></dl>
-</li>
-</ul>
<a name="FLAG_RADIO">
<!-- -->
</a>
@@ -267,7 +287,7 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>FLAG_RADIO</h4>
<pre>public static final int FLAG_RADIO</pre>
-<div class="block">A Ff flag.</div>
+<div class="block">A Ff flag. If set, the field is a set of radio buttons</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.pdfbox.pdmodel.interactive.form.PDButton.FLAG_RADIO">Constant Field Values</a></dd></dl>
</li>
</ul>
@@ -278,7 +298,7 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>FLAG_PUSHBUTTON</h4>
<pre>public static final int FLAG_PUSHBUTTON</pre>
-<div class="block">A Ff flag.</div>
+<div class="block">A Ff flag. If set, the field is a pushbutton.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.pdfbox.pdmodel.interactive.form.PDButton.FLAG_PUSHBUTTON">Constant Field Values</a></dd></dl>
</li>
</ul>
@@ -289,7 +309,8 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>FLAG_RADIOS_IN_UNISON</h4>
<pre>public static final int FLAG_RADIOS_IN_UNISON</pre>
-<div class="block">A Ff flag.</div>
+<div class="block">A Ff flag. If set, radio buttons individual fields, using the same
+ value for the on state will turn on and off in unison.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.pdfbox.pdmodel.interactive.form.PDButton.FLAG_RADIOS_IN_UNISON">Constant Field Values</a></dd></dl>
</li>
</ul>
@@ -301,13 +322,23 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="PDButton(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PDButton</h4>
+<pre>public PDButton(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> theAcroForm)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theAcroForm</code> - The acroform.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#PDFieldTreeNode(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)"><code>PDFieldTreeNode.PDFieldTreeNode(PDAcroForm)</code></a></dd></dl>
+</li>
+</ul>
<a name="PDButton(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PDButton</h4>
-<pre>protected PDButton(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> acroForm,
+<pre>public PDButton(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> acroForm,
<a href="../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> field,
<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a> parentNode)</pre>
<div class="block">Constructor.</div>
@@ -322,6 +353,99 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Method Detail</h3>
+<a name="isPushButton()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isPushButton</h4>
+<pre>public boolean isPushButton()</pre>
+<div class="block">Determines if push button bit is set.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if type of button field is a push button.</dd></dl>
+</li>
+</ul>
+<a name="setPushButton(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setPushButton</h4>
+<pre>public void setPushButton(boolean pushbutton)</pre>
+<div class="block">Set the push button bit.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pushbutton</code> - if true the button field is treated as a push button field.</dd></dl>
+</li>
+</ul>
+<a name="isRadioButton()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isRadioButton</h4>
+<pre>public boolean isRadioButton()</pre>
+<div class="block">Determines if radio button bit is set.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if type of button field is a push button.</dd></dl>
+</li>
+</ul>
+<a name="setRadioButton(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setRadioButton</h4>
+<pre>public void setRadioButton(boolean radiobutton)</pre>
+<div class="block">Set the radio button bit.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>radiobutton</code> - if true the button field is treated as a radio button field.</dd></dl>
+</li>
+</ul>
+<a name="getDefaultValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDefaultValue</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefaultValue()
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDefaultValue()">PDFieldTreeNode</a></code></strong></div>
+<div class="block">Get the value of the "DV" entry. The "DV" entry is an inheritable attribute.
+
+ This will return null if the "DV" entry doesn't exist or if it has no value assigned.
+
+ The different field types do require specific object types for their value
+ e.g. for RadioButtons the DV entry needs to be a name object.
+ If the value doesn't match the expected type an IOException is thrown. Such a wrong entry might
+ have been set with a different library or by using PDFBox low level COS model.
+
+ To get the value in such cases the lower level COS model can be used.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDefaultValue()">getDefaultValue</a></code> in class <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>The value of this field.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error reading the data for this field
+ or the type is not in line with the fields required type.</dd></dl>
+</li>
+</ul>
+<a name="setDefaultValue(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDefaultValue</h4>
+<pre>public void setDefaultValue(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre>
+<div class="block">Set the fields default value.
+
+ The field value holds a name object which is corresponding to the
+ appearance state representing the corresponding appearance
+ from the appearance directory.
+
+ The default value is used to represent the initial state of the
+ field or to revert when resetting the form.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setDefaultValue(java.lang.String)">setDefaultValue</a></code> in class <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - the new field value.</dd></dl>
+</li>
+</ul>
<a name="getOptions()">
<!-- -->
</a>
@@ -329,8 +453,19 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>getOptions</h4>
<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getOptions()</pre>
-<div class="block">This will get the option values "Opt" entry of the pdf button.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>A list of java.lang.String values.</dd></dl>
+<div class="block">This will get the option values - the "Opt" entry.
+
+ <p>The option values are used to define the export values
+ for the field to
+ <ul>
+ <li>hold values in non-Latin writing systems as name objects, which represent the field value, are limited
+ to PDFDocEncoding
+ </li>
+ <li>allow radio buttons having the same export value to be handled independently
+ </li>
+ </ul>
+ </p></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>List containing all possible options. If there is no Opt entry an empty list will be returned.</dd></dl>
</li>
</ul>
<a name="setOptions(java.util.List)">
@@ -339,19 +474,9 @@ extends <a href="../../../../../../org/a
<ul class="blockListLast">
<li class="blockList">
<h4>setOptions</h4>
-<pre>public void setOptions(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> options)</pre>
-<div class="block">Set the field options values.
-
- The fields options represent the export value of each annotation in the field.
- It may be used to:
- <ul>
- <li>represent the export values in non-Latin writing systems.</li>
- <li>allow radio buttons to be checked independently, even
- if they have the same export value.</li>
- </ul>
-
- Providing an empty list or null will remove the entry.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - The list of options for the button.</dd></dl>
+<pre>public void setOptions(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> values)</pre>
+<div class="block">This will set the options.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - List containing all possible options. Supplying null or an empty list will remove the Opt entry.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#getOptions()"><code>getOptions()</code></a></dd></dl>
</li>
</ul>
</li>
Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html?rev=1669997&r1=1669996&r2=1669997&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html (original)
+++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html Mon Mar 30 05:51:10 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:37 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:22:00 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PDCheckbox (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -138,7 +138,7 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Fields inherited from class org.apache.pdfbox.pdmodel.interactive.form.<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDButton</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_NO_TOGGLE_TO_OFF">FLAG_NO_TOGGLE_TO_OFF</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_PUSHBUTTON">FLAG_PUSHBUTTON</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_RADIO">FLAG_RADIO</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_RADIOS_IN_UNISON">FLAG_RADIOS_IN_UNISON</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_PUSHBUTTON">FLAG_PUSHBUTTON</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_RADIO">FLAG_RADIO</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#FLAG_RADIOS_IN_UNISON">FLAG_RADIOS_IN_UNISON</a></code></li>
</ul>
</li>
</ul>
@@ -154,6 +154,9 @@ extends <a href="../../../../../../org/a
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#PDCheckbox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">PDCheckbox</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> theAcroForm)</code> </td>
+</tr>
+<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#PDCheckbox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDCheckbox</a></strong>(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> theAcroForm,
<a href="../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> field,
<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a> parentNode)</code>
@@ -178,45 +181,33 @@ extends <a href="../../../../../../org/a
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#check()">check</a></strong>()</code>
-<div class="block">Checks the radiobutton.</div>
+<div class="block">Checks the check box.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#getDefaultValue()">getDefaultValue</a></strong>()</code>
-<div class="block">Get the value of the "DV" entry.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#getOffValue()">getOffValue</a></strong>()</code>
-<div class="block">This will get the value of the radio button.</div>
+<div class="block">This will get the value assigned to the OFF state.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#getOnValue()">getOnValue</a></strong>()</code>
-<div class="block">This will get the value of the radio button.</div>
+<div class="block">This will get the value assigned to the ON state.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#getValue()">getValue</a></strong>()</code>
<div class="block">Get the value of the "V" entry.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#isChecked()">isChecked</a></strong>()</code>
<div class="block">This will tell if this radio button is currently checked or not.</div>
</td>
</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#setDefaultValue(java.lang.String)">setDefaultValue</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code>
-<div class="block">Set the fields default value.</div>
-</td>
-</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#setValue(java.lang.String)">setValue</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code>
@@ -226,7 +217,7 @@ extends <a href="../../../../../../org/a
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDCheckbox.html#unCheck()">unCheck</a></strong>()</code>
-<div class="block">Unchecks the radiobutton.</div>
+<div class="block">Unchecks the check box.</div>
</td>
</tr>
</table>
@@ -235,7 +226,7 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDButton</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#getOptions()">getOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setOptions(java.util.List)">setOptions</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#getDefaultValue()">getDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#getOptions()">getOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#isPushButton()">isPushButton</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#isRadioButton()">isRadioButton</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setDefaultValue(java.lang.String)">setDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setOptions(java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setPushButton(boolean)">setPushButton</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDButton.html#setRadioButton(boolean)">setRadioBut
ton</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.interactive.form.PDField">
@@ -272,6 +263,16 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="PDCheckbox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PDCheckbox</h4>
+<pre>public PDCheckbox(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> theAcroForm)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theAcroForm</code> - The acroform.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#PDFieldTreeNode(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)"><code>PDFieldTreeNode.PDFieldTreeNode(PDAcroForm)</code></a></dd></dl>
+</li>
+</ul>
<a name="PDCheckbox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">
<!-- -->
</a>
@@ -314,7 +315,7 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>check</h4>
<pre>public void check()</pre>
-<div class="block">Checks the radiobutton.</div>
+<div class="block">Checks the check box.</div>
</li>
</ul>
<a name="unCheck()">
@@ -324,7 +325,7 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>unCheck</h4>
<pre>public void unCheck()</pre>
-<div class="block">Unchecks the radiobutton.</div>
+<div class="block">Unchecks the check box.</div>
</li>
</ul>
<a name="getOffValue()">
@@ -334,8 +335,8 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>getOffValue</h4>
<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOffValue()</pre>
-<div class="block">This will get the value of the radio button.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The value of the radio button.</dd></dl>
+<div class="block">This will get the value assigned to the OFF state.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The value of the check box.</dd></dl>
</li>
</ul>
<a name="getOnValue()">
@@ -345,57 +346,8 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>getOnValue</h4>
<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOnValue()</pre>
-<div class="block">This will get the value of the radio button.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The value of the radio button.</dd></dl>
-</li>
-</ul>
-<a name="getDefaultValue()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getDefaultValue</h4>
-<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefaultValue()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDefaultValue()">PDFieldTreeNode</a></code></strong></div>
-<div class="block">Get the value of the "DV" entry. The "DV" entry is an inheritable attribute.
-
- This will return null if the "DV" entry doesn't exist or if it has no value assigned.
-
- The different field types do require specific object types for their value
- e.g. for RadioButtons the DV entry needs to be a name object.
- If the value doesn't match the expected type an IOException is thrown. Such a wrong entry might
- have been set with a different library or by using PDFBox low level COS model.
-
- To get the value in such cases the lower level COS model can be used.</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#getDefaultValue()">getDefaultValue</a></code> in class <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>The value of this field.</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error reading the data for this field
- or the type is not in line with the fields required type.</dd></dl>
-</li>
-</ul>
-<a name="setDefaultValue(java.lang.String)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setDefaultValue</h4>
-<pre>public void setDefaultValue(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre>
-<div class="block">Set the fields default value.
-
- The field value holds a name object which is corresponding to the
- appearance state representing the corresponding appearance
- from the appearance directory.
-
- The default value is used to represent the initial state of the
- checkbox or to revert when resetting the form.</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setDefaultValue(java.lang.String)">setDefaultValue</a></code> in class <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDFieldTreeNode</a></code></dd>
-<dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - the COSName object to set the field value.</dd></dl>
+<div class="block">This will get the value assigned to the ON state.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The value of the check box.</dd></dl>
</li>
</ul>
<a name="getValue()">