de.intarsys.pdf.pd
Class PDAFSignatureField

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDAcroFormNode
              de.intarsys.pdf.pd.PDAcroFormField
                  de.intarsys.pdf.pd.PDAFSignatureField

All Implemented Interfaces:

ICOSObjectListener, IAdditionalActionSupport, de.intarsys.tools.attribute.IAttributeSupport

public class PDAFSignatureField
extends PDAcroFormField

A logical signature field within an AcroForm.

Nested Class Summary

static class

PDAFSignatureField.MetaClass

Field Summary

static COSName	DK_Lock
static COSName	DK_SV
static PDAFSignatureField.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDAcroFormField

ACROFORMFIELD_ACTION_TRIGGERS, ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, CN_FT_Btn, CN_FT_Ch, CN_FT_Sig, CN_FT_Tx, DK_DS, DK_DV, DK_Ff, DK_FT, DK_Kids, DK_MaxLen, DK_Parent, DK_RV, DK_T, DK_TM, DK_TU, DK_V

Fields inherited from class de.intarsys.pdf.pd.PDAcroFormNode

DK_DA, DK_DR, DK_Encoding, DK_Font, DK_Q

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Fields inherited from interface de.intarsys.pdf.pd.IAdditionalActionSupport

DK_AA

Method Summary

void	clearSignature()
COSName	cosGetExpectedFieldType() The AcroForm field type expected for this.
COSObject	cosSetValue(COSObject newValue) Sets the /V entry in this node and removes all /V entries in child nodes.
PDSignatureLock	getLock()
PDSignatureSeedValue	getSeedValue()
PDSignature	getSignature() The associated PDSignature if available.
void	invalidateCaches() Invalidate all local caches as the base object may have changed.
boolean	isSigned() true if this field is already signed.
boolean	isTypeSig() Return true if this is a field of type "Sig".
void	setLock(PDSignatureLock lock)
void	setSeedValue(PDSignatureSeedValue value)
void	setSignature(PDSignature newSignature) Assign a new signature value.

Methods inherited from class de.intarsys.pdf.pd.PDAcroFormField

addAnnotation, addField, basicGetFieldFlags, basicSetFieldFlags, copy, cosGetDefaultValue, cosGetFieldType, cosGetValue, dispose, getAcroForm, getAdditionalActions, getAlternateFieldName, getAnyAnnotation, getDefaultValueString, getFieldFlags, getGenericChildren, getGenericParent, getKids, getLocalName, getLocalName, getLogicalParent, getLogicalRoot, getMaxLen, getParent, getQualifiedName, getQualifiedName, getSupportedTriggerEvents, getValueString, isAlignmentCenter, isAlignmentLeft, isAlignmentRight, isAnnotation, isComb, isDoNotScroll, isMultiline, isNoExport, isReadOnly, isTypeBtn, isTypeCh, isTypeTx, removeField, reset, setAdditionalActions, setAlignmentCenter, setAlignmentLeft, setAlignmentRight, setAlternateFieldName, setComb, setDefaultValue, setDoNotScroll, setLocalName, setMaxLength, setMultiline, setNoExport, setReadOnly, setValueString, setValueStrings, toString

Methods inherited from class de.intarsys.pdf.pd.PDAcroFormNode

canonicalize, collectLeafFields, getAnnotation, getAnnotations, getDefaultAppearanceContent, getDefaultAppearanceFont, getDefaultAppearanceFontColor, getDefaultAppearanceFontName, getDefaultAppearanceFontSize, getField, getField, getQuadding, setDefaultAppearanceContent, setDefaultAppearanceFont, setDefaultAppearanceFontColor, setDefaultAppearanceFontSize, setQuadding

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, setGenericParent

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DK_Lock

public static final COSName DK_Lock

DK_SV

public static final COSName DK_SV

META

public static final PDAFSignatureField.MetaClass META

The meta class instance

Method Detail

clearSignature

public void clearSignature()

cosGetExpectedFieldType

public COSName cosGetExpectedFieldType()

Description copied from class: PDAcroFormField

The AcroForm field type expected for this.

Specified by:

cosGetExpectedFieldType in class PDAcroFormField

Returns:

The AcroForm field type expected for this.

cosSetValue

public COSObject cosSetValue(COSObject newValue)

Description copied from class: PDAcroFormField

Sets the /V entry in this node and removes all /V entries in child nodes.

Overrides:

cosSetValue in class PDAcroFormField

Returns:

The /V entry previously associated with this.

getLock

public PDSignatureLock getLock()

getSeedValue

public PDSignatureSeedValue getSeedValue()

getSignature

public PDSignature getSignature()

The associated PDSignature if available.

Returns:

The associated PDSignature if available.

invalidateCaches

public void invalidateCaches()

Description copied from class: COSBasedObject

Invalidate all local caches as the base object may have changed.

Overrides:

invalidateCaches in class PDAcroFormField

isSigned

public boolean isSigned()

true if this field is already signed.

Returns:

true if this field is already signed.

isTypeSig

public boolean isTypeSig()

Description copied from class: PDAcroFormField

Return true if this is a field of type "Sig".

"Sig" means this is a text style object.

Overrides:

isTypeSig in class PDAcroFormField

Returns:

Return true if this is a field of type "Sig".

setLock

public void setLock(PDSignatureLock lock)

setSeedValue

public void setSeedValue(PDSignatureSeedValue value)

setSignature

public void setSignature(PDSignature newSignature)

Assign a new signature value.

Parameters:

newSignature - The new signature value.