You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by bu...@apache.org on 2015/03/30 07:53:23 UTC
svn commit: r945586 [42/47] - in /websites/staging/pdfbox/trunk/content: ./
docs/2.0.0-SNAPSHOT/javadocs/
docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/
docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/class-use/
docs/2.0.0-S...
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html Mon Mar 30 05:53:07 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>PDChoice (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>
@@ -168,12 +168,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/PDChoice.html#PDChoice(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDChoice</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/PDChoice.html#PDChoice(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">PDChoice</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/PDChoice.html#PDChoice(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDChoice</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>
@@ -195,65 +196,89 @@ 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/PDChoice.html#getDefaultValue()">getDefaultValue</a></strong>()</code>
+<div class="block">Get the fields default value.</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/PDChoice.html#getOptions()">getOptions</a></strong>()</code>
<div class="block">This will get the option values "Opt".</div>
</td>
</tr>
+<tr class="altColor">
+<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/PDChoice.html#getOptionsDisplayValues()">getOptionsDisplayValues</a></strong>()</code>
+<div class="block">This will get the display values from the options.</div>
+</td>
+</tr>
<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getSelectedOptions()">getSelectedOptions</a></strong>()</code>
-<div class="block">This will get the indices of the selected options "I".</div>
+<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/PDChoice.html#getOptionsExportValues()">getOptionsExportValues</a></strong>()</code>
+<div class="block">This will get the export values from the options.</div>
</td>
</tr>
<tr class="altColor">
+<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/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getSelectedOptionsIndex()">getSelectedOptionsIndex</a></strong>()</code>
+<div class="block">This will get the indices of the selected options - the 'I' key.</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/PDChoice.html#getValue()">getValue</a></strong>()</code>
<div class="block">getValue gets 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/PDChoice.html#isCombo()">isCombo</a></strong>()</code>
<div class="block">Determines if Combo 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/PDChoice.html#isCommitOnSelChange()">isCommitOnSelChange</a></strong>()</code>
<div class="block">Determines if CommitOnSelChange is set.</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/PDChoice.html#isDoNotSpellCheck()">isDoNotSpellCheck</a></strong>()</code>
<div class="block">Determines if DoNotSpellCheck 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/PDChoice.html#isMultiSelect()">isMultiSelect</a></strong>()</code>
<div class="block">Determines if MultiSelect is set.</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/PDChoice.html#isSort()">isSort</a></strong>()</code>
<div class="block">Determines if Sort is set.</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/PDChoice.html#setCombo(boolean)">setCombo</a></strong>(boolean combo)</code>
<div class="block">Set the Combo 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/PDChoice.html#setCommitOnSelChange(boolean)">setCommitOnSelChange</a></strong>(boolean commitOnSelChange)</code>
<div class="block">Set the CommitOnSelChange 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/PDChoice.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> value)</code>
+<div class="block">Set the default value for the field.</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/PDChoice.html#setDoNotSpellCheck(boolean)">setDoNotSpellCheck</a></strong>(boolean doNotSpellCheck)</code>
@@ -268,29 +293,36 @@ extends <a href="../../../../../../org/a
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.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 class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.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>> displayValues)</code>
+<div class="block">This will set the display values - the 'Opt' key.</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/PDChoice.html#setSelectedOptions(org.apache.pdfbox.cos.COSArray)">setSelectedOptions</a></strong>(<a href="../../../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a> values)</code>
-<div class="block">This will set the indices of the selected options "I".</div>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List, 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>> exportValues,
+ <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>> displayValues)</code>
+<div class="block">This will set the display and export values - the 'Opt' key.</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/PDChoice.html#setSelectedOptionsIndex(java.util.List)">setSelectedOptionsIndex</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/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> values)</code>
+<div class="block">This will set the indices of the selected options - the 'I' key.</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/PDChoice.html#setSort(boolean)">setSort</a></strong>(boolean sort)</code>
<div class="block">Set the Sort 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/PDChoice.html#setValue(java.util.List)">setValue</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">setValue sets the entry "V" to the given value.</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/PDChoice.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>
<div class="block">setValue sets the entry "V" to the given value.</div>
@@ -302,7 +334,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/PDVariableText.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDVariableText</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultAppearance()">getDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultStyleString()">getDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getQ()">getQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValue()">getRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultStyleString(java.lang.String)">setDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setQ(int)">setQ</a>, <a href="../../../../../../org/apache/pdfbox
/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(java.lang.String)">setRichTextValue</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultAppearance()">getDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultStyleString()">getDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getQ()">getQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValue()">getRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValueAsStream()">getRichTextValueAsStream</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultStyleString(java.lang.String)">setDefaultStyleString</a>, <a href
="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setQ(int)">setQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(org.apache.pdfbox.pdmodel.common.PDTextStream)">setRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(java.lang.String)">setRichTextValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.interactive.form.PDField">
@@ -316,7 +348,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#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
/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/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setInheritableAttribute(org.apache.pdfbox.cos.COSName, org.a
pache.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#setReadonly(boolean)">setReadonly</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode
.html#setRequired(boolean)">setRequired</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#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/PDFieldTreeNode.html#isRequired()">isRequired</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTr
eeNode.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.util.List)">setKids</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#se
tMappingName(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></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -358,13 +390,23 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="PDChoice(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PDChoice</h4>
+<pre>public PDChoice(<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="PDChoice(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>PDChoice</h4>
-<pre>protected PDChoice(<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDAcroForm</a> acroForm,
+<pre>public PDChoice(<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>
@@ -379,6 +421,36 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Method Detail</h3>
+<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()</pre>
+<div class="block">Get the fields default value.
+
+ The value is stored in the field dictionaries "DV" entry.</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 entry.</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> value)</pre>
+<div class="block">Set the default value for the field.</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>value</code> - the value</dd></dl>
+</li>
+</ul>
<a name="getOptions()">
<!-- -->
</a>
@@ -386,8 +458,20 @@ 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".</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>COSArray containing all options.</dd></dl>
+<div class="block">This will get the option values "Opt".
+
+ <p>
+ For a choice field the options array can either be an array
+ of text strings or an array of a two-element arrays.<br/>
+ The method always only returns either the text strings or,
+ in case of two-element arrays, an array of the first element of
+ the two-element arrays
+ </p>
+ <p>
+ Use <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptionsExportValues()"><code>getOptionsExportValues()</code></a> and <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptionsDisplayValues()"><code>getOptionsDisplayValues()</code></a>
+ to get the entries of two-element arrays.
+ </p></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>List containing the export values.</dd></dl>
</li>
</ul>
<a name="setOptions(java.util.List)">
@@ -396,31 +480,116 @@ extends <a href="../../../../../../org/a
<ul class="blockList">
<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>> values)</pre>
-<div class="block">This will set the options.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - COSArray containing all possible options.</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>> displayValues)</pre>
+<div class="block">This will set the display values - the 'Opt' key.
+
+ <p>
+ The Opt array specifies the list of options in the choice field either
+ as an array of text strings representing the display value
+ or as an array of a two-element array where the
+ first element is the export value and the second the display value.
+ </p>
+ <p>
+ To set both the export and the display value use <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List, java.util.List)"><code>setOptions(List, List)</code></a>
+ </p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>displayValues</code> - List containing all possible options.</dd></dl>
</li>
</ul>
-<a name="getSelectedOptions()">
+<a name="setOptions(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getSelectedOptions</h4>
-<pre>public <a href="../../../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a> getSelectedOptions()</pre>
-<div class="block">This will get the indices of the selected options "I".</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>COSArray containing the indices of all selected options.</dd></dl>
+<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>> exportValues,
+ <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>> displayValues)</pre>
+<div class="block">This will set the display and export values - the 'Opt' key.
+
+ <p>
+ This will set both, the export value and the display value
+ of the choice field. If either one of the parameters is null or an
+ empty list is supplied the options will
+ be removed.
+ </p>
+ <p>
+ An <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown if the
+ number of items in the list differ.
+ </p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>exportValues</code> - List containing all possible export values.</dd><dd><code>displayValues</code> - List containing all possible display values.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List)"><code>setOptions(List)</code></a></dd></dl>
+</li>
+</ul>
+<a name="getOptionsDisplayValues()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOptionsDisplayValues</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>> getOptionsDisplayValues()</pre>
+<div class="block">This will get the display values from the options.
+
+ <p>
+ For options with an array of text strings the display value and export value
+ are the same.<br/>
+ For options with an array of two-element arrays the display value is the
+ second entry in the two-element array.
+ </p></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>List containing all the display values.</dd></dl>
+</li>
+</ul>
+<a name="getOptionsExportValues()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOptionsExportValues</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>> getOptionsExportValues()</pre>
+<div class="block">This will get the export values from the options.
+
+ <p>
+ For options with an array of text strings the display value and export value
+ are the same.<br/>
+ For options with an array of two-element arrays the export value is the
+ first entry in the two-element array.
+ </p></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>List containing all export values.</dd></dl>
+</li>
+</ul>
+<a name="getSelectedOptionsIndex()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSelectedOptionsIndex</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/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> getSelectedOptionsIndex()</pre>
+<div class="block">This will get the indices of the selected options - the 'I' key.
+ <p>
+ This is only needed if a choice field allows multiple selections and
+ two different items have the same export value or more than one values
+ is selected.
+ </p>
+ <p>The indices are zero-based</p></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>List containing the indices of all selected options.</dd></dl>
</li>
</ul>
-<a name="setSelectedOptions(org.apache.pdfbox.cos.COSArray)">
+<a name="setSelectedOptionsIndex(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>setSelectedOptions</h4>
-<pre>public void setSelectedOptions(<a href="../../../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a> values)</pre>
-<div class="block">This will set the indices of the selected options "I".</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - COSArray containing the indices of all selected options.</dd></dl>
+<h4>setSelectedOptionsIndex</h4>
+<pre>public void setSelectedOptionsIndex(<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/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> values)</pre>
+<div class="block">This will set the indices of the selected options - the 'I' key.
+ <p>
+ This method is preferred over <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.util.List)"><code>setValue(List)</code></a> for choice fields which
+ <ul>
+ <li>do support multiple selections</li>
+ <li>have export values with the same value</li>
+ </ul>
+ </p>
+ <p>
+ Setting the index will set the value too.
+ </p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - List containing the indices of all selected options.</dd></dl>
</li>
</ul>
<a name="isSort()">
@@ -430,7 +599,13 @@ extends <a href="../../../../../../org/a
<li class="blockList">
<h4>isSort</h4>
<pre>public boolean isSort()</pre>
-<div class="block">Determines if Sort is set.</div>
+<div class="block">Determines if Sort is set.
+
+ <p>
+ If set, the fieldâs option items shall be sorted alphabetically.
+ The sorting has to be done when writing the PDF. PDF Readers are supposed to
+ display the options in the order in which they occur in the Opt array.
+ </p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the options are sorted.</dd></dl>
</li>
</ul>
@@ -442,7 +617,7 @@ extends <a href="../../../../../../org/a
<h4>setSort</h4>
<pre>public void setSort(boolean sort)</pre>
<div class="block">Set the Sort bit.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sort</code> - The value for Sort.</dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sort</code> - The value for Sort.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isSort()"><code>isSort()</code></a></dd></dl>
</li>
</ul>
<a name="isMultiSelect()">
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.html Mon Mar 30 05:53:07 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>PDComboBox (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>
@@ -167,6 +167,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/PDComboBox.html#PDComboBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">PDComboBox</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/PDComboBox.html#PDComboBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDComboBox</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>
@@ -189,23 +192,11 @@ 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/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.html#getDefaultValue()">getDefaultValue</a></strong>()</code>
-<div class="block">Get the fields default value.</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/PDComboBox.html#isEdit()">isEdit</a></strong>()</code>
<div class="block">Determines if Edit 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/PDComboBox.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 value of the "DV" entry.</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/PDComboBox.html#setEdit(boolean)">setEdit</a></strong>(boolean edit)</code>
@@ -214,14 +205,8 @@ extends <a href="../../../../../../org/a
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDComboBox.html#setValue(java.util.List)">setValue</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">setValue sets the entry "V" to the given 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/PDComboBox.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>
-<div class="block">setValue sets the entry "V" to the given value.</div>
+<div class="block">Sets the field value - the 'V' key.</div>
</td>
</tr>
</table>
@@ -230,14 +215,14 @@ 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/PDChoice.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDChoice</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptions()">getOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getSelectedOptions()">getSelectedOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getValue()">getValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCombo()">isCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCommitOnSelChange()">isCommitOnSelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isDoNotSpellCheck()">isDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isMultiSelect()">isMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isSort()">isSort</a>, <a href="../../../../../../org/apache/pdfbo
x/pdmodel/interactive/form/PDChoice.html#setCombo(boolean)">setCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setCommitOnSelChange(boolean)">setCommitOnSelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setDoNotSpellCheck(boolean)">setDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setMultiSelect(boolean)">setMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSelectedOptions(org.apache.pdfbox.cos.COSArray)">setSelectedOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSort(boolean)">setSort</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getDefaultValue()">getDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptions()">getOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptionsDisplayValues()">getOptionsDisplayValues</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptionsExportValues()">getOptionsExportValues</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getSelectedOptionsIndex()">getSelectedOptionsIndex</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getValue()">getValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCombo()">isCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCommitOnSelChange()">isCommitOn
SelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isDoNotSpellCheck()">isDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isMultiSelect()">isMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isSort()">isSort</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setCombo(boolean)">setCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setCommitOnSelChange(boolean)">setCommitOnSelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setDefaultValue(java.lang.String)">setDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setDoNotSpellCheck(boolean)">setDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setMultiS
elect(boolean)">setMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List, java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSelectedOptionsIndex(java.util.List)">setSelectedOptionsIndex</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSort(boolean)">setSort</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.util.List)">setValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.interactive.form.PDVariableText">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDVariableText</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultAppearance()">getDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultStyleString()">getDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getQ()">getQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValue()">getRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultStyleString(java.lang.String)">setDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setQ(int)">setQ</a>, <a href="../../../../../../org/apache/pdfbox
/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(java.lang.String)">setRichTextValue</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultAppearance()">getDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultStyleString()">getDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getQ()">getQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValue()">getRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValueAsStream()">getRichTextValueAsStream</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultStyleString(java.lang.String)">setDefaultStyleString</a>, <a href
="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setQ(int)">setQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(org.apache.pdfbox.pdmodel.common.PDTextStream)">setRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(java.lang.String)">setRichTextValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.interactive.form.PDField">
@@ -274,6 +259,16 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="PDComboBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PDComboBox</h4>
+<pre>public PDComboBox(<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="PDComboBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">
<!-- -->
</a>
@@ -317,76 +312,20 @@ extends <a href="../../../../../../org/a
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>edit</code> - The value for Edit.</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getDefaultValue()</pre>
-<div class="block">Get the fields default value.
-
- The value is stored in the field dictionaries "DV" entry.</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 entry.</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"><strong>Description copied from class: <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html#setDefaultValue(java.lang.String)">PDFieldTreeNode</a></code></strong></div>
-<div class="block">Set the value of the "DV" entry. The "DV" entry is an inheritable attribute.
-
- 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. This needs to be handled by the
- individual classes.
-
- Trying to set the default value for a <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.html" title="class in org.apache.pdfbox.pdmodel.interactive.form"><code>PDPushButton</code></a> field will lead to an
- <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> as PDPushButton fields do not support setting the
- entry although, common to all field types, the DV entry shall not be set.
-
- As a result it might be necessary to check the type of the value before
- reusing it.</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 default field value.</dd></dl>
-</li>
-</ul>
<a name="setValue(java.lang.String)">
<!-- -->
</a>
-<ul class="blockList">
+<ul class="blockListLast">
<li class="blockList">
<h4>setValue</h4>
<pre>public void setValue(<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)</pre>
-<div class="block">setValue sets the entry "V" to the given value.</div>
+<div class="block">Sets the field value - the 'V' key.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.lang.String)">setValue</a></code> in class <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDChoice</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value</dd></dl>
</li>
</ul>
-<a name="setValue(java.util.List)">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>setValue</h4>
-<pre>public void setValue(<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">setValue sets the entry "V" to the given value.</div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.util.List)">setValue</a></code> in class <code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDChoice</a></code></dd>
-<dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - the value</dd></dl>
-</li>
-</ul>
</li>
</ul>
</li>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDField.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDField.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDField.html Mon Mar 30 05:53:07 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>PDField (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>
@@ -314,11 +314,14 @@ extends <a href="../../../../../../org/a
<ul class="blockListLast">
<li class="blockList">
<h4>updateFieldAppearances</h4>
-<pre>protected void updateFieldAppearances()</pre>
+<pre>protected void updateFieldAppearances()
+ 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">Update the fields appearance stream.
The fields appearance stream needs to be updated to reflect the new field
value. This will be done only if the NeedAppearances flag has not been set.</div>
+<dl><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 the appearance couldn't be generated</dd></dl>
</li>
</ul>
</li>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDFieldTreeNode.html Mon Mar 30 05:53:07 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>PDFieldTreeNode (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>
@@ -109,8 +109,6 @@
extends <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">Object</a>
implements <a href="../../../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></pre>
<div class="block">A field in an interactive form.</div>
-<dl><dt><span class="strong">Author:</span></dt>
- <dd>Andreas Lehmkühler</dd></dl>
</li>
</ul>
</div>
@@ -601,7 +599,8 @@ implements <a href="../../../../../../or
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
-<pre>public abstract void setValue(<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> fieldValue)</pre>
+<pre>public abstract void setValue(<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> fieldValue)
+ 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">Set the value of the "V" entry. The "V" entry is an inheritable attribute.
The different field types do require specific object types for their value
@@ -614,7 +613,9 @@ implements <a href="../../../../../../or
As a result it might be necessary to check the type of the value before
reusing it.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldValue</code> - The new field value.</dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldValue</code> - The new field value.</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 setting the field value.</dd></dl>
</li>
</ul>
<a name="setReadonly(boolean)">
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDListBox.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDListBox.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDListBox.html Mon Mar 30 05:53:07 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>PDListBox (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>
@@ -166,6 +166,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/PDListBox.html#PDListBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">PDListBox</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/PDListBox.html#PDListBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">PDListBox</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>
@@ -188,23 +191,11 @@ 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/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDListBox.html#getDefaultValue()">getDefaultValue</a></strong>()</code>
-<div class="block">Get the fields default value.</div>
-</td>
-</tr>
-<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDListBox.html#getTopIndex()">getTopIndex</a></strong>()</code>
<div class="block">This will get the top index "TI" value.</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/PDListBox.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 value of the "DV" entry.</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/PDListBox.html#setTopIndex(java.lang.Integer)">setTopIndex</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> topIndex)</code>
@@ -217,14 +208,14 @@ 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/PDChoice.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDChoice</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptions()">getOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getSelectedOptions()">getSelectedOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getValue()">getValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCombo()">isCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCommitOnSelChange()">isCommitOnSelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isDoNotSpellCheck()">isDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isMultiSelect()">isMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isSort()">isSort</a>, <a href="../../../../../../org/apache/pdfbo
x/pdmodel/interactive/form/PDChoice.html#setCombo(boolean)">setCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setCommitOnSelChange(boolean)">setCommitOnSelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setDoNotSpellCheck(boolean)">setDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setMultiSelect(boolean)">setMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSelectedOptions(org.apache.pdfbox.cos.COSArray)">setSelectedOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSort(boolean)">setSort</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.util.List)">set
Value</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.lang.String)">setValue</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getDefaultValue()">getDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptions()">getOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptionsDisplayValues()">getOptionsDisplayValues</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getOptionsExportValues()">getOptionsExportValues</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getSelectedOptionsIndex()">getSelectedOptionsIndex</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#getValue()">getValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCombo()">isCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isCommitOnSelChange()">isCommitOn
SelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isDoNotSpellCheck()">isDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isMultiSelect()">isMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#isSort()">isSort</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setCombo(boolean)">setCombo</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setCommitOnSelChange(boolean)">setCommitOnSelChange</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setDefaultValue(java.lang.String)">setDefaultValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setDoNotSpellCheck(boolean)">setDoNotSpellCheck</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setMultiS
elect(boolean)">setMultiSelect</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setOptions(java.util.List, java.util.List)">setOptions</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSelectedOptionsIndex(java.util.List)">setSelectedOptionsIndex</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setSort(boolean)">setSort</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.util.List)">setValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDChoice.html#setValue(java.lang.String)">setValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.interactive.form.PDVariableText">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.<a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html" title="class in org.apache.pdfbox.pdmodel.interactive.form">PDVariableText</a></h3>
-<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultAppearance()">getDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultStyleString()">getDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getQ()">getQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValue()">getRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultStyleString(java.lang.String)">setDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setQ(int)">setQ</a>, <a href="../../../../../../org/apache/pdfbox
/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(java.lang.String)">setRichTextValue</a></code></li>
+<code><a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultAppearance()">getDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getDefaultStyleString()">getDefaultStyleString</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getQ()">getQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValue()">getRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#getRichTextValueAsStream()">getRichTextValueAsStream</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultAppearance(java.lang.String)">setDefaultAppearance</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setDefaultStyleString(java.lang.String)">setDefaultStyleString</a>, <a href
="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setQ(int)">setQ</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(org.apache.pdfbox.pdmodel.common.PDTextStream)">setRichTextValue</a>, <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html#setRichTextValue(java.lang.String)">setRichTextValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.interactive.form.PDField">
@@ -261,6 +252,16 @@ extends <a href="../../../../../../org/a
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="PDListBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PDListBox</h4>
+<pre>public PDListBox(<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="PDListBox(org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode)">
<!-- -->
</a>
@@ -296,7 +297,7 @@ extends <a href="../../../../../../org/a
<a name="setTopIndex(java.lang.Integer)">
<!-- -->
</a>
-<ul class="blockList">
+<ul class="blockListLast">
<li class="blockList">
<h4>setTopIndex</h4>
<pre>public void setTopIndex(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> topIndex)</pre>
@@ -304,47 +305,6 @@ extends <a href="../../../../../../org/a
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topIndex</code> - the value for the top index, null will remove the value.</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getDefaultValue()</pre>
-<div class="block">Get the fields default value.
-
- The value is stored in the field dictionaries "DV" entry.</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 entry.</dd></dl>
-</li>
-</ul>
-<a name="setDefaultValue(java.lang.String)">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<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 value of the "DV" entry. The "DV" entry is an inheritable attribute.
-
- 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. This needs to be handled by the
- individual classes.
-
- Trying to set the default value for a <a href="../../../../../../org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.html" title="class in org.apache.pdfbox.pdmodel.interactive.form"><code>PDPushButton</code></a> field will lead to an
- <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> as PDPushButton fields do not support setting the
- entry although, common to all field types, the DV entry shall not be set.
-
- As a result it might be necessary to check the type of the value before
- reusing it.</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 default field value.</dd></dl>
-</li>
-</ul>
</li>
</ul>
</li>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.html Mon Mar 30 05:53:07 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:00 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PDNonTerminalField (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>
@@ -116,8 +116,6 @@ extends <a href="../../../../../../org/a
The attributes such as FT (field type) or V (field value) do not logically
belong to the non terminal field but are inheritable attributes
for descendant terminal fields.</div>
-<dl><dt><span class="strong">Author:</span></dt>
- <dd>Andreas Lehmkühler</dd></dl>
</li>
</ul>
</div>