|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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 | |
|---|---|
void |
apply()
Apply the signature profile. |
void |
dispose()
Disposes the signature profile from the global store. |
String |
getFieldValue(String fieldName)
Get a field value from the profile. |
String |
getName()
Get the name of the dynamic signature profile. |
String |
getPropertyRaw(String key)
Get any property from the signature profile. |
void |
setFieldValue(String fieldName,
String value)
Set a field value for the profile. |
void |
setPropertyRaw(String key,
String val)
Set any property for the signature profile. |
| Method Detail |
|---|
String getName()
void setFieldValue(String fieldName,
String value)
setPropertyRaw(String, String) for setting any property.sig_obj.MEIN_DYN_SIGNATURBLOCK.value.SIG_META just use SIG_META as fieldName.
fieldName - the name of the fieldvalue - the value to setString getFieldValue(String fieldName)
setFieldValue(String, String)
fieldName -
void setPropertyRaw(String key,
String val)
sig_obj.MEIN_DYN_SIGNATURBLOCK.key.SIG_META use key.SIG_META
key - property keyval - property valueString getPropertyRaw(String key)
setPropertyRaw(String, String) for details.
key -
void apply()
DynamicSignatureLifetimeEnum you
have to dispose() it manually when not needed anymore.
void dispose()
DynamicSignatureLifetimeEnum.MANUAL only.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||