You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ju...@apache.org on 2010/03/18 16:46:10 UTC
svn commit: r924869 [9/13] - in /pdfbox/site: ./ publish/
publish/commandlineutilities/ publish/css/ publish/userguide/
publish/userguide/cookbook/ src/site/fml/userguide/ src/site/xdoc/
src/site/xdoc/commandlineutilities/ src/site/xdoc/userguide/ src/...
Modified: pdfbox/site/publish/userguide/cookbook.html
URL: http://svn.apache.org/viewvc/pdfbox/site/publish/userguide/cookbook.html?rev=924869&r1=924868&r2=924869&view=diff
==============================================================================
--- pdfbox/site/publish/userguide/cookbook.html (original)
+++ pdfbox/site/publish/userguide/cookbook.html Thu Mar 18 15:46:08 2010
@@ -1,267 +1,187 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
-<html xmlns="http://www.w3.org/1999/xhtml">
+<!-- Generated by Apache Maven Doxia at Mar 18, 2010 -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <title>Apache PDFBox - PDFBox - Cookbook</title>
+ <title>Apache PDFBox -
+ PDFBox - Cookbook</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- </head>
+ <meta name="Date-Revision-yyyymmdd" content="20100318" />
+ <meta http-equiv="Content-Language" content="en" />
+
+ </head>
<body class="composite">
<div id="banner">
- <a href="" id="bannerLeft">
-
- <img src="../images/Logo.gif" alt="Apache PDFBox" />
-
- </a>
- <a href="http://www.apache.org/" id="bannerRight">
-
- <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
-
- </a>
+ <a href="" id="bannerLeft" title="Apache PDFBox">
+ <img src="../images/Logo.gif" alt="Apache PDFBox" />
+ </a>
+ <a href="http://www.apache.org/" id="bannerRight" title="The Apache Software Foundation">
+ <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
+ </a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xright">
-
-
-
-
-
-
-
- </div>
+
+ <div class="xright">
+
+ </div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>About</h5>
- <ul>
-
- <li class="none">
- <a href="../index.html">Welcome</a>
- </li>
-
- <li class="none">
- <a href="../download.html">Download</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink">License</a>
- </li>
-
- <li class="none">
- <a href="../mailing-list.html">Mailing Lists</a>
- </li>
-
- <li class="none">
- <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink">Issue Tracker</a>
- </li>
-
- <li class="none">
- <a href="../references.html">References</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">ASF Sponsorship Program</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">ASF Thanks</a>
- </li>
+
+
+ <h5>About</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html" title="Welcome">Welcome</a>
+ </li>
+ <li class="none">
+ <a href="../download.html" title="Download">Download</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink" title="License">License</a>
+ </li>
+ <li class="none">
+ <a href="../mailing-list.html" title="Mailing Lists">Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink" title="Issue Tracker">Issue Tracker</a>
+ </li>
+ <li class="none">
+ <a href="../references.html" title="References">References</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="ASF Sponsorship Program">ASF Sponsorship Program</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="ASF Thanks">ASF Thanks</a>
+ </li>
</ul>
- <h5>Command Line Utilities</h5>
- <ul>
-
- <li class="none">
- <a href="../commandlineutilities/index.html">Index</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/ConvertColorspace.html">ConvertColorspace</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/Decrypt.html">Decrypt</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/Encrypt.html">Encrypt</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/ExtractText.html">ExtractText</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/Overlay.html">Overlay</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PrintPDF.html">PrintPDF</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFDebugger.html">PDFDebugger</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFMerger.html">PDFMerger</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFReader.html">PDFReader</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFSplit.html">PDFSplit</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFToImage.html">PDFToImage</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/TextToPDF.html">TextToPDF</a>
- </li>
+ <h5>Command Line Utilities</h5>
+ <ul>
+ <li class="none">
+ <a href="../commandlineutilities/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/ConvertColorspace.html" title="ConvertColorspace">ConvertColorspace</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/Decrypt.html" title="Decrypt">Decrypt</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/Encrypt.html" title="Encrypt">Encrypt</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/ExtractText.html" title="ExtractText">ExtractText</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/Overlay.html" title="Overlay">Overlay</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PrintPDF.html" title="PrintPDF">PrintPDF</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFDebugger.html" title="PDFDebugger">PDFDebugger</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFMerger.html" title="PDFMerger">PDFMerger</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFReader.html" title="PDFReader">PDFReader</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFSplit.html" title="PDFSplit">PDFSplit</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFToImage.html" title="PDFToImage">PDFToImage</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/TextToPDF.html" title="TextToPDF">TextToPDF</a>
+ </li>
</ul>
- <h5>Developers Guide</h5>
- <ul>
-
- <li class="none">
- <a href="../userguide/index.html">Index</a>
- </li>
-
- <li class="none">
- <a href="../userguide/bookmarks.html">Bookmarks</a>
- </li>
-
- <li class="none">
- <a href="../userguide/building_pdfbox.html">Building PDFBox</a>
- </li>
-
- <li class="none">
- <a href="../userguide/tutorials.html">Tutorials</a>
- </li>
-
- <li class="none">
- <strong>Cookbook</strong>
- </li>
-
- <li class="none">
- <a href="../userguide/faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="../userguide/file_references.html">File References</a>
- </li>
-
- <li class="none">
- <a href="../userguide/fonts.html">Fonts</a>
- </li>
-
- <li class="none">
- <a href="../userguide/highlighting.html">Highlighting</a>
- </li>
-
- <li class="none">
- <a href="../userguide/metadata.html">Metadata</a>
- </li>
-
- <li class="none">
- <a href="../userguide/redistribution.html">Redistribution</a>
- </li>
-
- <li class="none">
- <a href="../userguide/dot_net.html">.NET Version</a>
- </li>
-
- <li class="none">
- <a href="../userguide/text_extraction.html">Text Extraction</a>
- </li>
+ <h5>Developers Guide</h5>
+ <ul>
+ <li class="none">
+ <a href="../userguide/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/bookmarks.html" title="Bookmarks">Bookmarks</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/building_pdfbox.html" title="Building PDFBox">Building PDFBox</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/tutorials.html" title="Tutorials">Tutorials</a>
+ </li>
+ <li class="none">
+ <strong>Cookbook</strong>
+ </li>
+ <li class="none">
+ <a href="../userguide/faq.html" title="FAQ">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/file_references.html" title="File References">File References</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/fonts.html" title="Fonts">Fonts</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/highlighting.html" title="Highlighting">Highlighting</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/metadata.html" title="Metadata">Metadata</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/redistribution.html" title="Redistribution">Redistribution</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/dot_net.html" title=".NET Version">.NET Version</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/text_extraction.html" title="Text Extraction">Text Extraction</a>
+ </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html" title="Project Information">Project Information</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
-
-
-
-
-
-
-
-
- </div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+
+
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="Cookbook"></a>Cookbook</h2>
-<p>
+ <!-- ! Licensed to the Apache Software Foundation (ASF) under one or more !
+ contributor license agreements. See the NOTICE file distributed with !
+ this work for additional information regarding copyright ownership. !
+ The ASF licenses this file to You under the Apache License, Version
+ 2.0 ! (the "License"); you may not use this file except in compliance
+ with ! the License. You may obtain a copy of the License at ! !
+ http://www.apache.org/licenses/LICENSE-2.0 ! ! Unless required by
+ applicable law or agreed to in writing, software ! distributed under
+ the License is distributed on an "AS IS" BASIS, ! WITHOUT WARRANTIES
+ OR CONDITIONS OF ANY KIND, either express or implied. ! See the
+ License for the specific language governing permissions and !
+ limitations under the License. ! -->
+
+ <div class="section"><h2>Cookbook<a name="Cookbook"></a></h2>
+ <p>
The Cookbook for PDFBox is a collection of source code samples to
help using PDFBox.
The samples are a growing collection of individual topics covering a
@@ -269,148 +189,249 @@
In addition the <a href="tutorials.html">Tutorials</a>
cover some of the most common applications of PDFBox.
</p>
-<div class="section"><h3><a name="Document_creation"></a>Document creation</h3>
-<table class="bodyTable"><tr class="a"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="b"><td><a href="./cookbook/creation.html#CreateBlankPDF">CreateBlankPDF</a></td>
-<td>This small sample shows how to create a new PDF document using PDFBox.</td>
-</tr>
-<tr class="a"><td><a href="./cookbook/creation.html#HelloWorld">HelloWorld</a></td>
-<td>This small sample shows how to create a new document and print the text "Hello World" using one of the PDF base fonts.</td>
-</tr>
-<tr class="b"><td><a href="./cookbook/creation.html#HelloWorldTTF">HelloWorldTTF</a></td>
-<td>This small sample shows how to create a new document and print the text "Hello World" using a TrueType Font.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/HelloWorldType1AfmPfb.html">HelloWorldType1AfmPfb</a></td>
-<td>This is an example that creates a simple document with a Type 1 font (afm + pfb).</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ImageToPDF.html">ImageToPDF</a></td>
-<td>This is an example that creates a simple document from an image.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ShowColorBoxes.html">ShowColorBoxes</a></td>
-<td>This is an example that creates a simple document with different boxes.</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Working_with_metadata"></a>Working with metadata</h3>
-<table class="bodyTable"><tr class="b"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/PrintDocumentMetaData.html">PrintDocumentMetaData</a></td>
-<td>This is an example on how to get a documents metadata information.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddMetadataFromDocInfo.html">AddMetadataFromDocInfo</a></td>
-<td>This is an example on how to add metadata to a document.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ExtractMetadata.html">ExtractMetadata</a></td>
-<td>This is an example on how to extract metadata from a PDF document.</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Dealing_with_forms"></a>Dealing with forms</h3>
-<table class="bodyTable"><tr class="b"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/fdf/PrintFields.html">PrintFields</a></td>
-<td>Shows how to print all the fields from a PDF document</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/fdf/SetField.html">SetField</a></td>
-<td>Shows how to set the value of a form field in a PDF document</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Using_the_PDModel"></a>Using the PDModel</h3>
-<table class="bodyTable"><tr class="a"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.html">AddImageToPDF</a></td>
-<td>This is an example that reads a PDF document and adds an image to it.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddJavascript.html">AddJavascript</a></td>
-<td>This is an example of how to set some JavaScript in the document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.html">AddMessageToEachPage</a></td>
-<td>This is an example of how to add a message to every page in a PDF document.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/Annotation.html">Annotation</a></td>
-<td>This is an example on how to add annotations to pages of a PDF document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/CreateBookmarks.html">CreateBookmarks</a></td>
-<td>This is an example on how to add bookmarks to a PDF document.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.html">EmbeddedFiles</a></td>
-<td>This is an example that creates a simple document and embeds a file into it..</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/GoToSecondBookmarkOnOpen.html">GoToSecondBookmarkOnOpen</a></td>
-<td>This is an example on how to an action to go to the second page when the PDF is opened.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/PrintBookmarks.html">PrintBookmarks</a></td>
-<td>This is an example on how to access the bookmarks that are part of a pdf document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/PrintURLs.html">PrintURLs</a></td>
-<td>This is an example of how to access a URL in a PDF document.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/RemoveFirstPage.html">RemoveFirstPage</a></td>
-<td>This is an example on how to remove pages from a PDF document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ReplaceString.html">ReplaceString</a></td>
-<td>This is an example that will replace a string in a PDF with a new one.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.html">ReplaceURLs</a></td>
-<td>This is an example of how to replace a URL in a PDF document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/RubberStamp.html">RubberStamp</a></td>
-<td>This is an example on how to add annotations to pages of a PDF document.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.html">RubberStampWithImage</a></td>
-<td>This is an example on how to add a rubber stamp with an image to pages of a PDF document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/UsingTextMatrix.html">UsingTextMatrix</a></td>
-<td>This is an example of how to use a text matrix.</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="PDFBox_persistence_features"></a>PDFBox persistence features</h3>
-<table class="bodyTable"><tr class="a"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/persistence/CopyDoc.html">CopyDoc</a></td>
-<td>This is an example used to copy a documents contents from a source doc to destination doc via an in-memory document representation</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/persistence/WriteDecodedDoc.html">PrintFields</a></td>
-<td>Shows how to load a PDF document and write with all streams decoded.</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Working_with_signatures"></a>Working with signatures</h3>
-<table class="bodyTable"><tr class="b"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/signature/ShowSignature.html">ShowSignature</a></td>
-<td>This examples will show how to gain access to the PDF signature</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Text_and_Image_locations"></a>Text and Image locations</h3>
-<table class="bodyTable"><tr class="b"><th>Sample</th>
-<th>Description</th>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/util/ExtractTextByArea.html">ExtractTextByArea</a></td>
-<td>This is an example on how to extract text from a specific area on the PDF document.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/util/PrintImageLocations.html">PrintImageLocations</a></td>
-<td>This is an example on how to get the x/y coordinates of image locations.</td>
-</tr>
-<tr class="a"><td><a href="../apidocs/org/apache/pdfbox/examples/util/PrintTextLocations.html">PrintTextLocations</a></td>
-<td>This is an example on how to get some x/y coordinates of text.</td>
-</tr>
-<tr class="b"><td><a href="../apidocs/org/apache/pdfbox/examples/util/RemoveAllText.html">RemoveAllText</a></td>
-<td>This is an example on how to remove all text from PDF document.</td>
-</tr>
-</table>
-</div>
-</div>
+
+ <div class="section"><h3>Document creation<a name="Document_creation"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="./cookbook/creation.html#CreateBlankPDF">CreateBlankPDF</a>
+ </td>
+ <td align="left">This small sample shows how to create a new PDF document using PDFBox.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="./cookbook/creation.html#HelloWorld">HelloWorld</a>
+ </td>
+ <td align="left">This small sample shows how to create a new document and print the text "Hello World" using one of the PDF base fonts.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="./cookbook/creation.html#HelloWorldTTF">HelloWorldTTF</a>
+ </td>
+ <td align="left">This small sample shows how to create a new document and print the text "Hello World" using a TrueType Font.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/HelloWorldType1AfmPfb.html">HelloWorldType1AfmPfb</a>
+ </td>
+ <td align="left">This is an example that creates a simple document with a Type 1 font (afm + pfb).</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ImageToPDF.html">ImageToPDF</a>
+ </td>
+ <td align="left">This is an example that creates a simple document from an image.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ShowColorBoxes.html">ShowColorBoxes</a>
+ </td>
+ <td align="left">This is an example that creates a simple document with different boxes.</td>
+ </tr>
+
+ </table>
+ </div>
+
+ <div class="section"><h3>Working with metadata<a name="Working_with_metadata"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/PrintDocumentMetaData.html">PrintDocumentMetaData</a>
+ </td>
+ <td align="left">This is an example on how to get a documents metadata information.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddMetadataFromDocInfo.html">AddMetadataFromDocInfo</a>
+ </td>
+ <td align="left">This is an example on how to add metadata to a document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ExtractMetadata.html">ExtractMetadata</a>
+ </td>
+ <td align="left">This is an example on how to extract metadata from a PDF document.</td>
+ </tr>
+
+ </table>
+ </div>
+
+ <div class="section"><h3>Dealing with forms<a name="Dealing_with_forms"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/fdf/PrintFields.html">PrintFields</a>
+ </td>
+ <td align="left">Shows how to print all the fields from a PDF document</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/fdf/SetField.html">SetField</a>
+ </td>
+ <td align="left">Shows how to set the value of a form field in a PDF document</td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="section"><h3>Using the PDModel<a name="Using_the_PDModel"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddImageToPDF.html">AddImageToPDF</a>
+ </td>
+ <td align="left">This is an example that reads a PDF document and adds an image to it.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddJavascript.html">AddJavascript</a>
+ </td>
+ <td align="left">This is an example of how to set some JavaScript in the document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/AddMessageToEachPage.html">AddMessageToEachPage</a>
+ </td>
+ <td align="left">This is an example of how to add a message to every page in a PDF document.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/Annotation.html">Annotation</a>
+ </td>
+ <td align="left">This is an example on how to add annotations to pages of a PDF document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/CreateBookmarks.html">CreateBookmarks</a>
+ </td>
+ <td align="left">This is an example on how to add bookmarks to a PDF document.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/EmbeddedFiles.html">EmbeddedFiles</a>
+ </td>
+ <td align="left">This is an example that creates a simple document and embeds a file into it..</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/GoToSecondBookmarkOnOpen.html">GoToSecondBookmarkOnOpen</a>
+ </td>
+ <td align="left">This is an example on how to an action to go to the second page when the PDF is opened.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/PrintBookmarks.html">PrintBookmarks</a>
+ </td>
+ <td align="left">This is an example on how to access the bookmarks that are part of a pdf document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/PrintURLs.html">PrintURLs</a>
+ </td>
+ <td align="left">This is an example of how to access a URL in a PDF document.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/RemoveFirstPage.html">RemoveFirstPage</a>
+ </td>
+ <td align="left">This is an example on how to remove pages from a PDF document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ReplaceString.html">ReplaceString</a>
+ </td>
+ <td align="left">This is an example that will replace a string in a PDF with a new one.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/ReplaceURLs.html">ReplaceURLs</a>
+ </td>
+ <td align="left">This is an example of how to replace a URL in a PDF document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/RubberStamp.html">RubberStamp</a>
+ </td>
+ <td align="left">This is an example on how to add annotations to pages of a PDF document.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.html">RubberStampWithImage</a>
+ </td>
+ <td align="left">This is an example on how to add a rubber stamp with an image to pages of a PDF document.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><a href="../apidocs/org/apache/pdfbox/examples/pdmodel/UsingTextMatrix.html">UsingTextMatrix</a>
+ </td>
+ <td align="left">This is an example of how to use a text matrix.</td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="section"><h3>PDFBox persistence features<a name="PDFBox_persistence_features"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/persistence/CopyDoc.html">CopyDoc</a>
+ </td>
+ <td align="left">This is an example used to copy a documents contents from a source doc to destination doc via an in-memory document representation</td>
+ </tr>
+ <tr class="a">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/persistence/WriteDecodedDoc.html">PrintFields</a>
+ </td>
+ <td align="left">Shows how to load a PDF document and write with all streams decoded.</td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="section"><h3>Working with signatures<a name="Working_with_signatures"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/signature/ShowSignature.html">ShowSignature</a>
+ </td>
+ <td align="left">This examples will show how to gain access to the PDF signature</td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="section"><h3>Text and Image locations<a name="Text_and_Image_locations"></a></h3>
+ <table align="center" border="1" class="bodyTable">
+ <tr class="a">
+ <th align="left">Sample</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/util/ExtractTextByArea.html">ExtractTextByArea</a>
+ </td>
+ <td align="left">This is an example on how to extract text from a specific area on the PDF document.</td>
+ </tr>
+ <tr class="a">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/util/PrintImageLocations.html">PrintImageLocations</a>
+ </td>
+ <td align="left">This is an example on how to get the x/y coordinates of image locations.</td>
+ </tr>
+ <tr class="b">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/util/PrintTextLocations.html">PrintTextLocations</a>
+ </td>
+ <td align="left">This is an example on how to get some x/y coordinates of text.</td>
+ </tr>
+ <tr class="a">
+ <td align="left">
+ <a href="../apidocs/org/apache/pdfbox/examples/util/RemoveAllText.html">RemoveAllText</a>
+ </td>
+ <td align="left">This is an example on how to remove all text from PDF document.</td>
+ </tr>
+ </table>
+ </div>
+
+
+ </div>
+
+
+
</div>
</div>
@@ -418,19 +439,11 @@
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2008-2010
-
- The Apache Software Foundation
-
-
-
-
-
-
-
-
- </div>
+ <div class="xright">Copyright © 2008-2010
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
<div class="clear">
<hr/>
</div>
Modified: pdfbox/site/publish/userguide/cookbook/creation.html
URL: http://svn.apache.org/viewvc/pdfbox/site/publish/userguide/cookbook/creation.html?rev=924869&r1=924868&r2=924869&view=diff
==============================================================================
--- pdfbox/site/publish/userguide/cookbook/creation.html (original)
+++ pdfbox/site/publish/userguide/cookbook/creation.html Thu Mar 18 15:46:08 2010
@@ -1,377 +1,287 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
-<html xmlns="http://www.w3.org/1999/xhtml">
+<!-- Generated by Apache Maven Doxia at Mar 18, 2010 -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <title>Apache PDFBox - PDFBox - Cookbook</title>
+ <title>Apache PDFBox -
+ PDFBox - Cookbook</title>
<style type="text/css" media="all">
@import url("../../css/maven-base.css");
@import url("../../css/maven-theme.css");
@import url("../../css/site.css");
</style>
<link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
- </head>
+ <meta name="Date-Revision-yyyymmdd" content="20100318" />
+ <meta http-equiv="Content-Language" content="en" />
+
+ </head>
<body class="composite">
<div id="banner">
- <a href="" id="bannerLeft">
-
- <img src="../../images/Logo.gif" alt="Apache PDFBox" />
-
- </a>
- <a href="http://www.apache.org/" id="bannerRight">
-
- <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
-
- </a>
+ <a href="" id="bannerLeft" title="Apache PDFBox">
+ <img src="../../images/Logo.gif" alt="Apache PDFBox" />
+ </a>
+ <a href="http://www.apache.org/" id="bannerRight" title="The Apache Software Foundation">
+ <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
+ </a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xright">
-
-
-
-
-
-
-
- </div>
+
+ <div class="xright">
+
+ </div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>About</h5>
- <ul>
-
- <li class="none">
- <a href="../../index.html">Welcome</a>
- </li>
-
- <li class="none">
- <a href="../../download.html">Download</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink">License</a>
- </li>
-
- <li class="none">
- <a href="../../mailing-list.html">Mailing Lists</a>
- </li>
-
- <li class="none">
- <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink">Issue Tracker</a>
- </li>
-
- <li class="none">
- <a href="../../references.html">References</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">ASF Sponsorship Program</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">ASF Thanks</a>
- </li>
+
+
+ <h5>About</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html" title="Welcome">Welcome</a>
+ </li>
+ <li class="none">
+ <a href="../../download.html" title="Download">Download</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink" title="License">License</a>
+ </li>
+ <li class="none">
+ <a href="../../mailing-list.html" title="Mailing Lists">Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink" title="Issue Tracker">Issue Tracker</a>
+ </li>
+ <li class="none">
+ <a href="../../references.html" title="References">References</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="ASF Sponsorship Program">ASF Sponsorship Program</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="ASF Thanks">ASF Thanks</a>
+ </li>
</ul>
- <h5>Command Line Utilities</h5>
- <ul>
-
- <li class="none">
- <a href="../../commandlineutilities/index.html">Index</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/ConvertColorspace.html">ConvertColorspace</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/Decrypt.html">Decrypt</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/Encrypt.html">Encrypt</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/ExtractText.html">ExtractText</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/Overlay.html">Overlay</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/PrintPDF.html">PrintPDF</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/PDFDebugger.html">PDFDebugger</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/PDFMerger.html">PDFMerger</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/PDFReader.html">PDFReader</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/PDFSplit.html">PDFSplit</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/PDFToImage.html">PDFToImage</a>
- </li>
-
- <li class="none">
- <a href="../../commandlineutilities/TextToPDF.html">TextToPDF</a>
- </li>
+ <h5>Command Line Utilities</h5>
+ <ul>
+ <li class="none">
+ <a href="../../commandlineutilities/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/ConvertColorspace.html" title="ConvertColorspace">ConvertColorspace</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/Decrypt.html" title="Decrypt">Decrypt</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/Encrypt.html" title="Encrypt">Encrypt</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/ExtractText.html" title="ExtractText">ExtractText</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/Overlay.html" title="Overlay">Overlay</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/PrintPDF.html" title="PrintPDF">PrintPDF</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/PDFDebugger.html" title="PDFDebugger">PDFDebugger</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/PDFMerger.html" title="PDFMerger">PDFMerger</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/PDFReader.html" title="PDFReader">PDFReader</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/PDFSplit.html" title="PDFSplit">PDFSplit</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/PDFToImage.html" title="PDFToImage">PDFToImage</a>
+ </li>
+ <li class="none">
+ <a href="../../commandlineutilities/TextToPDF.html" title="TextToPDF">TextToPDF</a>
+ </li>
</ul>
- <h5>Developers Guide</h5>
- <ul>
-
- <li class="none">
- <a href="../../userguide/index.html">Index</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/bookmarks.html">Bookmarks</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/building_pdfbox.html">Building PDFBox</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/tutorials.html">Tutorials</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/cookbook.html">Cookbook</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/file_references.html">File References</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/fonts.html">Fonts</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/highlighting.html">Highlighting</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/metadata.html">Metadata</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/redistribution.html">Redistribution</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/dot_net.html">.NET Version</a>
- </li>
-
- <li class="none">
- <a href="../../userguide/text_extraction.html">Text Extraction</a>
- </li>
+ <h5>Developers Guide</h5>
+ <ul>
+ <li class="none">
+ <a href="../../userguide/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/bookmarks.html" title="Bookmarks">Bookmarks</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/building_pdfbox.html" title="Building PDFBox">Building PDFBox</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/tutorials.html" title="Tutorials">Tutorials</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/cookbook.html" title="Cookbook">Cookbook</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/faq.html" title="FAQ">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/file_references.html" title="File References">File References</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/fonts.html" title="Fonts">Fonts</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/highlighting.html" title="Highlighting">Highlighting</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/metadata.html" title="Metadata">Metadata</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/redistribution.html" title="Redistribution">Redistribution</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/dot_net.html" title=".NET Version">.NET Version</a>
+ </li>
+ <li class="none">
+ <a href="../../userguide/text_extraction.html" title="Text Extraction">Text Extraction</a>
+ </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../../project-info.html">Project Information</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html" title="Project Information">Project Information</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../../images/logos/maven-feather.png"></img>
- </a>
-
-
-
-
-
-
-
-
- </div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" />
+ </a>
+
+
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="Cookbook_-_Document_Creation"></a>Cookbook - Document Creation</h2>
-<div class="section"><h3><a name="CreateBlankPDF"></a>CreateBlankPDF</h3>
-<p>This small sample shows how to create a new PDF document using PDFBox.</p>
-<p>First we need a new empty document:</p>
-<div class="source"><pre>
+ <!-- ! Licensed to the Apache Software Foundation (ASF) under one or more
+ ! contributor license agreements. See the NOTICE file distributed with
+ ! this work for additional information regarding copyright ownership.
+ ! The ASF licenses this file to You under the Apache License, Version 2.0
+ ! (the "License"); you may not use this file except in compliance with
+ ! the License. You may obtain a copy of the License at
+ !
+ ! http://www.apache.org/licenses/LICENSE-2.0
+ !
+ ! Unless required by applicable law or agreed to in writing, software
+ ! distributed under the License is distributed on an "AS IS" BASIS,
+ ! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ! See the License for the specific language governing permissions and
+ ! limitations under the License.
+ ! -->
+
+ <div class="section"><h2>Cookbook - Document Creation<a name="Cookbook_-_Document_Creation"></a></h2>
+ <a name="CreateBlankPDF"></a><div class="section"><h3 id="CreateBlankPDF">CreateBlankPDF</h3>
+ <p>This small sample shows how to create a new PDF document using PDFBox.</p>
+ <p>First we need a new empty document:</p>
+ <div class="source"><pre>
document = new PDDocument();
- </pre>
-</div>
-<p>As every document needs at least one page we have to add a blank page to the newly created document:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>As every document needs at least one page we have to add a blank page to the newly created document:</p>
+ <div class="source"><pre>
PDPage blankPage = new PDPage();
document.addPage( blankPage );
- </pre>
-</div>
-<p>we can save the newly created document:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>we can save the newly created document:</p>
+ <div class="source"><pre>
document.save("BlankPage.pdf");
- </pre>
-</div>
-<p>finally we have to ensure that the document is properly closed:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>finally we have to ensure that the document is properly closed:</p>
+ <div class="source"><pre>
document.close();
- </pre>
-</div>
-<p>Full source code at
- <a href="http://svn.apache.org/repos/asf/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/CreateBlankPDF.java" class="externalLink">CreateBlankPDF</a></p>
-</div>
-<div class="section"><h3><a name="HelloWorld"></a>HelloWorld</h3>
-<p>This small sample shows how to create a new document and print the text "Hello World" using one of the PDF base fonts.</p>
-<p>First we need a new empty document and add a page to it:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Full source code at
+ <a class="externalLink" href="http://svn.apache.org/repos/asf/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/CreateBlankPDF.java">CreateBlankPDF</a></p>
+ </div>
+
+ <a name="HelloWorld"></a><div class="section"><h3 id="HelloWorld">HelloWorld</h3>
+ <p>This small sample shows how to create a new document and print the text "Hello World" using one of the PDF base fonts.</p>
+ <p>First we need a new empty document and add a page to it:</p>
+ <div class="source"><pre>
document = new PDDocument();
PDPage page = new PDPage();
document.addPage( page );
- </pre>
-</div>
-<p>Next we have to create a new font object selecting one of the PDF base fonts:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Next we have to create a new font object selecting one of the PDF base fonts:</p>
+ <div class="source"><pre>
PDFont font = PDType1Font.HELVETICA_BOLD;
- </pre>
-</div>
-<p>Next we start a new content stream which will "hold" the to be created content:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Next we start a new content stream which will "hold" the to be created content:</p>
+ <div class="source"><pre>
PDPageContentStream contentStream = new PDPageContentStream(document, page);
- </pre>
-</div>
-<p>Next we define a text content stream using the selected font, moving the cursor and drawing the text "Hello World":</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Next we define a text content stream using the selected font, moving the cursor and drawing the text "Hello World":</p>
+ <div class="source"><pre>
contentStream.beginText();
contentStream.setFont( font, 12 );
contentStream.moveTextPositionByAmount( 100, 700 );
contentStream.drawString( "Hello World" );
contentStream.endText();
- </pre>
-</div>
-<p>We <strong>have to</strong> make sure that the content stream is closed:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>We <b>have to</b> make sure that the content stream is closed:</p>
+ <div class="source"><pre>
contentStream.close();
- </pre>
-</div>
-<p>Finally we save the results and ensure that the document is properly closed:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Finally we save the results and ensure that the document is properly closed:</p>
+ <div class="source"><pre>
document.save( "Hello World.pdf");
document.close();
- </pre>
-</div>
-<p>Full source code at
- <a href="http://svn.apache.org/repos/asf/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/HelloWorld.java" class="externalLink">HelloWorld</a></p>
-</div>
-<div class="section"><h3><a name="HelloWorldTTF"></a>HelloWorldTTF</h3>
-<p>This small sample shows how to create a new document and print the text "Hello World" using using a TrueType Font.</p>
-<p>First we need a new empty document and add a page to it:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Full source code at
+ <a class="externalLink" href="http://svn.apache.org/repos/asf/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/HelloWorld.java">HelloWorld</a></p>
+ </div>
+
+ <a name="HelloWorldTTF"></a><div class="section"><h3 id="HelloWorldTTF">HelloWorldTTF</h3>
+ <p>This small sample shows how to create a new document and print the text "Hello World" using using a TrueType Font.</p>
+ <p>First we need a new empty document and add a page to it:</p>
+ <div class="source"><pre>
document = new PDDocument();
PDPage page = new PDPage();
document.addPage( page );
- </pre>
-</div>
-<p>Next we have to create a new font object loading a TrueType font into the document:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Next we have to create a new font object loading a TrueType font into the document:</p>
+ <div class="source"><pre>
PDFont font = PDTrueTypeFont.loadTTF(document, "Arial.ttf");
- </pre>
-</div>
-<p>Next we start a new content stream which will "hold" the to be created content:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Next we start a new content stream which will "hold" the to be created content:</p>
+ <div class="source"><pre>
PDPageContentStream contentStream = new PDPageContentStream(document, page);
- </pre>
-</div>
-<p>Next we define a text content stream using the selected font, moving the cursor and drawing the text "Hello World":</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Next we define a text content stream using the selected font, moving the cursor and drawing the text "Hello World":</p>
+ <div class="source"><pre>
contentStream.beginText();
contentStream.setFont( font, 12 );
contentStream.moveTextPositionByAmount( 100, 700 );
contentStream.drawString( "Hello World" );
contentStream.endText();
- </pre>
-</div>
-<p>We <strong>have to</strong> make sure that the content stream is closed:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>We <b>have to</b> make sure that the content stream is closed:</p>
+ <div class="source"><pre>
contentStream.close();
- </pre>
-</div>
-<p>Finally we save the results and ensure that the document is properly closed:</p>
-<div class="source"><pre>
+ </pre></div>
+ <p>Finally we save the results and ensure that the document is properly closed:</p>
+ <div class="source"><pre>
document.save( "Hello World.pdf");
document.close();
- </pre>
-</div>
-<p>Full source code at
- <a href="http://svn.apache.org/repos/asf/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/HelloWorldTTF.java" class="externalLink">HelloWorldTTF</a></p>
-</div>
-</div>
+ </pre></div>
+ <p>Full source code at
+ <a class="externalLink" href="http://svn.apache.org/repos/asf/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/HelloWorldTTF.java">HelloWorldTTF</a></p>
+ </div>
+ </div>
+
</div>
</div>
@@ -379,19 +289,11 @@
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2008-2010
-
- The Apache Software Foundation
-
-
-
-
-
-
-
-
- </div>
+ <div class="xright">Copyright © 2008-2010
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
<div class="clear">
<hr/>
</div>
Modified: pdfbox/site/publish/userguide/dot_net.html
URL: http://svn.apache.org/viewvc/pdfbox/site/publish/userguide/dot_net.html?rev=924869&r1=924868&r2=924869&view=diff
==============================================================================
--- pdfbox/site/publish/userguide/dot_net.html (original)
+++ pdfbox/site/publish/userguide/dot_net.html Thu Mar 18 15:46:08 2010
@@ -1,286 +1,210 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
-<html xmlns="http://www.w3.org/1999/xhtml">
+<!-- Generated by Apache Maven Doxia at Mar 18, 2010 -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <title>Apache PDFBox - PDFBox - .NET Version</title>
+ <title>Apache PDFBox -
+ PDFBox - .NET Version</title>
<style type="text/css" media="all">
@import url("../css/maven-base.css");
@import url("../css/maven-theme.css");
@import url("../css/site.css");
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- </head>
+ <meta name="Date-Revision-yyyymmdd" content="20100318" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="keywords" content="Java PDF Library, pdftotext, PDF to text, ..NET pdf text extraction, pdf ASP, pdf .NET" />
+ </head>
<body class="composite">
<div id="banner">
- <a href="" id="bannerLeft">
-
- <img src="../images/Logo.gif" alt="Apache PDFBox" />
-
- </a>
- <a href="http://www.apache.org/" id="bannerRight">
-
- <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
-
- </a>
+ <a href="" id="bannerLeft" title="Apache PDFBox">
+ <img src="../images/Logo.gif" alt="Apache PDFBox" />
+ </a>
+ <a href="http://www.apache.org/" id="bannerRight" title="The Apache Software Foundation">
+ <img src="http://www.apache.org/images/asf_logo.gif" alt="The Apache Software Foundation" />
+ </a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xright">
-
-
-
-
-
-
-
- </div>
+
+ <div class="xright">
+
+ </div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
-
-
-
-
-
-
-
-
- <h5>About</h5>
- <ul>
-
- <li class="none">
- <a href="../index.html">Welcome</a>
- </li>
-
- <li class="none">
- <a href="../download.html">Download</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink">License</a>
- </li>
-
- <li class="none">
- <a href="../mailing-list.html">Mailing Lists</a>
- </li>
-
- <li class="none">
- <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink">Issue Tracker</a>
- </li>
-
- <li class="none">
- <a href="../references.html">References</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">ASF Sponsorship Program</a>
- </li>
-
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">ASF Thanks</a>
- </li>
+
+
+ <h5>About</h5>
+ <ul>
+ <li class="none">
+ <a href="../index.html" title="Welcome">Welcome</a>
+ </li>
+ <li class="none">
+ <a href="../download.html" title="Download">Download</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink" title="License">License</a>
+ </li>
+ <li class="none">
+ <a href="../mailing-list.html" title="Mailing Lists">Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/PDFBOX" class="externalLink" title="Issue Tracker">Issue Tracker</a>
+ </li>
+ <li class="none">
+ <a href="../references.html" title="References">References</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="ASF Sponsorship Program">ASF Sponsorship Program</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="ASF Thanks">ASF Thanks</a>
+ </li>
</ul>
- <h5>Command Line Utilities</h5>
- <ul>
-
- <li class="none">
- <a href="../commandlineutilities/index.html">Index</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/ConvertColorspace.html">ConvertColorspace</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/Decrypt.html">Decrypt</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/Encrypt.html">Encrypt</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/ExtractText.html">ExtractText</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/Overlay.html">Overlay</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PrintPDF.html">PrintPDF</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFDebugger.html">PDFDebugger</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFMerger.html">PDFMerger</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFReader.html">PDFReader</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFSplit.html">PDFSplit</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/PDFToImage.html">PDFToImage</a>
- </li>
-
- <li class="none">
- <a href="../commandlineutilities/TextToPDF.html">TextToPDF</a>
- </li>
+ <h5>Command Line Utilities</h5>
+ <ul>
+ <li class="none">
+ <a href="../commandlineutilities/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/ConvertColorspace.html" title="ConvertColorspace">ConvertColorspace</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/Decrypt.html" title="Decrypt">Decrypt</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/Encrypt.html" title="Encrypt">Encrypt</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/ExtractText.html" title="ExtractText">ExtractText</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/Overlay.html" title="Overlay">Overlay</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PrintPDF.html" title="PrintPDF">PrintPDF</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFDebugger.html" title="PDFDebugger">PDFDebugger</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFMerger.html" title="PDFMerger">PDFMerger</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFReader.html" title="PDFReader">PDFReader</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFSplit.html" title="PDFSplit">PDFSplit</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/PDFToImage.html" title="PDFToImage">PDFToImage</a>
+ </li>
+ <li class="none">
+ <a href="../commandlineutilities/TextToPDF.html" title="TextToPDF">TextToPDF</a>
+ </li>
</ul>
- <h5>Developers Guide</h5>
- <ul>
-
- <li class="none">
- <a href="../userguide/index.html">Index</a>
- </li>
-
- <li class="none">
- <a href="../userguide/bookmarks.html">Bookmarks</a>
- </li>
-
- <li class="none">
- <a href="../userguide/building_pdfbox.html">Building PDFBox</a>
- </li>
-
- <li class="none">
- <a href="../userguide/tutorials.html">Tutorials</a>
- </li>
-
- <li class="none">
- <a href="../userguide/cookbook.html">Cookbook</a>
- </li>
-
- <li class="none">
- <a href="../userguide/faq.html">FAQ</a>
- </li>
-
- <li class="none">
- <a href="../userguide/file_references.html">File References</a>
- </li>
-
- <li class="none">
- <a href="../userguide/fonts.html">Fonts</a>
- </li>
-
- <li class="none">
- <a href="../userguide/highlighting.html">Highlighting</a>
- </li>
-
- <li class="none">
- <a href="../userguide/metadata.html">Metadata</a>
- </li>
-
- <li class="none">
- <a href="../userguide/redistribution.html">Redistribution</a>
- </li>
-
- <li class="none">
- <strong>.NET Version</strong>
- </li>
-
- <li class="none">
- <a href="../userguide/text_extraction.html">Text Extraction</a>
- </li>
+ <h5>Developers Guide</h5>
+ <ul>
+ <li class="none">
+ <a href="../userguide/index.html" title="Index">Index</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/bookmarks.html" title="Bookmarks">Bookmarks</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/building_pdfbox.html" title="Building PDFBox">Building PDFBox</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/tutorials.html" title="Tutorials">Tutorials</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/cookbook.html" title="Cookbook">Cookbook</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/faq.html" title="FAQ">FAQ</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/file_references.html" title="File References">File References</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/fonts.html" title="Fonts">Fonts</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/highlighting.html" title="Highlighting">Highlighting</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/metadata.html" title="Metadata">Metadata</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/redistribution.html" title="Redistribution">Redistribution</a>
+ </li>
+ <li class="none">
+ <strong>.NET Version</strong>
+ </li>
+ <li class="none">
+ <a href="../userguide/text_extraction.html" title="Text Extraction">Text Extraction</a>
+ </li>
</ul>
- <h5>Project Documentation</h5>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
- </li>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html" title="Project Information">Project Information</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
-
-
-
-
-
-
-
-
- </div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
+ </a>
+
+
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
- <meta name="keywords"></meta><div class="section"><h2><a name="a.NET_Version"></a>.NET Version</h2>
-<p>
- Even though PDFBox is written in Java, there is also a .NET version that is available. It utilizes <a href="http://www.ikvm.net" class="externalLink">IKVM</a>
+ <!-- ! Licensed to the Apache Software Foundation (ASF) under one or more
+ ! contributor license agreements. See the NOTICE file distributed with
+ ! this work for additional information regarding copyright ownership.
+ ! The ASF licenses this file to You under the Apache License, Version 2.0
+ ! (the "License"); you may not use this file except in compliance with
+ ! the License. You may obtain a copy of the License at
+ !
+ ! http://www.apache.org/licenses/LICENSE-2.0
+ !
+ ! Unless required by applicable law or agreed to in writing, software
+ ! distributed under the License is distributed on an "AS IS" BASIS,
+ ! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ! See the License for the specific language governing permissions and
+ ! limitations under the License.
+ ! -->
+
+ <div class="section"><h2>.NET Version<a name="a.NET_Version"></a></h2>
+ <p>
+ Even though PDFBox is written in Java, there is also a .NET version that is available. It utilizes <a class="externalLink" href="http://www.ikvm.net">IKVM</a>
to create a fully functioning PDF library for the .NET framework. The released version contains a bin directory with all of the
required DLL files. For the command line applications that are available in the Java version a native windows executable is
also included. This page contains information that is specific to using the .NET version of PDFBox.
</p>
-<div class="section"><h2><a name="log4j"></a>log4j</h2>
-<p>
+ <div class="section"><h3>log4j<a name="log4j"></a></h3>
+ <p>
PDFBox no longer requires log4j! Older versions used to require you to configure log4j before using it in .NET
</p>
-</div>
-<div class="section"><h2><a name="Lucene"></a>Lucene</h2>
-<p>
+ </div>
+ <div class="section"><h3>Lucene<a name="Lucene"></a></h3>
+ <p>
The way that IKVM works is that DLLs are only compatible when used with the dependent DLLs that are used to build them. For example, in
order to build the PDFBox DLL, a lucene DLL needs to be built, then the PDFBox DLL. The PDFBox DLL now depends on that <b>*exact*</b>
lucene DLL. This means that if you build your own version of the lucene DLL then you also need to rebuild the PDFBox DLL. Your best bet
is to use the lucene/pdfbox that is shipped with PDFBox.
</p>
-</div>
-</div>
+ </div>
+ </div>
+
</div>
</div>
@@ -288,19 +212,11 @@
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2008-2010
-
- The Apache Software Foundation
-
-
-
-
-
-
-
-
- </div>
+ <div class="xright">Copyright © 2008-2010
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
<div class="clear">
<hr/>
</div>