From 835256964f3fa64587a0e05b859d012d125be308 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Thu, 20 Feb 2014 10:54:04 +0100 Subject: Documentation update --- .../pdfas/api/commons/DynamicSignatureProfile.html | 379 +++++++++++++++++++++ 1 file changed, 379 insertions(+) create mode 100644 docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html (limited to 'docs/full/at/gv/egiz/pdfas/api/commons/DynamicSignatureProfile.html') 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 @@ + + + + + +DynamicSignatureProfile + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.api.commons
+

Interface DynamicSignatureProfile

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    DynamicSignatureProfileImpl
    +
    +
    +
    Deprecated.
    +
    +
    @Deprecated
+public interface DynamicSignatureProfile
    +
    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 PdfAs you can set properties via setPropertyRaw(String, String) + or setFieldValue(String, String).
    + You have to call apply() to use the profile. The identifying name (e.g. for SignParameters.setSignatureProfileId(String) + can be obtained via getName().
    + Depending on the DynamicSignatureLifetimeEnum the profile can be alive and usable till you dispose() it manually. +

    + Sample usage:
    + 

    +      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());
+
    +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidapply() +
      Deprecated. 
      +
      Apply the signature profile.
      +
      voiddispose() +
      Deprecated. 
      +
      Disposes the signature profile from the global store.
      +
      java.lang.StringgetFieldValue(java.lang.String fieldName) +
      Deprecated. 
      +
      Get a field value from the profile.
      +
      java.lang.StringgetName() +
      Deprecated. 
      +
      Get the name of the dynamic signature profile.
      +
      java.lang.StringgetPropertyRaw(java.lang.String key) +
      Deprecated. 
      +
      Get any property from the signature profile.
      +
      voidsetFieldValue(java.lang.String fieldName, + java.lang.String value) +
      Deprecated. 
      +
      Set a field value for the profile.
      +
      voidsetPropertyRaw(java.lang.String key, + java.lang.String val) +
      Deprecated. 
      +
      Set any property for the signature profile.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Deprecated. 
        +
        Get the name of the dynamic signature profile. Equals the SignatureProfileId
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        setFieldValue

        +
        void setFieldValue(java.lang.String fieldName,
+                 java.lang.String value)
        +
        Deprecated. 
        +
        Set a field value for the profile. Use setPropertyRaw(String, String) for setting any property.
        + For example to set sig_obj.MEIN_DYN_SIGNATURBLOCK.value.SIG_META just use SIG_META as fieldName.
        +
        Parameters:
        fieldName - the name of the field
        value - the value to set
        +
        • +
      + + + +
        +
      • +

        getFieldValue

        +
        java.lang.String getFieldValue(java.lang.String fieldName)
        +
        Deprecated. 
        +
        Get a field value from the profile. See setFieldValue(String, String)
        +
        Parameters:
        fieldName -
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        setPropertyRaw

        +
        void setPropertyRaw(java.lang.String key,
+                  java.lang.String val)
        +
        Deprecated. 
        +
        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 sig_obj.MEIN_DYN_SIGNATURBLOCK.key.SIG_META use key.SIG_META
        +
        Parameters:
        key - property key
        val - property value
        +
        • +
      + + + +
        +
      • +

        getPropertyRaw

        +
        java.lang.String getPropertyRaw(java.lang.String key)
        +
        Deprecated. 
        +
        Get any property from the signature profile. See setPropertyRaw(String, String) for details.
        +
        Parameters:
        key -
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        apply

        +
        void apply()
        +
        Deprecated. 
        +
        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 DynamicSignatureLifetimeEnum you + have to dispose() it manually when not needed anymore.
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + -- cgit v1.2.3