RubberStamp (Qoppa jPDFViewer API)

All Superinterfaces:

Annotation
```
public interface RubberStamp
extends Annotation
```
Interface representing a Rubber Stamp annotation in a PDF document.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPROVED`
`static String`	`ASIS`
`static String`	`COMPLETED`
`static String`	`CONFIDENTIAL`
`static String`	`DEPARTMENTAL`
`static String`	`DRAFT`
`static String`	`EXPERIMENTAL`
`static String`	`EXPIRED`
`static String`	`FINAL`
`static String`	`FORCOMMENT`
`static String`	`FORPUBLICRELEASE`
`static String`	`INFORMATIONONLY`
`static int`	`JUSTIFY_CENTER` Justification of stamp text - center
`static int`	`JUSTIFY_LEFT` Justification of stamp text - left
`static int`	`JUSTIFY_RIGHT` Justification of stamp text - right
`static String`	`NOTAPPROVED`
`static String`	`NOTFORPUBLICRELEASE`
`static String`	`PRELIMINARYRESULTS`
`static String`	`SOLD`
`static String`	`TOPSECRET`
`static String`	`VOID`

Fields inherited from interface com.qoppa.pdf.annotations.Annotation
BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Image`	`createImage(double scale, int maxWidth, int maxHeight)` Return an image for the current stamp.
`String`	`getContents()` Returns the annotation's text content.
`Date`	`getCreationDate()` Returns the date and time when the annotation was created.
`float`	`getFontSize()` Gets the font size of the text of the stamp.
`String`	`getIconName()` If this stamp was created using a default predefined stamp, returns the stamp's predefined name.
`int`	`getJustification()` Returns the text justification property for this stamp.
`int`	`getRotation()` Gets the rotation.
`int`	`getTextStyle()` Gets the style of the text of this stamp, i.e.
`boolean`	`isDropShadow()` Returns true if the stamp is set to have a shadow behind the text.
`boolean`	`isShowBorder()` Returns true if the stamp is set to have a border around the text.
`void`	`setContents(String contents)` Sets the annotation's text content.
`void`	`setDropShadow(boolean dropShadow)` Set whether a text stamp should have a shadow behind the text.
`void`	`setFontSize(float textSize)` Sets the font size of the text of the stamp * @param textSize size for the text of the stamp
`void`	`setIconName(String iconName)` Sets the name of the predefined stamp from the PDF format specs.
`void`	`setJustification(int justify)` Sets the text justification for this stamp.
`void`	`setRotation(int rotation)` Sets the rotation of the stamp on the page in degrees such as 45, 90, etc...
`void`	`setRunInfo(Hashtable<String,Object> runInfo)` Sets information used for stamps that have dynamic fields, such as the current date and time.
`void`	`setShowBorder(boolean showBorder)` Set whether a text stamp should have a border around the text.
`void`	`setTextStyle(int textStyle)` Sets the text style of the stamp.

Methods inherited from interface com.qoppa.pdf.annotations.Annotation
getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

- Field Detail
  - ASIS
```
static final String ASIS
```
    See Also:
    
    Constant Field Values
  - APPROVED
```
static final String APPROVED
```
    See Also:
    
    Constant Field Values
  - CONFIDENTIAL
```
static final String CONFIDENTIAL
```
    See Also:
    
    Constant Field Values
  - DEPARTMENTAL
```
static final String DEPARTMENTAL
```
    See Also:
    
    Constant Field Values
  - DRAFT
```
static final String DRAFT
```
    See Also:
    
    Constant Field Values
  - EXPERIMENTAL
```
static final String EXPERIMENTAL
```
    See Also:
    
    Constant Field Values
  - EXPIRED
```
static final String EXPIRED
```
    See Also:
    
    Constant Field Values
  - FINAL
```
static final String FINAL
```
    See Also:
    
    Constant Field Values
  - FORCOMMENT
```
static final String FORCOMMENT
```
    See Also:
    
    Constant Field Values
  - FORPUBLICRELEASE
```
static final String FORPUBLICRELEASE
```
    See Also:
    
    Constant Field Values
  - NOTAPPROVED
```
static final String NOTAPPROVED
```
    See Also:
    
    Constant Field Values
  - NOTFORPUBLICRELEASE
```
static final String NOTFORPUBLICRELEASE
```
    See Also:
    
    Constant Field Values
  - SOLD
```
static final String SOLD
```
    See Also:
    
    Constant Field Values
  - TOPSECRET
```
static final String TOPSECRET
```
    See Also:
    
    Constant Field Values
  - INFORMATIONONLY
```
static final String INFORMATIONONLY
```
    See Also:
    
    Constant Field Values
  - PRELIMINARYRESULTS
```
static final String PRELIMINARYRESULTS
```
    See Also:
    
    Constant Field Values
  - VOID
```
static final String VOID
```
    See Also:
    
    Constant Field Values
  - COMPLETED
```
static final String COMPLETED
```
    See Also:
    
    Constant Field Values
  - JUSTIFY_LEFT
```
static final int JUSTIFY_LEFT
```
    Justification of stamp text - left
    
    See Also:
    
    Constant Field Values
  - JUSTIFY_CENTER
```
static final int JUSTIFY_CENTER
```
    Justification of stamp text - center
    
    See Also:
    
    Constant Field Values
  - JUSTIFY_RIGHT
