Class PDAnnotationRubberStamp
- java.lang.Object
-
- com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
- com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
- com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
-
- All Implemented Interfaces:
COSObjectable
public class PDAnnotationRubberStamp extends PDAnnotationMarkup
This is the class that represents a rubber stamp annotation. Introduced in PDF 1.3 specification
-
-
Field Summary
Fields Modifier and Type Field Description static StringNAME_APPROVEDConstant for the name of a rubber stamp.static StringNAME_AS_ISConstant for the name of a rubber stamp.static StringNAME_CONFIDENTIALConstant for the name of a rubber stamp.static StringNAME_DEPARTMENTALConstant for the name of a rubber stamp.static StringNAME_DRAFTConstant for the name of a rubber stamp.static StringNAME_EXPERIMENTALConstant for the name of a rubber stamp.static StringNAME_EXPIREDConstant for the name of a rubber stamp.static StringNAME_FINALConstant for the name of a rubber stamp.static StringNAME_FOR_COMMENTConstant for the name of a rubber stamp.static StringNAME_FOR_PUBLIC_RELEASEConstant for the name of a rubber stamp.static StringNAME_NOT_APPROVEDConstant for the name of a rubber stamp.static StringNAME_NOT_FOR_PUBLIC_RELEASEConstant for the name of a rubber stamp.static StringNAME_SOLDConstant for the name of a rubber stamp.static StringNAME_TOP_SECRETConstant for the name of a rubber stamp.static StringSUB_TYPEThe type of annotation.-
Fields inherited from class com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
-
-
Constructor Summary
Constructors Constructor Description PDAnnotationRubberStamp()Constructor.PDAnnotationRubberStamp(COSDictionary field)Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetName()This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.voidsetName(String name)This will set the name (and hence appearance, AP taking precedence) For this annotation.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from class com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotation
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
-
Methods inherited from class com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup
-
-
-
-
Field Detail
-
NAME_APPROVED
public static final String NAME_APPROVED
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_EXPERIMENTAL
public static final String NAME_EXPERIMENTAL
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_NOT_APPROVED
public static final String NAME_NOT_APPROVED
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_AS_IS
public static final String NAME_AS_IS
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_EXPIRED
public static final String NAME_EXPIRED
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_NOT_FOR_PUBLIC_RELEASE
public static final String NAME_NOT_FOR_PUBLIC_RELEASE
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_FOR_PUBLIC_RELEASE
public static final String NAME_FOR_PUBLIC_RELEASE
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_DRAFT
public static final String NAME_DRAFT
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_FOR_COMMENT
public static final String NAME_FOR_COMMENT
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_TOP_SECRET
public static final String NAME_TOP_SECRET
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_DEPARTMENTAL
public static final String NAME_DEPARTMENTAL
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_CONFIDENTIAL
public static final String NAME_CONFIDENTIAL
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_FINAL
public static final String NAME_FINAL
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
NAME_SOLD
public static final String NAME_SOLD
Constant for the name of a rubber stamp.- See Also:
- Constant Field Values
-
SUB_TYPE
public static final String SUB_TYPE
The type of annotation.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDAnnotationRubberStamp
public PDAnnotationRubberStamp()
Constructor.
-
PDAnnotationRubberStamp
public PDAnnotationRubberStamp(COSDictionary field)
Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.- Parameters:
field- the PDF objet to represent as a field.
-
-
Method Detail
-
setName
public void setName(String name)
This will set the name (and hence appearance, AP taking precedence) For this annotation. See the NAME_XXX constants for valid values.- Parameters:
name- The name of the rubber stamp.
-
getName
public String getName()
This will retrieve the name (and hence appearance, AP taking precedence) For this annotation. The default is DRAFT.- Returns:
- The name of this rubber stamp, see the NAME_XXX constants.
-
-