javadoc

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@710 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c

1 files changed, 17 insertions, 1 deletions

diff --git a/src/main/java/at/gv/egiz/pdfas/api/sign/SignParameters.java b/src/main/java/at/gv/egiz/pdfas/api/sign/SignParameters.java
index 9a01c72..8dc928b 100644
--- a/src/main/java/at/gv/egiz/pdfas/api/sign/SignParameters.java
+++ b/src/main/java/at/gv/egiz/pdfas/api/sign/SignParameters.java
@@ -286,7 +286,23 @@ public class SignParameters
   /**

    * Override user defined values from the used signature profile like "value.SIG_META". 

    * You cannot override pre defined values like SIG_VALUE, SIG_DATE {@link SignatureTypes#REQUIRED_SIG_KEYS}. 

-   * The override values are bound to the {@link SignParameters} instance. 

+   * The override values are bound to the {@link SignParameters} instance.

+   * <p>

+   * Sample usage:

+   * <pre>

+      SignParameters sp = new SignParameters();

+      . . .

+      

+      sp.setSignatureProfileId("SIGNATURBLOCK_DE");  

+      

+      // expressions do not work on binary signature fields without phlength setting!!

+      sp.setProfileOverrideValue("SIG_META", "It's nice to be important, but it is more important to be nice ${subject.L}");;

+      sp.setProfileOverrideValue("SIG_LABEL", "./images/signatur-logo_en.png");                  

+      

+      // execute sign using the overrides

+      pdfAs.sign(sp);

+  </pre>

+   * </p>

    * @param key the name of the setting to override e.g. "SIG_META"

    * @param value The new value

    */