```
static final int JUSTIFY_RIGHT
```
    Justification of stamp text - right
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setRunInfo
```
void setRunInfo(Hashtable<String,Object> runInfo)
```
    Sets information used for stamps that have dynamic fields, such as the current date and time.
    
    Parameters:
    
    runInfo -
  - createImage
```
Image createImage(double scale,
                  int maxWidth,
                  int maxHeight)
```
    Return an image for the current stamp. If width and height are set to 0, the default stamp width and height are used. If width and height are > 0, the image is scaled to fit in (maxWidth, maxWeight) while preserving the original ratio width / height
    
    Parameters:
    
    scale - The desired scale for the image.
    
    maxWidth - Maximum width desired for the image. If the natural image is larger than this, the image will be rescaled.
    
    maxHeight - Maximum height desired for the image. If the natural image is larger than this, the image will be rescaled.
    
    Returns:
    
    An Image object of the current stamp.
  - getIconName
```
String getIconName()
```
    If this stamp was created using a default predefined stamp, returns the stamp's predefined name.
    
    Returns:
    
    The stamp's predefined name.
  - getContents
```
String getContents()
```
    Returns the annotation's text content.
    
    Specified by:
    
    getContents in interface Annotation
    
    Returns:
    
    The annotation's content.
  - setContents
```
void setContents(String contents)
```
    Sets the annotation's text content.
    
    Parameters:
    
    contents - The new content.
  - setIconName
```
void setIconName(String iconName)
```
    Sets the name of the predefined stamp from the PDF format specs. The allowed values are "Approved", "Experimental", "NotApproved", "AsIs", "Expired", "NotForPublicRelease", "Confidential", "Final", "Sold", "Departmental", "ForComment", "TopSecret", "Draft", "ForPublicRelease". Note that some PDF viewers may use icon names different from the ones defined in the PDF Spec, for example "SBApproved".
    
    Parameters:
    
    iconName - The predefined name.
  - getRotation
```
int getRotation()
```
    Gets the rotation.
    
    Returns:
    
    rotation.
  - setRotation
```
void setRotation(int rotation)
```
    Sets the rotation of the stamp on the page in degrees such as 45, 90, etc... * @param rotation the rotation in degrees.
  - getCreationDate
```
Date getCreationDate()
```
    Returns the date and time when the annotation was created. Milliseconds are always zero since the PDF date format doesn't support milliseconds.
    
    Returns:
    
    The date and time when the annotation was created.
  - getJustification
```
int getJustification()
```
    Returns the text justification property for this stamp. The possible return values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT
    
    Returns:
    
    The value of the text justification property.
  - setJustification
```
void setJustification(int justify)
```
    Sets the text justification for this stamp. The possible values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT
    
    Parameters:
    
    justify - The new value for the text justification
  - isDropShadow
```
boolean isDropShadow()
```
    Returns true if the stamp is set to have a shadow behind the text.
    
    Returns:
    
    true if the stamp is set to have a shadow behind the text.
  - setDropShadow
```
void setDropShadow(boolean dropShadow)
```
    Set whether a text stamp should have a shadow behind the text.
    
    Parameters:
    
    dropShadow - whether or not to have a shadow behind text
  - isShowBorder
```
boolean isShowBorder()
```
    Returns true if the stamp is set to have a border around the text.
    
    Returns:
    
    true if the stamp is set to have a border around the text.
  - setShowBorder
```
void setShowBorder(boolean showBorder)
```
    Set whether a text stamp should have a border around the text.
    
    Parameters:
    
    showBorder - whether or not to have a border around text
  - getTextStyle
```
int getTextStyle()
```
    Gets the style of the text of this stamp, i.e. Font.BOLD or Font.ITALIC
    
    Returns:
    
    textstyle
    
    See Also:
    
    Font
  - setTextStyle
```
void setTextStyle(int textStyle)
```
    Sets the text style of the stamp. Possible values are Font.BOLD or Font.ITALIC or (Font.BOLD | Font.ITALIC) for example.
    
    Parameters:
    
    textStyle - the style of the text
    
    See Also:
    
    Font
  - getFontSize
```
float getFontSize()
```
    Gets the font size of the text of the stamp.
    
    Returns:
    
    textSize.
  - setFontSize
```
void setFontSize(float textSize)
```
    Sets the font size of the text of the stamp * @param textSize size for the text of the stamp

Interface RubberStamp

Field Summary

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

Method Summary

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

Field Detail

ASIS

APPROVED

CONFIDENTIAL

DEPARTMENTAL

DRAFT

EXPERIMENTAL

EXPIRED

FINAL

FORCOMMENT

FORPUBLICRELEASE

NOTAPPROVED

NOTFORPUBLICRELEASE

SOLD

TOPSECRET

INFORMATIONONLY

PRELIMINARYRESULTS

VOID

COMPLETED

JUSTIFY_LEFT

JUSTIFY_CENTER

JUSTIFY_RIGHT

Method Detail

setRunInfo

createImage

getIconName

getContents

setContents

setIconName

getRotation

setRotation

getCreationDate

getJustification

setJustification

isDropShadow

setDropShadow

isShowBorder

setShowBorder

getTextStyle

setTextStyle

getFontSize

setFontSize