blob: 2842996df56c6d0d48081086385af7d747ae4ca6 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Sat Mar 26 09:48:40 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (Apache PDFBox 1.8.11 API)</title>
<meta name="date" content="2016-03-26">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (Apache PDFBox 1.8.11 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Apache PDFBox 1.8.11 API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/package-summary.html">org.apache.pdfbox</a></td>
<td class="colLast">
<div class="block">This package holds executable classes that interact with the PDFBox application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/cos/package-summary.html">org.apache.pdfbox.cos</a></td>
<td class="colLast">
<div class="block">These are the low level objects that make up a PDF document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/encoding/package-summary.html">org.apache.pdfbox.encoding</a></td>
<td class="colLast">
<div class="block">This package contains the implementations for all of the encodings that are used in PDF documents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/encoding/conversion/package-summary.html">org.apache.pdfbox.encoding.conversion</a></td>
<td class="colLast">
<div class="block">This package contains the implementations for conversions of encodings and CMaps that are used in PDF documents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/encryption/package-summary.html">org.apache.pdfbox.encryption</a></td>
<td class="colLast">
<div class="block">These classes deal with encryption algorithms that are used in the PDF Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/exceptions/package-summary.html">org.apache.pdfbox.exceptions</a></td>
<td class="colLast">
<div class="block">This package is a place holder for exceptions that are used in the PDFBox project.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/filter/package-summary.html">org.apache.pdfbox.filter</a></td>
<td class="colLast">
<div class="block">This package will hold the PDFBox implementations of the filters that are used in PDF documents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/io/package-summary.html">org.apache.pdfbox.io</a></td>
<td class="colLast">
<div class="block">This package contains IO streams.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/io/ccitt/package-summary.html">org.apache.pdfbox.io.ccitt</a></td>
<td class="colLast">
<div class="block">This package contains CCITT encoders and decoders.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdfparser/package-summary.html">org.apache.pdfbox.pdfparser</a></td>
<td class="colLast">
<div class="block">The pdfparser package contains classes to parse PDF documents and objects within the document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdfviewer/package-summary.html">org.apache.pdfbox.pdfviewer</a></td>
<td class="colLast">
<div class="block">The pdfviewer package contains classes to graphically display information about a PDF document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdfwriter/package-summary.html">org.apache.pdfbox.pdfwriter</a></td>
<td class="colLast">
<div class="block">This is the persistence layer used to write the PDFBox documents to a stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/package-summary.html">org.apache.pdfbox.pdmodel</a></td>
<td class="colLast">
<div class="block">The PDModel package represents a high level API for creating and manipulating PDF documents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/common/package-summary.html">org.apache.pdfbox.pdmodel.common</a></td>
<td class="colLast">
<div class="block">High level PD classes that are used throughout several packages are placed in the PDModel common package.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/common/filespecification/package-summary.html">org.apache.pdfbox.pdmodel.common.filespecification</a></td>
<td class="colLast">
<div class="block">The file specification package defines classes that are used for the PDF File Specification logic.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/common/function/package-summary.html">org.apache.pdfbox.pdmodel.common.function</a></td>
<td class="colLast">
<div class="block">This package contains functions that are available in the PDF specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/common/function/type4/package-summary.html">org.apache.pdfbox.pdmodel.common.function.type4</a></td>
<td class="colLast">
<div class="block">This package contains Type 4 function support.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/package-summary.html">org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure</a></td>
<td class="colLast">
<div class="block">The logical structure package provides a mechanism for incorporating
structural information about a document's content into a PDF file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/documentinterchange/markedcontent/package-summary.html">org.apache.pdfbox.pdmodel.documentinterchange.markedcontent</a></td>
<td class="colLast">
<div class="block">The marked content package provides a mechanism for modeling marked-content
sequences.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/documentinterchange/prepress/package-summary.html">org.apache.pdfbox.pdmodel.documentinterchange.prepress</a></td>
<td class="colLast">
<div class="block">This package contains classes for prepress support in PDFBox.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/package-summary.html">org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf</a></td>
<td class="colLast">
<div class="block">The tagged PDF package provides a mechanism for incorporating "tags" (standard
structure types and attributes) into a PDF file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/edit/package-summary.html">org.apache.pdfbox.pdmodel.edit</a></td>
<td class="colLast">
<div class="block">The PDModel edit package will be used to store classes for creating page content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/encryption/package-summary.html">org.apache.pdfbox.pdmodel.encryption</a></td>
<td class="colLast">
<div class="block">The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/fdf/package-summary.html">org.apache.pdfbox.pdmodel.fdf</a></td>
<td class="colLast">
<div class="block">The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/font/package-summary.html">org.apache.pdfbox.pdmodel.font</a></td>
<td class="colLast">
<div class="block">Classes to deal with font functionality in a PDF Document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/package-summary.html">org.apache.pdfbox.pdmodel.graphics</a></td>
<td class="colLast">
<div class="block">The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/color/package-summary.html">org.apache.pdfbox.pdmodel.graphics.color</a></td>
<td class="colLast">
<div class="block">This package deals with colors that are stored in a PDF document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/optionalcontent/package-summary.html">org.apache.pdfbox.pdmodel.graphics.optionalcontent</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/pattern/package-summary.html">org.apache.pdfbox.pdmodel.graphics.pattern</a></td>
<td class="colLast">
<div class="block">This package deals with patterns which are used instead of colors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/predictor/package-summary.html">org.apache.pdfbox.pdmodel.graphics.predictor</a></td>
<td class="colLast">
<div class="block">The predictor package contains code for different PNG predictor algorithms that
are present in PDF documents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/shading/package-summary.html">org.apache.pdfbox.pdmodel.graphics.shading</a></td>
<td class="colLast">
<div class="block">This package deals with shadings which are used for filling instead of a color.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/graphics/xobject/package-summary.html">org.apache.pdfbox.pdmodel.graphics.xobject</a></td>
<td class="colLast">
<div class="block">This package deals with images that are stored in a PDF document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/action/package-summary.html">org.apache.pdfbox.pdmodel.interactive.action</a></td>
<td class="colLast">
<div class="block">This package represents actions that can be performed in a PDF document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/action/type/package-summary.html">org.apache.pdfbox.pdmodel.interactive.action.type</a></td>
<td class="colLast">
<div class="block">This package contains all of the available PDF action types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/annotation/package-summary.html">org.apache.pdfbox.pdmodel.interactive.annotation</a></td>
<td class="colLast">
<div class="block">The annotation package contains classes that work with PDF annotation elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/digitalsignature/package-summary.html">org.apache.pdfbox.pdmodel.interactive.digitalsignature</a></td>
<td class="colLast">
<div class="block">The digitial signature library will manage signatures that are stored in the PDF document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/package-summary.html">org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible</a></td>
<td class="colLast">
<div class="block">This is the visual signature part that help creating the visual representation for the digital signature.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/package-summary.html">org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination</a></td>
<td class="colLast">
<div class="block">The destination package allows destinations into a pdf document to be specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/package-summary.html">org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline</a></td>
<td class="colLast">
<div class="block">The outline package allows for a PDF outline(bookmarks) to be created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/form/package-summary.html">org.apache.pdfbox.pdmodel.interactive.form</a></td>
<td class="colLast">
<div class="block">The interactive package contains classes that deal with interactive annotations such as textfields and buttons.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/measurement/package-summary.html">org.apache.pdfbox.pdmodel.interactive.measurement</a></td>
<td class="colLast">
<div class="block">The measurement package contains classes that work with elements specifying measure properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/pagenavigation/package-summary.html">org.apache.pdfbox.pdmodel.interactive.pagenavigation</a></td>
<td class="colLast">
<div class="block">A package to allow provide access to PDF page navigation functionality.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/interactive/viewerpreferences/package-summary.html">org.apache.pdfbox.pdmodel.interactive.viewerpreferences</a></td>
<td class="colLast">
<div class="block">A package to allow access to document viewing preferences.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/markedcontent/package-summary.html">org.apache.pdfbox.pdmodel.markedcontent</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/pdmodel/text/package-summary.html">org.apache.pdfbox.pdmodel.text</a></td>
<td class="colLast">
<div class="block">The PDModel text package deals with text states, operations, and parameters within the PDF document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/persistence/util/package-summary.html">org.apache.pdfbox.persistence.util</a></td>
<td class="colLast">
<div class="block">These are utilities used by the persistence layer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/util/package-summary.html">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>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/pdfbox/util/operator/package-summary.html">org.apache.pdfbox.util.operator</a></td>
<td class="colLast">
<div class="block">This package contains implementations of all of the PDF operators.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/pdfbox/util/operator/pagedrawer/package-summary.html">org.apache.pdfbox.util.operator.pagedrawer</a></td>
<td class="colLast">
<div class="block">This package contains implementations of all of the PDF operators.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2002-2016 <a href="http://pdfbox.apache.org">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>