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 [40/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/documentnavigation/outline/PDOutlineNode.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.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>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>
@@ -63,13 +63,13 @@
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field_detail">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
@@ -88,10 +88,15 @@
<li><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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
+<li><a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html" title="class in org.apache.pdfbox.pdmodel.common">org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper</a></li>
+<li>
+<ul class="inheritance">
<li>org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode</li>
</ul>
</li>
</ul>
+</li>
+</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
@@ -105,41 +110,17 @@
</dl>
<hr>
<br>
-<pre>public class <span class="strong">PDOutlineNode</span>
-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">This represents an node in an outline in a pdf document.</div>
-<dl><dt><span class="strong">Version:</span></dt>
- <dd>$Revision: 1.3 $</dd>
-<dt><span class="strong">Author:</span></dt>
- <dd><a href="mailto:ben@benlitchfield.com">Ben Litchfield</a></dd></dl>
+<pre>public abstract class <span class="strong">PDOutlineNode</span>
+extends <a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html" title="class in org.apache.pdfbox.pdmodel.common">PDDictionaryWrapper</a></pre>
+<div class="block">Base class for a node in the outline of a PDF document.</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Ben Litchfield</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
-<!-- =========== FIELD SUMMARY =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="field_summary">
-<!-- -->
-</a>
-<h3>Field Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
-<caption><span>Fields</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Field and Description</th>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#node">node</a></strong></code>
-<div class="block">The dictionary for this node.</div>
-</td>
-</tr>
-</table>
-</li>
-</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
@@ -157,9 +138,7 @@ implements <a href="../../../../../../..
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#PDOutlineNode(org.apache.pdfbox.cos.COSDictionary)">PDOutlineNode</a></strong>(<a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dict)</code>
-<div class="block">Default Constructor.</div>
-</td>
+<td class="colOne"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#PDOutlineNode(org.apache.pdfbox.cos.COSDictionary)">PDOutlineNode</a></strong>(<a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dict)</code> </td>
</tr>
</table>
</li>
@@ -178,57 +157,47 @@ implements <a href="../../../../../../..
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#appendChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">appendChild</a></strong>(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> outlineNode)</code>
-<div class="block">append a child node to this node.</div>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#addFirst(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">addFirst</a></strong>(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newChild)</code>
+<div class="block">Adds the given node to the top of the children list.</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/documentnavigation/outline/PDOutlineNode.html#closeNode()">closeNode</a></strong>()</code>
-<div class="block">Close this node.</div>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#addLast(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">addLast</a></strong>(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newChild)</code>
+<div class="block">Adds the given node to the bottom of the children list.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code><a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getCOSDictionary()">getCOSDictionary</a></strong>()</code>
-<div class="block">Convert this standard java object to a COS object.</div>
-</td>
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#children()">children</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getCOSObject()">getCOSObject</a></strong>()</code>
-<div class="block">Convert this standard java object to a COS object.</div>
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#closeNode()">closeNode</a></strong>()</code>
+<div class="block">Close this node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getFirstChild()">getFirstChild</a></strong>()</code>
-<div class="block">Return the first child or null if there is no child.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getFirstChild()">getFirstChild</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getLastChild()">getLastChild</a></strong>()</code>
-<div class="block">Return the last child or null if there is no child.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getLastChild()">getLastChild</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getOpenCount()">getOpenCount</a></strong>()</code>
-<div class="block">Get the number of open nodes.</div>
+<div class="block">Get the number of open nodes or a negative number if this node is closed.</div>
</td>
</tr>
<tr class="rowColor">
-<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"><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>
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#hasChildren()">hasChildren</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#isNodeOpen()">isNodeOpen</a></strong>()</code>
-<div class="block">Node is open if the open count is greater than zero.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#isNodeOpen()">isNodeOpen</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
@@ -236,45 +205,20 @@ implements <a href="../../../../../../..
<div class="block">This will set this node to be open when it is shown in the viewer.</div>
</td>
</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><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"><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"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#setOpenCount(int)">setOpenCount</a></strong>(int openCount)</code>
-<div class="block">Set the open count.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><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"><code><strong><a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#updateParentOpenCount(int)">updateParentOpenCount</a></strong>(int amount)</code>
-<div class="block">The count parameter needs to be updated when you add or remove elements to
- the outline.</div>
-</td>
-</tr>
</table>
<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.pdfbox.pdmodel.common.<a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html" title="class in org.apache.pdfbox.pdmodel.common">PDDictionaryWrapper</a></h3>
+<code><a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html#getCOSDictionary()">getCOSDictionary</a>, <a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html#getCOSObject()">getCOSObject</a>, <a href="../../../../../../../org/apache/pdfbox/pdmodel/common/PDDictionaryWrapper.html#hashCode()">hashCode</a></code></li>
+</ul>
+<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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">Object</a></h3>
-<code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="ht
tp://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
+<code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://downl
oad.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -284,24 +228,6 @@ implements <a href="../../../../../../..
<div class="details">
<ul class="blockList">
<li class="blockList">
-<!-- ============ FIELD DETAIL =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="field_detail">
-<!-- -->
-</a>
-<h3>Field Detail</h3>
-<a name="node">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>node</h4>
-<pre>protected <a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> node</pre>
-<div class="block">The dictionary for this node.</div>
-</li>
-</ul>
-</li>
-</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
@@ -325,7 +251,6 @@ implements <a href="../../../../../../..
<li class="blockList">
<h4>PDOutlineNode</h4>
<pre>public PDOutlineNode(<a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dict)</pre>
-<div class="block">Default Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dict</code> - The dictionary storage.</dd></dl>
</li>
</ul>
@@ -337,64 +262,42 @@ implements <a href="../../../../../../..
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="getCOSObject()">
+<a name="addLast(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getCOSObject</h4>
-<pre>public <a href="../../../../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getCOSObject()</pre>
-<div class="block">Convert this standard java object to a COS object.</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html#getCOSObject()">getCOSObject</a></code> in interface <code><a href="../../../../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>The cos object that matches this Java object.</dd></dl>
+<h4>addLast</h4>
+<pre>public void addLast(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newChild)</pre>
+<div class="block">Adds the given node to the bottom of the children list.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newChild</code> - The node to add.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><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">IllegalArgumentException</a></code> - if the given node is part of a list (i.e. if it has a previous or a next
+ sibling)</dd></dl>
</li>
</ul>
-<a name="getCOSDictionary()">
+<a name="addFirst(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getCOSDictionary</h4>
-<pre>public <a href="../../../../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> getCOSDictionary()</pre>
-<div class="block">Convert this standard java object to a COS object.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The cos object that matches this Java object.</dd></dl>
+<h4>addFirst</h4>
+<pre>public void addFirst(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newChild)</pre>
+<div class="block">Adds the given node to the top of the children list.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newChild</code> - The node to add.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><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">IllegalArgumentException</a></code> - if the given node is part of a list (i.e. if it has a previous or a next
+ sibling)</dd></dl>
</li>
</ul>
-<a name="getParent()">
+<a name="hasChildren()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getParent</h4>
-<pre>protected <a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> getParent()</pre>
-<div class="block">Get the parent of this object. This will either be a DocumentOutline or an OutlineItem.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The parent of this object, or null if this is the document outline and there
- is no parent.</dd></dl>
-</li>
-</ul>
-<a name="setParent(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setParent</h4>
-<pre>protected void setParent(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> parent)</pre>
-<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>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - The parent of this object.</dd></dl>
-</li>
-</ul>
-<a name="appendChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>appendChild</h4>
-<pre>public void appendChild(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> outlineNode)</pre>
-<div class="block">append a child node to this node.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outlineNode</code> - The node to add.</dd></dl>
+<h4>hasChildren</h4>
+<pre>public boolean hasChildren()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the node has at least one child</dd></dl>
</li>
</ul>
<a name="getFirstChild()">
@@ -404,19 +307,7 @@ implements <a href="../../../../../../..
<li class="blockList">
<h4>getFirstChild</h4>
<pre>public <a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> getFirstChild()</pre>
-<div class="block">Return the first child or null if there is no child.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The first child.</dd></dl>
-</li>
-</ul>
-<a name="setFirstChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setFirstChild</h4>
-<pre>protected void setFirstChild(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> outlineNode)</pre>
-<div class="block">Set the first child, this will be maintained by this class.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outlineNode</code> - The new first child.</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The first child or null if there is no child.</dd></dl>
</li>
</ul>
<a name="getLastChild()">
@@ -426,19 +317,7 @@ implements <a href="../../../../../../..
<li class="blockList">
<h4>getLastChild</h4>
<pre>public <a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> getLastChild()</pre>
-<div class="block">Return the last child or null if there is no child.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The last child.</dd></dl>
-</li>
-</ul>
-<a name="setLastChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setLastChild</h4>
-<pre>protected void setLastChild(<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineNode</a> outlineNode)</pre>
-<div class="block">Set the last child, this will be maintained by this class.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outlineNode</code> - The new last child.</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The last child or null if there is no child.</dd></dl>
</li>
</ul>
<a name="getOpenCount()">
@@ -448,24 +327,12 @@ implements <a href="../../../../../../..
<li class="blockList">
<h4>getOpenCount</h4>
<pre>public int getOpenCount()</pre>
-<div class="block">Get the number of open nodes. Or a negative number if this node
- is closed. See PDF Reference for more details. This value
- is updated as you append children and siblings.</div>
+<div class="block">Get the number of open nodes or a negative number if this node is closed.
+ See PDF Reference 32000-1:2008 table 152 and 153 for more details. This
+ value is updated as you append children and siblings.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The Count attribute of the outline dictionary.</dd></dl>
</li>
</ul>
-<a name="setOpenCount(int)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setOpenCount</h4>
-<pre>protected void setOpenCount(int openCount)</pre>
-<div class="block">Set the open count. This number is automatically managed for you
- when you add items to the outline.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>openCount</code> - The new open cound.</dd></dl>
-</li>
-</ul>
<a name="openNode()">
<!-- -->
</a>
@@ -473,9 +340,8 @@ implements <a href="../../../../../../..
<li class="blockList">
<h4>openNode</h4>
<pre>public void openNode()</pre>
-<div class="block">This will set this node to be open when it is shown in the viewer. By default, when
- a new node is created it will be closed.
- This will do nothing if the node is already open.</div>
+<div class="block">This will set this node to be open when it is shown in the viewer. By default, when a new node is created it will
+ be closed. This will do nothing if the node is already open.</div>
</li>
</ul>
<a name="closeNode()">
@@ -495,21 +361,17 @@ implements <a href="../../../../../../..
<li class="blockList">
<h4>isNodeOpen</h4>
<pre>public boolean isNodeOpen()</pre>
-<div class="block">Node is open if the open count is greater than zero.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true if this node is open.</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if this node count is greater than zero, false otherwise.</dd></dl>
</li>
</ul>
-<a name="updateParentOpenCount(int)">
+<a name="children()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
-<h4>updateParentOpenCount</h4>
-<pre>protected void updateParentOpenCount(int amount)</pre>
-<div class="block">The count parameter needs to be updated when you add or remove elements to
- the outline. When you add an element at a lower level then you need to
- increase all of the parents.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - The amount to update by.</dd></dl>
+<h4>children</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a>> children()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>An <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> view of the items children</dd></dl>
</li>
</ul>
</li>
@@ -564,13 +426,13 @@ implements <a href="../../../../../../..
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field_detail">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDDocumentOutline.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDDocumentOutline.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDDocumentOutline.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: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.PDDocumentOutline (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: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.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: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.PDOutlineItem (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>
@@ -83,10 +83,8 @@
</td>
</tr>
<tr class="rowColor">
-<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>
@@ -106,21 +104,15 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getFirstChild()">getFirstChild</a></strong>()</code>
-<div class="block">Return the first child or null if there is no child.</div>
-</td>
+<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getFirstChild()">getFirstChild</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getLastChild()">getLastChild</a></strong>()</code>
-<div class="block">Return the last child or null if there is no child.</div>
-</td>
+<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#getLastChild()">getLastChild</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#getNextSibling()">getNextSibling</a></strong>()</code>
-<div class="block">Return the next sibling or null if there is no next sibling.</div>
-</td>
+<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#getNextSibling()">getNextSibling</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
@@ -131,6 +123,19 @@
</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 types with arguments of type <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</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><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a>></code></td>
+<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#children()">children</a></strong>()</code> </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/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -139,25 +144,37 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#appendChild(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">appendChild</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> outlineNode)</code>
-<div class="block">append a child node to this node.</div>
+<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#addFirst(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">addFirst</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newChild)</code>
+<div class="block">Adds the given node to the top of the children list.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><span class="strong">PDOutlineNode.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineNode.html#addLast(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">addLast</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newChild)</code>
+<div class="block">Adds the given node to the bottom of the children list.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#insertSiblingAfter(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">insertSiblingAfter</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newSibling)</code>
+<div class="block">Insert a single sibling after this node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#insertSiblingAfter(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">insertSiblingAfter</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> item)</code>
-<div class="block">Insert a sibling after this node.</div>
+<td class="colLast"><span class="strong">PDOutlineItem.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html#insertSiblingBefore(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">insertSiblingBefore</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> newSibling)</code>
+<div class="block">Insert a single sibling before this node.</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>
-<h3>Uses of <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> in <a href="../../../../../../../../org/apache/pdfbox/util/package-summary.html">org.apache.pdfbox.util</a></h3>
+<h3>Uses of <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> in <a href="../../../../../../../../org/apache/pdfbox/text/package-summary.html">org.apache.pdfbox.text</a></h3>
<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
-<caption><span>Methods in <a href="../../../../../../../../org/apache/pdfbox/util/package-summary.html">org.apache.pdfbox.util</a> that return <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></span><span class="tabEnd"> </span></caption>
+<caption><span>Methods in <a href="../../../../../../../../org/apache/pdfbox/text/package-summary.html">org.apache.pdfbox.text</a> that return <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</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>
@@ -165,20 +182,20 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/util/PDFTextStripper.html#getEndBookmark()">getEndBookmark</a></strong>()</code>
+<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/text/PDFTextStripper.html#getEndBookmark()">getEndBookmark</a></strong>()</code>
<div class="block">Get the bookmark where text extraction should end, inclusive.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></code></td>
-<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/util/PDFTextStripper.html#getStartBookmark()">getStartBookmark</a></strong>()</code>
+<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/text/PDFTextStripper.html#getStartBookmark()">getStartBookmark</a></strong>()</code>
<div class="block">Get the bookmark where text extraction should start, inclusive.</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/util/package-summary.html">org.apache.pdfbox.util</a> with parameters of type <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a></span><span class="tabEnd"> </span></caption>
+<caption><span>Methods in <a href="../../../../../../../../org/apache/pdfbox/text/package-summary.html">org.apache.pdfbox.text</a> with parameters of type <a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</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>
@@ -186,13 +203,13 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/util/PDFTextStripper.html#setEndBookmark(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">setEndBookmark</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> aEndBookmark)</code>
+<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/text/PDFTextStripper.html#setEndBookmark(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">setEndBookmark</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> aEndBookmark)</code>
<div class="block">Set the bookmark where the text extraction should stop.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/util/PDFTextStripper.html#setStartBookmark(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">setStartBookmark</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> aStartBookmark)</code>
+<td class="colLast"><span class="strong">PDFTextStripper.</span><code><strong><a href="../../../../../../../../org/apache/pdfbox/text/PDFTextStripper.html#setStartBookmark(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem)">setStartBookmark</a></strong>(<a href="../../../../../../../../org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html" title="class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline">PDOutlineItem</a> aStartBookmark)</code>
<div class="block">Set the bookmark where text extraction should start, inclusive.</div>
</td>
</tr>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineNode.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: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: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-frame.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: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: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.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: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: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-tree.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: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: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-use.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: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: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDAcroForm.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>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">