Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.annotation

public Class PDAnnotationRubberStamp

extends PDAnnotationMarkup
Class Inheritance
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName

This is the class that represents a rubber stamp annotation. Introduced in PDF 1.3 specification
Author
Paul King

Field Summary

Modifier and TypeField and Description
public static final String
NAME_APPROVED

Constant for the name of a rubber stamp.

public static final String
NAME_AS_IS

Constant for the name of a rubber stamp.

public static final String
NAME_CONFIDENTIAL

Constant for the name of a rubber stamp.

public static final String
NAME_DEPARTMENTAL

Constant for the name of a rubber stamp.

public static final String
NAME_DRAFT

Constant for the name of a rubber stamp.

public static final String
NAME_EXPERIMENTAL

Constant for the name of a rubber stamp.

public static final String
NAME_EXPIRED

Constant for the name of a rubber stamp.

public static final String
NAME_FINAL

Constant for the name of a rubber stamp.

public static final String
NAME_FOR_COMMENT

Constant for the name of a rubber stamp.

public static final String
NAME_FOR_PUBLIC_RELEASE

Constant for the name of a rubber stamp.

public static final String
NAME_NOT_APPROVED

Constant for the name of a rubber stamp.

public static final String
NAME_NOT_FOR_PUBLIC_RELEASE

Constant for the name of a rubber stamp.

public static final String
NAME_SOLD

Constant for the name of a rubber stamp.

public static final String
NAME_TOP_SECRET

Constant for the name of a rubber stamp.

public static final String
SUB_TYPE

The type of annotation.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
RT_GROUPRT_REPLY

Constructor Summary

AccessConstructor and Description
public
public
PDAnnotationRubberStamp(COSDictionary
the PDF object to represent as a field.
field
)

Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The name of this rubber stamp, see the NAME_XXX constants.
getName
()

This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.

public void
setName(String
The name of the rubber stamp.
name
)

This will set the name (and hence appearance, AP taking precedence) For this annotation.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
getBorderStylegetConstantOpacitygetCreationDategetExternalDatagetInReplyTogetIntentgetPopupgetReplyTypegetRichContentsgetSubjectgetTitlePopupsetBorderStylesetConstantOpacitysetCreationDatesetExternalDatasetInReplyTosetIntentsetPopupsetReplyTypesetRichContentssetSubjectsetTitlePopup

Field Detail

NAME_APPROVEDback to summary
public static final String NAME_APPROVED

Constant for the name of a rubber stamp.

NAME_AS_ISback to summary
public static final String NAME_AS_IS

Constant for the name of a rubber stamp.

NAME_CONFIDENTIALback to summary
public static final String NAME_CONFIDENTIAL

Constant for the name of a rubber stamp.

NAME_DEPARTMENTALback to summary
public static final String NAME_DEPARTMENTAL

Constant for the name of a rubber stamp.

NAME_DRAFTback to summary
public static final String NAME_DRAFT

Constant for the name of a rubber stamp.

NAME_EXPERIMENTALback to summary
public static final String NAME_EXPERIMENTAL

Constant for the name of a rubber stamp.

NAME_EXPIREDback to summary
public static final String NAME_EXPIRED

Constant for the name of a rubber stamp.

NAME_FINALback to summary
public static final String NAME_FINAL

Constant for the name of a rubber stamp.

NAME_FOR_COMMENTback to summary
public static final String NAME_FOR_COMMENT

Constant for the name of a rubber stamp.

NAME_FOR_PUBLIC_RELEASEback to summary
public static final String NAME_FOR_PUBLIC_RELEASE

Constant for the name of a rubber stamp.

NAME_NOT_APPROVEDback to summary
public static final String NAME_NOT_APPROVED

Constant for the name of a rubber stamp.

NAME_NOT_FOR_PUBLIC_RELEASEback to summary
public static final String NAME_NOT_FOR_PUBLIC_RELEASE

Constant for the name of a rubber stamp.

NAME_SOLDback to summary
public static final String NAME_SOLD

Constant for the name of a rubber stamp.

NAME_TOP_SECRETback to summary
public static final String NAME_TOP_SECRET

Constant for the name of a rubber stamp.

SUB_TYPEback to summary
public static final String SUB_TYPE

The type of annotation.

Constructor Detail

PDAnnotationRubberStampback to summary
public PDAnnotationRubberStamp()

Constructor.

PDAnnotationRubberStampback to summary
public PDAnnotationRubberStamp(COSDictionary field)

Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.

Parameters
field:COSDictionary

the PDF object to represent as a field.

Method Detail

getNameback to summary
public String getName()

This will retrieve the name (and hence appearance, AP taking precedence) For this annotation. The default is DRAFT.

Returns:String

The name of this rubber stamp, see the NAME_XXX constants.

setNameback to summary
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:String

The name of the rubber stamp.