PDAnnotationRubberStamp (Apache PDFBox 2.0.1 API)

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 and Description
`static String`	`NAME_APPROVED` Constant for the name of a rubber stamp.
`static String`	`NAME_AS_IS` Constant for the name of a rubber stamp.
`static String`	`NAME_CONFIDENTIAL` Constant for the name of a rubber stamp.
`static String`	`NAME_DEPARTMENTAL` Constant for the name of a rubber stamp.
`static String`	`NAME_DRAFT` Constant for the name of a rubber stamp.
`static String`	`NAME_EXPERIMENTAL` Constant for the name of a rubber stamp.
`static String`	`NAME_EXPIRED` Constant for the name of a rubber stamp.
`static String`	`NAME_FINAL` Constant for the name of a rubber stamp.
`static String`	`NAME_FOR_COMMENT` Constant for the name of a rubber stamp.
`static String`	`NAME_FOR_PUBLIC_RELEASE` Constant for the name of a rubber stamp.
`static String`	`NAME_NOT_APPROVED` Constant for the name of a rubber stamp.
`static String`	`NAME_NOT_FOR_PUBLIC_RELEASE` Constant for the name of a rubber stamp.
`static String`	`NAME_SOLD` Constant for the name of a rubber stamp.
`static String`	`NAME_TOP_SECRET` Constant for the name of a rubber stamp.
`static String`	`SUB_TYPE` The type of annotation.

Fields inherited from class org.apache.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 and Description
`PDAnnotationRubberStamp()` Constructor.
`PDAnnotationRubberStamp(COSDictionary field)` Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Methods
Modifier and Type	Method and 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 org.apache.pdfbox.pdmodel.interactive.annotation.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 org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class PDAnnotationRubberStamp

Field Summary

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

Constructor Summary

Method Summary

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

Methods inherited from class java.lang.Object

Field Detail

NAME_APPROVED

NAME_EXPERIMENTAL

NAME_NOT_APPROVED

NAME_AS_IS

NAME_EXPIRED

NAME_NOT_FOR_PUBLIC_RELEASE

NAME_FOR_PUBLIC_RELEASE

NAME_DRAFT

NAME_FOR_COMMENT

NAME_TOP_SECRET

NAME_DEPARTMENTAL

NAME_CONFIDENTIAL

NAME_FINAL

NAME_SOLD

SUB_TYPE

Constructor Detail

PDAnnotationRubberStamp

PDAnnotationRubberStamp

Method Detail

setName

getName