diff options
| author | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-20 10:54:04 +0100 |
|---|---|---|
| committer | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-20 12:05:25 +0100 |
| commit | 835256964f3fa64587a0e05b859d012d125be308 (patch) | |
| tree | 21f68d684caf4a8e8afe2321f40e001202ba7f3e /docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html | |
| parent | e2fb88b773931ed3fbb1fee22c3a53a2ebd3b1fd (diff) | |
| download | pdf-as-4-835256964f3fa64587a0e05b859d012d125be308.tar.gz pdf-as-4-835256964f3fa64587a0e05b859d012d125be308.tar.bz2 pdf-as-4-835256964f3fa64587a0e05b859d012d125be308.zip | |
Documentation update
Diffstat (limited to 'docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html')
| -rw-r--r-- | docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html | 452 |
1 files changed, 452 insertions, 0 deletions
diff --git a/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html b/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html new file mode 100644 index 00000000..6bac050a --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html @@ -0,0 +1,452 @@ +<!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 Thu Feb 20 10:19:18 CET 2014 --> +<title>AnalyzeParameters</title> +<meta name="date" content="2014-02-20"> +<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="AnalyzeParameters"; + } +//--> +</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="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> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html" title="interface in at.gv.egiz.pdfas.api.analyze"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html" target="_top">Frames</a></li> +<li><a href="AnalyzeParameters.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </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.api.analyze</div> +<h2 title="Class AnalyzeParameters" class="title">Class AnalyzeParameters</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>at.gv.egiz.pdfas.api.analyze.AnalyzeParameters</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong></div> +<br> +<pre>@Deprecated +public class <span class="strong">AnalyzeParameters</span> +extends java.lang.Object</pre> +<div class="block">Parameter object that holds the analyze parameters.</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>protected <a href="../../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#document">document</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">The document to be analyzed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#hasBeenCorrected">hasBeenCorrected</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#returnNonTextualObjects">returnNonTextualObjects</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#verifyMode">verifyMode</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">The mode of operation how the document is analyzed.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#AnalyzeParameters()">AnalyzeParameters</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </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><a href="../../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#getDocument()">getDocument</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#getVerifyMode()">getVerifyMode</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#isReturnNonTextualObjects()">isReturnNonTextualObjects</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#setDocument(at.gv.egiz.pdfas.api.io.DataSource)">setDocument</a></strong>(<a href="../../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a> document)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#setReturnNonTextualObjects(boolean)">setReturnNonTextualObjects</a></strong>(boolean returnNonTextualObjects)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Tells if non text object of the signed pdf should be extracted and returned.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html#setVerifyMode(java.lang.String)">setVerifyMode</a></strong>(java.lang.String verifyMode)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="document"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>document</h4> +<pre>protected <a href="../../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a> document</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">The document to be analyzed.</div> +</li> +</ul> +<a name="verifyMode"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verifyMode</h4> +<pre>protected java.lang.String verifyMode</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">The mode of operation how the document is analyzed. + + <p> + May be <a href="../../../../../../at/gv/egiz/pdfas/api/commons/Constants.html#VERIFY_MODE_BINARY_ONLY"><code>Constants.VERIFY_MODE_BINARY_ONLY</code></a> to check the document for + binary signatures only (very fast). Or may be + <a href="../../../../../../at/gv/egiz/pdfas/api/commons/Constants.html#VERIFY_MODE_SEMI_CONSERVATIVE"><code>Constants.VERIFY_MODE_SEMI_CONSERVATIVE</code></a> to perform a semi + conservative (optimized) text and binary verification (slow). Or may be + <a href="../../../../../../at/gv/egiz/pdfas/api/commons/Constants.html#VERIFY_MODE_FULL_CONSERVATIVE"><code>Constants.VERIFY_MODE_FULL_CONSERVATIVE</code></a> to perform a full + conservative text and binary verification (very slow). + </p></div> +</li> +</ul> +<a name="returnNonTextualObjects"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>returnNonTextualObjects</h4> +<pre>protected boolean returnNonTextualObjects</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="hasBeenCorrected"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hasBeenCorrected</h4> +<pre>protected boolean hasBeenCorrected</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AnalyzeParameters()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnalyzeParameters</h4> +<pre>public AnalyzeParameters()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDocument()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDocument</h4> +<pre>public <a href="../../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a> getDocument()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the document</dd></dl> +</li> +</ul> +<a name="setDocument(at.gv.egiz.pdfas.api.io.DataSource)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDocument</h4> +<pre>public void setDocument(<a href="../../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a> document)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>document</code> - the document to set</dd></dl> +</li> +</ul> +<a name="getVerifyMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVerifyMode</h4> +<pre>public java.lang.String getVerifyMode()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the verifyMode</dd></dl> +</li> +</ul> +<a name="setVerifyMode(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVerifyMode</h4> +<pre>public void setVerifyMode(java.lang.String verifyMode)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verifyMode</code> - the verifyMode to set</dd></dl> +</li> +</ul> +<a name="isReturnNonTextualObjects()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReturnNonTextualObjects</h4> +<pre>public boolean isReturnNonTextualObjects()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="setReturnNonTextualObjects(boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setReturnNonTextualObjects</h4> +<pre>public void setReturnNonTextualObjects(boolean returnNonTextualObjects)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Tells if non text object of the signed pdf should be extracted and returned. + One should show this to the user, especially in case of textual signature. + Defaults to <tt>false</tt></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>returnNonTextualObjects</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="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> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../at/gv/egiz/pdfas/api/analyze/AnalyzeResult.html" title="interface in at.gv.egiz.pdfas.api.analyze"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?at/gv/egiz/pdfas/api/analyze/AnalyzeParameters.html" target="_top">Frames</a></li> +<li><a href="AnalyzeParameters.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |