diff options
Diffstat (limited to 'docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html')
| -rw-r--r-- | docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html | 379 |
1 files changed, 379 insertions, 0 deletions
diff --git a/docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html b/docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html new file mode 100644 index 00000000..0fb924d4 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html @@ -0,0 +1,379 @@ +<!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:22:00 CET 2014 --> +<title>DynamicSignatureProfile</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="DynamicSignatureProfile"; + } +//--> +</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><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfileImpl.html" title="class in at.gv.egiz.pdfas.api.commons"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" target="_top">Frames</a></li> +<li><a href="DynamicSignatureProfile.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.api.commons</div> +<h2 title="Interface DynamicSignatureProfile" class="title">Interface DynamicSignatureProfile</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfileImpl.html" title="class in at.gv.egiz.pdfas.api.commons">DynamicSignatureProfileImpl</a></dd> +</dl> +<hr> +<div class="block"><strong>Deprecated.</strong></div> +<br> +<pre>@Deprecated +public interface <span class="strong">DynamicSignatureProfile</span></pre> +<div class="block">A dynamic signature profile. It is used to define a signature profile like the ones from pdf-as/config.properties at runtime. + After creation via <a href="../../../../../../at/gv/egiz/pdfas/api/PdfAs.html" title="interface in at.gv.egiz.pdfas.api"><code>PdfAs</code></a> you can set properties via <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#setPropertyRaw(java.lang.String, java.lang.String)"><code>setPropertyRaw(String, String)</code></a> + or <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#setFieldValue(java.lang.String, java.lang.String)"><code>setFieldValue(String, String)</code></a>.<br> + You have to call <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#apply()"><code>apply()</code></a> to use the profile. The identifying name (e.g. for <a href="../../../../../../at/gv/egiz/pdfas/api/sign/SignParameters.html#setSignatureProfileId(java.lang.String)"><code>SignParameters.setSignatureProfileId(String)</code></a> + can be obtained via <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#getName()"><code>getName()</code></a>.<br> + Depending on the <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons"><code>DynamicSignatureLifetimeEnum</code></a> the profile can be alive and usable till you <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#dispose()"><code>dispose()</code></a> it manually. + <p> + Sample usage:<br> + <pre> + SignParameters sp = new SignParameters(); + . . . + sp.setSignatureType(Constants.SIGNATURE_TYPE_TEXTUAL); + sp.setSignatureDevice(Constants.SIGNATURE_DEVICE_MOA); + + // create a new dynamic profile based on SIGNATURBLOCK_DE (every property is copied) with manual lifetime + DynamicSignatureProfile dsp = pdfAs.createDynamicSignatureProfile("myUniqueName", "SIGNATURBLOCK_DE", + DynamicSignatureLifetimeEnum.MANUAL); + + // set something + dsp.setPropertyRaw("key.SIG_META", "Statement"); + dsp.setPropertyRaw("value.SIG_META", "respect to the man in the icecream van ${subject.EMAIL}"); + dsp.setPropertyRaw("value.SIG_LABEL", "./images/signatur-logo_en.png"); + dsp.setPropertyRaw("table.main.Style.halign", "right"); + + // mandatory: apply the profile, you have to apply again after changes (overriding your previous setting) + dsp.apply(); + sp.setSignatureProfileId(dsp.getName()); + + // execute PDF-AS + pdfAs.sign(sp); + + . . . + + // your profile is saved and you can obtain it again anytime later: + dsp = pdfAs.loadDynamicSignatureProfile("myUniqueName"); + // use it for another sign. + // dont forget to dispose() sometimes because it was manual lifetime + System.out.println(dsp.getName()); + </pre> + </p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#apply()">apply</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Apply the signature profile.</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/commons/DynamicSignatureProfile.html#dispose()">dispose</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Disposes the signature profile from the global store.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#getFieldValue(java.lang.String)">getFieldValue</a></strong>(java.lang.String fieldName)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Get a field value from the profile.</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/commons/DynamicSignatureProfile.html#getName()">getName</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Get the name of the dynamic signature profile.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#getPropertyRaw(java.lang.String)">getPropertyRaw</a></strong>(java.lang.String key)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Get any property from the signature profile.</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/commons/DynamicSignatureProfile.html#setFieldValue(java.lang.String, java.lang.String)">setFieldValue</a></strong>(java.lang.String fieldName, + java.lang.String value)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Set a field value for the profile.</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/commons/DynamicSignatureProfile.html#setPropertyRaw(java.lang.String, java.lang.String)">setPropertyRaw</a></strong>(java.lang.String key, + java.lang.String val)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Set any property for the signature profile.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Get the name of the dynamic signature profile. Equals the <b>SignatureProfileId</b></div> +<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl> +</li> +</ul> +<a name="setFieldValue(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFieldValue</h4> +<pre>void setFieldValue(java.lang.String fieldName, + java.lang.String value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Set a field value for the profile. Use <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#setPropertyRaw(java.lang.String, java.lang.String)"><code>setPropertyRaw(String, String)</code></a> for setting any property.<br> + For example to set <code>sig_obj.MEIN_DYN_SIGNATURBLOCK.value.SIG_META</code> just use <code>SIG_META</code> as fieldName.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - the name of the field</dd><dd><code>value</code> - the value to set</dd></dl> +</li> +</ul> +<a name="getFieldValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFieldValue</h4> +<pre>java.lang.String getFieldValue(java.lang.String fieldName)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Get a field value from the profile. See <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#setFieldValue(java.lang.String, java.lang.String)"><code>setFieldValue(String, String)</code></a></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd></dd></dl> +</li> +</ul> +<a name="setPropertyRaw(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyRaw</h4> +<pre>void setPropertyRaw(java.lang.String key, + java.lang.String val)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Set any property for the signature profile. + Uses the same keys as the property file without the "prefix" for the profile. + For example to set <code>sig_obj.MEIN_DYN_SIGNATURBLOCK.key.SIG_META</code> use <code>key.SIG_META</code></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - property key</dd><dd><code>val</code> - property value</dd></dl> +</li> +</ul> +<a name="getPropertyRaw(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyRaw</h4> +<pre>java.lang.String getPropertyRaw(java.lang.String key)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Get any property from the signature profile. See <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#setPropertyRaw(java.lang.String, java.lang.String)"><code>setPropertyRaw(String, String)</code></a> for details.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd></dd></dl> +</li> +</ul> +<a name="apply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>apply</h4> +<pre>void apply()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Apply the signature profile. Call this after all properties are set and you want to use the profile. It is then added + to the globally available signature profiles. Depending on the lifetime model <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons"><code>DynamicSignatureLifetimeEnum</code></a> you + have to <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html#dispose()"><code>dispose()</code></a> it manually when not needed anymore.</div> +</li> +</ul> +<a name="dispose()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>dispose</h4> +<pre>void dispose()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Disposes the signature profile from the global store. Call this for <a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html#MANUAL"><code>DynamicSignatureLifetimeEnum.MANUAL</code></a> only.</div> +</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><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureLifetimeEnum.html" title="class in at.gv.egiz.pdfas.api.commons"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../at/gv/egiz/pdfas/api/commons/DynamicSignatureProfileImpl.html" title="class in at.gv.egiz.pdfas.api.commons"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html" target="_top">Frames</a></li> +<li><a href="DynamicSignatureProfile.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>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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> |