org.apache.pdfbox.pdmodel.interactive.annotation: public class: PDAnnotationRubberStamp

org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationRubberStamp [javadoc | source]

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

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

author: Paul - King

version: $ - Revision: 1.2 $

Field Summary
public static final String	NAME_APPROVED	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_NOT_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_EXPIRED	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_FOR_PUBLIC_RELEASE	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_FOR_COMMENT	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	NAME_DEPARTMENTAL	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_FINAL	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	SUB_TYPE	The type of annotation.

Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
RT_REPLY, RT_GROUP

Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
FLAG_INVISIBLE, FLAG_HIDDEN, FLAG_PRINTED, FLAG_NO_ZOOM, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_READ_ONLY, FLAG_LOCKED, FLAG_TOGGLE_NO_VIEW

Constructor:

Constructor:
public PDAnnotationRubberStamp() { super(); getDictionary().setItem( COSName.SUBTYPE, COSName.getPDFName( SUB_TYPE ) ); } Constructor.
public PDAnnotationRubberStamp(COSDictionary field) { super( 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.

 public PDAnnotationRubberStamp() {
        super();
        getDictionary().setItem( COSName.SUBTYPE, COSName.getPDFName( SUB_TYPE ) );
}

Constructor.

 public PDAnnotationRubberStamp(COSDictionary field) {
        super( 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 from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp Summary:
getName, setName

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

Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getPage, getRectangle, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView

Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:

createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getPage, getRectangle, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView

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

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp Detail:
public String getName() { return getDictionary().getNameAsString(COSName.NAME, NAME_DRAFT); } This will retrieve the name (and hence appearance, AP taking precedence) For this annotation. The default is DRAFT.
public void setName(String name) { getDictionary().setName(COSName.NAME, name); } This will set the name (and hence appearance, AP taking precedence) For this annotation. See the NAME_XXX constants for valid values.

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp Detail:

 public String getName() {
        return getDictionary().getNameAsString(COSName.NAME, NAME_DRAFT);
}

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

 public  void setName(String name) {
        getDictionary().setName(COSName.NAME, name);
}

This will set the name (and hence appearance, AP taking precedence) For this annotation. See the NAME_XXX constants for valid values.