diff options
| author | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-05 09:20:54 +0100 |
|---|---|---|
| committer | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-05 09:20:54 +0100 |
| commit | 87c9269152f8c631123525b796cf07dc0cca7398 (patch) | |
| tree | 041c36a99e746df8a802375a5f71b0f7081f6e51 /docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html | |
| parent | 3f78cac3c1c5255b315a60c98cfb6853f1faa2fc (diff) | |
| download | pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.tar.gz pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.tar.bz2 pdf-as-4-87c9269152f8c631123525b796cf07dc0cca7398.zip | |
Documentation + Documentation building
Diffstat (limited to 'docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html')
| -rw-r--r-- | docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html | 356 |
1 files changed, 356 insertions, 0 deletions
diff --git a/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html new file mode 100644 index 00000000..a3ea9e56 --- /dev/null +++ b/docs/at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html @@ -0,0 +1,356 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_51) on Tue Feb 04 16:50:11 CET 2014 --> +<meta http-equiv="Content-Type" content="text/html" charset="ISO-8859-1"> +<title>SignaturePlaceholderExtractor (PDF-AS 4.0 Library)</title> +<meta name="date" content="2014-02-04"> +<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="SignaturePlaceholderExtractor (PDF-AS 4.0 Library)"; + } +//--> +</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><a href="../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SignaturePlaceholderExtractor.html">Use</a></li> +<li><a href="package-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 class="aboutLanguage"><em><b>PDF-AS 4.0 Library false</b></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html" title="class in at.gv.egiz.pdfas.lib.impl.placeholder"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html" target="_top">Frames</a></li> +<li><a href="SignaturePlaceholderExtractor.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">at.gv.egiz.pdfas.lib.impl.placeholder</div> +<h2 title="Class SignaturePlaceholderExtractor" class="title">Class SignaturePlaceholderExtractor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://java.sun.com/j2se/1.5.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>org.apache.pdfbox.util.PDFStreamEngine</li> +<li> +<ul class="inheritance"> +<li>at.gv.egiz.pdfas.lib.impl.placeholder.SignaturePlaceholderExtractor</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SignaturePlaceholderExtractor</span> +extends org.apache.pdfbox.util.PDFStreamEngine</pre> +<div class="block">Extract all relevant information from a placeholder image.</div> +</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html#PLACEHOLDER_MATCH_MODE_LENIENT">PLACEHOLDER_MATCH_MODE_LENIENT</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html#PLACEHOLDER_MATCH_MODE_MODERATE">PLACEHOLDER_MATCH_MODE_MODERATE</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html#PLACEHOLDER_MATCH_MODE_STRICT">PLACEHOLDER_MATCH_MODE_STRICT</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://java.sun.com/j2se/1.5.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="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html#QR_PLACEHOLDER_IDENTIFIER">QR_PLACEHOLDER_IDENTIFIER</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html" title="class in at.gv.egiz.pdfas.lib.impl.placeholder">SignaturePlaceholderData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html#extract(java.io.InputStream, java.lang.String, int)">extract</a></strong>(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> inputStream, + <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> placeholderId, + int matchMode)</code> +<div class="block">Search the document for placeholder images and possibly included + additional info.<br/> + Searches only for the first placeholder page after page from top.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html#processOperator(org.apache.pdfbox.util.PDFOperator, java.util.List)">processOperator</a></strong>(org.apache.pdfbox.util.PDFOperator operator, + <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> arguments)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.util.PDFStreamEngine"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.pdfbox.util.PDFStreamEngine</h3> +<code>getColorSpaces, getCurrentPage, getFonts, getGraphicsStack, getGraphicsState, getGraphicsStates, getResources, getTextLineMatrix, getTextMatrix, getTotalCharCnt, getValidCharCnt, getXObjects, inspectFontEncoding, isForceParsing, processEncodedText, processOperator, processStream, processSubStream, processTextPosition, registerOperatorProcessor, resetEngine, setColorSpaces, setFonts, setForceParsing, setGraphicsStack, setGraphicsState, setGraphicsStates, setTextLineMatrix, setTextMatrix</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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/j2se/1.5.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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/j2se/1.5.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> +</li> +</ul> +</div> +<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="QR_PLACEHOLDER_IDENTIFIER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>QR_PLACEHOLDER_IDENTIFIER</h4> +<pre>public static final <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> QR_PLACEHOLDER_IDENTIFIER</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#at.gv.egiz.pdfas.lib.impl.placeholder.SignaturePlaceholderExtractor.QR_PLACEHOLDER_IDENTIFIER">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PLACEHOLDER_MATCH_MODE_STRICT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PLACEHOLDER_MATCH_MODE_STRICT</h4> +<pre>public static final int PLACEHOLDER_MATCH_MODE_STRICT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#at.gv.egiz.pdfas.lib.impl.placeholder.SignaturePlaceholderExtractor.PLACEHOLDER_MATCH_MODE_STRICT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PLACEHOLDER_MATCH_MODE_MODERATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PLACEHOLDER_MATCH_MODE_MODERATE</h4> +<pre>public static final int PLACEHOLDER_MATCH_MODE_MODERATE</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#at.gv.egiz.pdfas.lib.impl.placeholder.SignaturePlaceholderExtractor.PLACEHOLDER_MATCH_MODE_MODERATE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PLACEHOLDER_MATCH_MODE_LENIENT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PLACEHOLDER_MATCH_MODE_LENIENT</h4> +<pre>public static final int PLACEHOLDER_MATCH_MODE_LENIENT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../constant-values.html#at.gv.egiz.pdfas.lib.impl.placeholder.SignaturePlaceholderExtractor.PLACEHOLDER_MATCH_MODE_LENIENT">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="extract(java.io.InputStream, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extract</h4> +<pre>public static <a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html" title="class in at.gv.egiz.pdfas.lib.impl.placeholder">SignaturePlaceholderData</a> extract(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> inputStream, + <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> placeholderId, + int matchMode) + throws at.gv.egiz.pdfas.common.exceptions.PdfAsException</pre> +<div class="block">Search the document for placeholder images and possibly included + additional info.<br/> + Searches only for the first placeholder page after page from top.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>all available info from the first found placeholder.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>PDFDocumentException</code> - if the document could not be read.</dd> +<dd><code>at.gv.egiz.pdfas.common.exceptions.PlaceholderExtractionException</code> - if STRICT matching mode was requested and no suitable placeholder could be found.</dd> +<dd><code>at.gv.egiz.pdfas.common.exceptions.PdfAsException</code></dd></dl> +</li> +</ul> +<a name="processOperator(org.apache.pdfbox.util.PDFOperator, java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processOperator</h4> +<pre>protected void processOperator(org.apache.pdfbox.util.PDFOperator operator, + <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> arguments) + throws <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>processOperator</code> in class <code>org.apache.pdfbox.util.PDFStreamEngine</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><a href="../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SignaturePlaceholderExtractor.html">Use</a></li> +<li><a href="package-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 class="aboutLanguage"><em><b>PDF-AS 4.0 Library false</b></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../../at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderData.html" title="class in at.gv.egiz.pdfas.lib.impl.placeholder"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?at/gv/egiz/pdfas/lib/impl/placeholder/SignaturePlaceholderExtractor.html" target="_top">Frames</a></li> +<li><a href="SignaturePlaceholderExtractor.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |