Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]
public class

# RubberStamp

extends Markup

java.lang.Object
↳ | com.pdftron.pdf.Annot
| ↳ | com.pdftron.pdf.annots.Markup
|  | ↳ | com.pdftron.pdf.annots.RubberStamp

## Class Overview

A rubber stamp annotation (PDF 1.3) displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. When opened, it shall display a pop-up window containing the text of the associated note. Table 181 shows the annotation dictionary entries specific to this type of annotation.

## Summary

Constants
int | e_Approved | This integer list represents the Icon type of the RubberStamp annotation e_Approved - a stamp with the text "Approved" e_Experimental - a stamp with the text "Experimental" e_NotApproved - a stamp with the text "NotApproved" e_AsIs, - a stamp with the text "AsIs" e_Expired - a stamp with the text "Expired" e_NotForPublicRelease - a stamp with the text "NotForPublicRelease" e_Confidential - a stamp with the text "Confidential" e_Final - a stamp with the text "Final" e_Sold - a stamp with the text "Sold" e_Departmental - a stamp with the text "Departmental" e_ForComment - a stamp with the text "ForComment" e_TopSecret - a stamp with the text "TopScret" e_ForPublicRelease - a stamp with the text "ForPublicRelease" e_Draft - a stamp with the text "Draft" e_Unknown - User defined or invalid.
int | e_AsIs | The Constant e_AsIs.
int | e_Confidential | The Constant e_Confidential.
int | e_Departmental | The Constant e_Departmental.
int | e_Draft | The Constant e_Draft.
int | e_Experimental | The Constant e_Experimental.
int | e_Expired | The Constant e_Expired.
int | e_Final | The Constant e_Final.
int | e_ForComment | The Constant e_ForComment.
int | e_ForPublicRelease | The Constant e_ForPublicRelease.
int | e_NotApproved | The Constant e_NotApproved.
int | e_NotForPublicRelease | The Constant e_NotForPublicRelease.
int | e_Sold | The Constant e_Sold.
int | e_TopSecret | The Constant e_TopSecret.
int | e_Unknown | The Constant e_Unknown.

[Expand] Inherited Constants
From class com.pdftron.pdf.annots.Markup
int | e_Cloudy | The Constant e_Cloudy.
int | e_None | This integer list represents the Border Effect of the Markup annotation e_None - No effect e_Cloudy - The border should appear "cloudy".
From class com.pdftron.pdf.Annot
int | e_3D | The Constant e_3D.
int | e_Caret | The Constant e_Caret.
int | e_Circle | The Constant e_Circle.
int | e_FileAttachment | The Constant e_FileAttachment.
int | e_FreeText | The Constant e_FreeText.
int | e_Highlight | The Constant e_Highlight.
int | e_Ink | The Constant e_Ink.
int | e_Line | The Constant e_Line.
int | e_Link | The Constant e_Link.
int | e_Movie | The Constant e_Movie.
int | e_Polygon | The Constant e_Polygon.
int | e_Polyline | The Constant e_Polyline.
int | e_Popup | The Constant e_Popup.
int | e_PrinterMark | The Constant e_PrinterMark.
int | e_Projection | The Constant e_Projection.
int | e_Redact | The Constant e_Redact.
int | e_RichMedia | The Constant e_RichMedia.
int | e_Screen | The Constant e_Screen.
int | e_Sound | The Constant e_Sound.
int | e_Square | The Constant e_Square.
int | e_Squiggly | The Constant e_Squiggly.
int | e_Stamp | The Constant e_Stamp.
int | e_StrikeOut | The Constant e_StrikeOut.
int | e_Text | PDF supports the standard annotation types listed in the following enumeration (plug-in extensions may add new annotation types):.
int | e_TrapNet | The Constant e_TrapNet.
int | e_Underline | The Constant e_Underline.
int | e_Unknown | The Constant e_Unknown.
int | e_Watermark | The Constant e_Watermark.
int | e_Widget | The Constant e_Widget.
int | e_action_trigger_activate | Triggered when the annotation is activated.
int | e_action_trigger_annot_blur | Triggered when the annotation loses the input focus
int | e_action_trigger_annot_down | Triggered when the mouse button is pressed inside the annotation's active area
int | e_action_trigger_annot_enter | Triggered when the cursor enters the annotation's active area
int | e_action_trigger_annot_exit | Triggered when the cursor exits the annotation's active area
int | e_action_trigger_annot_focus | Triggered when the annotation receives the input focus
int | e_action_trigger_annot_page_close | Triggered when the page containing the annotation is closed
int | e_action_trigger_annot_page_invisible | Triggered when the page containing the annotation is no longer visible in the interactive PDF processor's user interface
int | e_action_trigger_annot_page_open | Triggered when the page containing the annotation is opened
int | e_action_trigger_annot_page_visible | Triggered when the page containing the annotation becomes visible
int | e_action_trigger_annot_up | Triggered when the mouse button is released inside the annotation's active area
int | e_down | The Constant e_down.
int | e_hidden | The Constant e_hidden.
int | e_invisible | Flags specifying various characteristics of the annotation.
int | e_locked | The Constant e_locked.
int | e_locked_contents | The Constant e_locked_contents.
int | e_no_rotate | The Constant e_no_rotate.
int | e_no_view | The Constant e_no_view.
int | e_no_zoom | The Constant e_no_zoom.
int | e_normal | An annotation can define as many as three separate appearances: The normal appearance is used when the annotation is not interacting with the user.
int | e_print | The Constant e_print.
int | e_read_only | The Constant e_read_only.
int | e_rollover | The Constant e_rollover.
int | e_toggle_no_view | The Constant e_toggle_no_view.

Public Constructors
| RubberStamp(Obj d) Creates a RubberStamp annotation and initialize it using given Cos/SDF object.
| RubberStamp() Creates an empty RubberStamp annotation.
| RubberStamp(Annot annot) Creates a RubberStamp annotation and initialize it using given annotation object.

Public Methods
void | SetIcon(int type) Set the Icon type as an entry of the enum "Icon".
void | SetOpacity(double opacity) Updates the appearance of the stamp with the given opacity value Opacity value does not accumulate in case of subsequent calls - i.e.
static RubberStamp | create(Doc doc, Rect pos) Creates a new RubberStamp annotation, in the specified document.
static RubberStamp | createCustom(Doc doc, Rect pos, Obj in_options) Creates a new RubberStamp annotation with custom options, in the specified document.
int | getIcon() Get the Icon type as an entry of the enum "Icon".
String | getIconName() Get the Icon type as a string.
void | setIcon(String icon) Set the Icon type as a string.

[Expand] Inherited Methods
From class com.pdftron.pdf.annots.Markup
int | getBorderEffect() Gets the Border Effect of the Markup Annotation.
double | getBorderEffectIntensity() Gets the Border Effect Intensity of the Markup Annotation.
Rect | getContentRect() Gets the inner bounding rectangle of the Square.
Date | getCreationDates() Gets the creation date of the Markup Annotation.
ColorPt | getInteriorColor() Gets the interior color of the Square.
int | getInteriorColorCompNum() Gets the number indicating interior color space of the Square.
double | getOpacity() Gets the contant opacity value corresponding to the annotation.
Rect | getPadding() Gets the rectangle difference of the Square.
Popup | getPopup() Gets the Popup object associated with this Markup annotation.
String | getSubject() Gets subject of the Markup Annotation.
String | getTitle() Gets the title of the Markup Annotation.
void | rotateAppearance(double angle) Rotates the appearance of the Markup Annotation.
void | setBorderEffect(int effect) Sets the Border Effect of the Markup Annotation.
void | setBorderEffectIntensity(double intensity) Sets the Border Effect Intensity of the Markup Annotation.
void | setContentRect(Rect cr) Sets the inner bounding rectangle of the Square.
void | setCreationDates(Date date) Sets the creation date of the Markup Annotation.
void | setInteriorColor(ColorPt cpt, int comp_num) Sets the interior color of the Square.
void | setOpacity(double opacity) Sets the contant opacity value corresponding to the annotation.
void | setPadding(double padding) Sets the rectangle difference of the Square.
void | setPadding(Rect rd) Sets the rectangle difference of the Square.
void | setPopup(Popup popup) Sets the Popup object associated with this Markup annotation.
void | setSubject(String title) Sets subject of the Markup Annotation.
void | setTitle(String title) Sets the title of the Markup Annotation.
From class com.pdftron.pdf.Annot
int | GetStructParent() Get the struct parent of an annotation.
static Annot | __Create(long impl, Object ref)
long | __GetHandle()
Object | __GetRefHandle()
static Annot | create(Doc doc, int type, Rect pos) Creates a new annotation of a given type, in the specified document.
void | deleteCustomData(String key) Deletes custom data associated with the given key.
boolean | equals(Object d) Compares two annotations for equality.
void | flatten(Page page) Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page.
String | getActiveAppearanceState() Get the annotation's active appearance state.
Obj | getAppearance(int annot_state, String app_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Obj | getAppearance() Get the annotation's appearance for the given combination of annotation and appearance states.
Obj | getAppearance(int annot_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Annot.BorderStyle | getBorderStyle() Get the border style for the annotation.
ColorPt | getColorAsCMYK() Get an annotation's color.
ColorPt | getColorAsGray() Get an annotation's color.
ColorPt | getColorAsRGB() Get an annotation's color.
int | getColorCompNum() Get the color space the annotation's color is represented in.
String | getContents() Get the annotation contents.
String | getCustomData(String key) Returns custom data associated with the given key.
Date | getDate() Gets an annotation's last modified date.
boolean | getFlag(int flag) Determine if the give flag is marked flagged
Obj | getOptionalContent() Get optional content of an annotation.
Page | getPage() Get the page the annotation is associated with.
Rect | getRect() Get annoation bound rectangle
int | getRotation() Get the rotation value of the annotation.
Obj | getSDFObj() Get the SDFObj.
Obj | getTriggerAction(int trigger) Get the Action associated with the selected Annot Trigger event.
int | getType() Get the annotation type.
Obj | getUniqueID() Get the annotiation unique ID.
Rect | getVisibleContentBox() It is possible during viewing that GetRect does not return the most accurate bounding box of what is actually rendered.
int | hashCode()
boolean | isMarkup() Checks if annoation is markup.
boolean | isValid() Checks if Annot is valid.
void | refreshAppearance() Regenerates the appearance stream for the annotation.
void | refreshAppearance(RefreshOptions opts) A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
void | removeAppearance() Removes the annotation's default appearance.
void | removeAppearance(int annot_state, String app_state) Removes the annotation's appearance for the given combination of annotation and appearance states.
void | resize(Rect pos) Resize annotation
void | setActiveAppearanceState(String astate) Set the annotation's active appearance state.
void | setAppearance(Obj app_stream, int annot_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void | setAppearance(Obj app_stream) Set the annotation's appearance for the given combination of annotation and appearance states.
void | setAppearance(Obj app_stream, int annot_state, String app_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void | setBorderStyle(Annot.BorderStyle bs) Set the border style for the annotation.
void | setColor(ColorPt cpt) Set an annotation's color.
void | setColor(ColorPt cpt, int comp_num) Set an annotation's color.
void | setContents(String ct) Set annotation contents.
void | setCustomData(String key, String value) Sets the custom data associated with the specified key.
void | setDate(Date date) Sets an annotation's last modified date.
void | setDateToNow() Sets an annotation's last modified date to the current time.
void | setFlag(int flag, boolean value) Set the value of given Flag.
void | setOptionalContent(Obj oc) Set optional content of an annotation.
void | setPage(Page page) Set the reference to a page the annotation is associated with.
void | setRect(Rect pos) Set the size and location of an annotation on its page.
void | setRotation(int rot) Set the rotation value of the annotation.
void | setStructParent(int keyval) Set the struct parent of an annotation.
void | setUniqueID(String icon_name) Set the unique identifier for this annotation.
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Constants

#### public static final int e_Approved

This integer list represents the Icon type of the RubberStamp annotation e_Approved - a stamp with the text "Approved" e_Experimental - a stamp with the text "Experimental" e_NotApproved - a stamp with the text "NotApproved" e_AsIs, - a stamp with the text "AsIs" e_Expired - a stamp with the text "Expired" e_NotForPublicRelease - a stamp with the text "NotForPublicRelease" e_Confidential - a stamp with the text "Confidential" e_Final - a stamp with the text "Final" e_Sold - a stamp with the text "Sold" e_Departmental - a stamp with the text "Departmental" e_ForComment - a stamp with the text "ForComment" e_TopSecret - a stamp with the text "TopScret" e_ForPublicRelease - a stamp with the text "ForPublicRelease" e_Draft - a stamp with the text "Draft" e_Unknown - User defined or invalid.

Constant Value: 0 (0x00000000)

#### public static final int e_AsIs

The Constant e_AsIs.

Constant Value: 3 (0x00000003)

#### public static final int e_Confidential

The Constant e_Confidential.

Constant Value: 6 (0x00000006)

#### public static final int e_Departmental

The Constant e_Departmental.

Constant Value: 9 (0x00000009)

#### public static final int e_Draft

The Constant e_Draft.

Constant Value: 13 (0x0000000d)

#### public static final int e_Experimental

The Constant e_Experimental.

Constant Value: 1 (0x00000001)

#### public static final int e_Expired

The Constant e_Expired.

Constant Value: 4 (0x00000004)

#### public static final int e_Final

The Constant e_Final.

Constant Value: 7 (0x00000007)

#### public static final int e_ForComment

The Constant e_ForComment.

Constant Value: 10 (0x0000000a)

#### public static final int e_ForPublicRelease

The Constant e_ForPublicRelease.

Constant Value: 12 (0x0000000c)

#### public static final int e_NotApproved

The Constant e_NotApproved.

Constant Value: 2 (0x00000002)

#### public static final int e_NotForPublicRelease

The Constant e_NotForPublicRelease.

Constant Value: 5 (0x00000005)

#### public static final int e_Sold

The Constant e_Sold.

Constant Value: 8 (0x00000008)

#### public static final int e_TopSecret

The Constant e_TopSecret.

Constant Value: 11 (0x0000000b)

#### public static final int e_Unknown

The Constant e_Unknown.

Constant Value: 14 (0x0000000e)

## Public Constructors

#### public RubberStamp (Obj d)

Creates a RubberStamp annotation and initialize it using given Cos/SDF object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Parameters

d | the input Cos/SDF object

#### public RubberStamp ()

Creates an empty RubberStamp annotation.

#### public RubberStamp (Annot annot)

Creates a RubberStamp annotation and initialize it using given annotation object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

##### Parameters

annot | the input annotation object

##### Throws

PDFNetException |

## Public Methods

#### public void SetIcon (int type)

Set the Icon type as an entry of the enum "Icon".

Note: the icon type represnets an icon that shall be used in displaying the annotation. There are predefined icon appearances for at the following standard names: e_Approved, e_Experimental, e_NotApproved, e_AsIs, e_Expired , e_NotForPublicRelease, e_Confidential, e_Final, e_Sold, e_Departmental, e_ForComment, e_TopSecret, e_Draft, e_ForPublicRelease Additional names may be supported as well. Default value: Draft. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.

##### Parameters

type | An entry of "Icon" that represents the type of icon that is corresponding with this RubberStamp annotation.

##### Throws

PDFNetException |

#### public void SetOpacity (double opacity)

Updates the appearance of the stamp with the given opacity value Opacity value does not accumulate in case of subsequent calls - i.e. last call sets the final opacity

#### public static RubberStamp create (Doc doc, Rect pos)

Creates a new RubberStamp annotation, in the specified document.

##### Parameters

doc | A document to which the annotation is added.
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates.

##### Returns

- A newly created blank RubberStamp annotation.

##### Throws

PDFNetException |

#### public static RubberStamp createCustom (Doc doc, Rect pos, Obj in_options)

Creates a new RubberStamp annotation with custom options, in the specified document.

##### Parameters

doc | A document to which the annotation is added.
pos | A rectangle specifying the annotation's bounds, specified in user space coordinates.
in_options | The input options for creating custom appearance, including TEXT as string (mandatory): The text to be displayed in rubber stamp TEXT_BELOW as string (optional): The text to be displayed below the first text FILL_COLOR as an array of three or four numbers between 0.0 to 1.0 (optional): The fill color TEXT_COLOR as an array of three or four numbers between 0.0 to 1.0 (optional): The text color BORDER_COLOR as an array of three or four numbers between 0.0 to 1.0 (optional): The border color FILL_COLOR_START as an array of three or four numbers between 0.0 to 1.0 (optional): The start fill color if background is gradient FILL_COLOR_END as an array of three or four numbers between 0.0 to 1.0 (optional): The end fill color if background is gradient FILL_OPACITY as a number (optional): the fill opacity TEXT_OPACITY as a number (optional): the text opacity ROTATION as a number (optional): rotation. valid numbers are {0, 90, 180, 270} POINTING_LEFT as a boolean (optional): if the stamp is pointing left POINTING_RIGHT as a boolean (optional): if the stamp is pointing right

##### Returns

- A newly created RubberStamp annotation.

##### Throws

PDFNetException |

#### public int getIcon ()

Get the Icon type as an entry of the enum "Icon".

Note: the icon type represnets an icon that shall be used in displaying the annotation. There are predefined icon appearances for at the following standard names: e_Approved, e_Experimental, e_NotApproved, e_AsIs, e_Expired , e_NotForPublicRelease, e_Confidential, e_Final, e_Sold, e_Departmental, e_ForComment, e_TopSecret, e_Draft, e_ForPublicRelease Additional names may be supported as well. Default value: Draft. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.

##### Returns

- An entry of "Icon" that represents the type of icon that is corresponding with this RubberStamp annotation.

##### Throws

PDFNetException |

#### public String getIconName ()

Get the Icon type as a string.

Note: the icon type represnets an icon that shall be used in displaying the annotation. There are predefined icon appearances for at the following standard names: Approved, Experimental, NotApproved, AsIs, Expired , NotForPublicRelease, Confidential, Final, Sold, Departmental, ForComment, TopSecret, Draft, ForPublicRelease. Additional names may be supported as well. Default value: Draft. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.

##### Returns

- A string representing icon type of the RubberStamp annotation

##### Throws

PDFNetException |

#### public void setIcon (String icon)

Set the Icon type as a string.

Note: the icon type represnets an icon that shall be used in displaying the annotation. There are predefined icon appearances for at the following standard names: Approved, Experimental, NotApproved, AsIs, Expired , NotForPublicRelease, Confidential, Final, Sold, Departmental, ForComment, TopSecret, Draft, ForPublicRelease Additional names may be supported as well. Default value: Draft. The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over this Name entry.

##### Parameters

icon | A string representing icon type of the RubberStamp annotation

##### Throws

PDFNetException |