Class PDAnnotationRubberStamp

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

org.apache.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

Author:

Paul King

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_APPROVED	Constant for the name of a rubber stamp.
static final String	NAME_AS_IS	Constant for the name of a rubber stamp.
static final String	NAME_CONFIDENTIAL	Constant for the name of a rubber stamp.
static final String	NAME_DEPARTMENTAL	Constant for the name of a rubber stamp.
static final String	NAME_DRAFT	Constant for the name of a rubber stamp.
static final String	NAME_EXPERIMENTAL	Constant for the name of a rubber stamp.
static final String	NAME_EXPIRED	Constant for the name of a rubber stamp.
static final String	NAME_FINAL	Constant for the name of a rubber stamp.
static final String	NAME_FOR_COMMENT	Constant for the name of a rubber stamp.
static final String	NAME_FOR_PUBLIC_RELEASE	Constant for the name of a rubber stamp.
static final String	NAME_NOT_APPROVED	Constant for the name of a rubber stamp.
static final String	NAME_NOT_FOR_PUBLIC_RELEASE	Constant for the name of a rubber stamp.
static final String	NAME_SOLD	Constant for the name of a rubber stamp.
static final String	NAME_TOP_SECRET	Constant for the name of a rubber stamp.
static final String	SUB_TYPE	The type of annotation.

Fields inherited from class PDAnnotationMarkup

RT_GROUP, RT_REPLY

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

Modifier and Type	Method	Description
String	getName()	This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.
void	setName(String name)	This will set the name (and hence appearance, AP taking precedence) For this annotation.

Methods inherited from class PDAnnotationMarkup

getBorderStyle, getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setBorderStyle, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup

Methods inherited from class PDAnnotation

constructAppearances, constructAppearances, createAnnotation, equals, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, getSubtype, hashCode, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setLockedContents, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setOptionalContent, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setSubtype, setToggleNoView

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

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 Details

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 object to represent as a field.

Method Details

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.