com.compdfkit.core.annotation

Class CPDFStampAnnotation

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.CPDFStampAnnotation

public class CPDFStampAnnotation
extends CPDFAnnotation

A stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. A stamp annotation's appearance can be with an icon or a bitmap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFStampAnnotation.DigitalStamp Digital stamp attribute which includes text content, color and date.
static class	CPDFStampAnnotation.StampType Stamp type.
static class	CPDFStampAnnotation.StandardStamp Standard font enumeration of standard stamp.
static class	CPDFStampAnnotation.TextStamp Text stamp attribute which includes text content, color, date and shape.
static class	CPDFStampAnnotation.TextStampColor Color enumeration of text stamp.
static class	CPDFStampAnnotation.TextStampShape Border style enumeration of text stamp.

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.CPDFAnnotation

CPDFAnnotation.AppearanceType, CPDFAnnotation.Flags, CPDFAnnotation.Type

Field Summary

Fields inherited from class com.compdfkit.core.annotation.CPDFAnnotation

annotPtr, apRotation, pdfPage

Method Summary

Modifier and Type	Method and Description
int[]	getAppearanceByPixel(int width, int height, CPDFAnnotation.AppearanceType type) Gets annotation appearance by pixel with Bitmap.
CPDFStampAnnotation.DigitalStamp	getDigitalStamp() Gets attribute of digital stamp.
java.lang.String	getIconName() Not in use currently
CPDFStampAnnotation.StampType	getStampType() Gets stamp type.
CPDFStampAnnotation.StandardStamp	getStandardStamp() Gets standard stamp type.
CPDFStampAnnotation.TextStamp	getTextStamp() Gets attribute of text stamp.
boolean	isStampSignature()
boolean	setDigitalStamp(CPDFStampAnnotation.DigitalStamp digitalStamp) Sets attribute of digital stamp.
boolean	setIconName(java.lang.String name) Not in use currently
boolean	setImageStamp(java.lang.String imagePath) Sets resource of image stamp.
boolean	setStampSignature(boolean isStampSignature)
boolean	setStandardStamp(CPDFStampAnnotation.StandardStamp standardStamp) Sets standard stamp type.
boolean	setTextStamp(CPDFStampAnnotation.TextStamp textStamp) Sets attribute of text stamp.
boolean	updateAp() Updates annotation appearance.
boolean	updateApWithBitmap(int[] pixels, int width, int height) Upadates annotation appearance by Bitmap.

Methods inherited from class com.compdfkit.core.annotation.CPDFAnnotation

addToPage, clearFilledRGBColor, clearFilledTransparency, close, getApRotation, getBgRGBColor, getBorderRGBColor, getBorderStyle, getBorderWidth, getContent, getCreationDate, getFilledRGBColor, getFilledTransparency, getFlags, getName, getOverLayText, getRecentlyModifyDate, getRect, getRGBColor, getTitle, getTransparency, getType, hasAp, isAllowCorrectAnnotationAp, isHidden, isLocked, isReadOnly, isValid, removeAp, removeFromPage, setAllowCorrectAnnotationAp, setBgRGBColor, setBorderRGBColor, setBorderStyle, setBorderWidth, setContent, setCreationDate, setFilledRGBColor, setFilledTransparency, setFlags, setHidden, setLocked, setName, setOverLayText, setReadOnly, setRecentlyModifyDate, setRect, setRGBColor, setTitle, setTransparency, updateApWithImage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setStandardStamp

public boolean setStandardStamp(CPDFStampAnnotation.StandardStamp standardStamp)

Sets standard stamp type.

Parameters:

standardStamp - Standard stamp type.

Returns:

Returns whether to successfully set standard stamp type.

getStandardStamp

public CPDFStampAnnotation.StandardStamp getStandardStamp()

Gets standard stamp type.

Returns:

Returns standard stamp type.

setTextStamp

public boolean setTextStamp(CPDFStampAnnotation.TextStamp textStamp)

Sets attribute of text stamp.

Parameters:

textStamp - Attribute of text stamp.

Returns:

Returns whether to successfully set attribute of text stamp.

getTextStamp

public CPDFStampAnnotation.TextStamp getTextStamp()

Gets attribute of text stamp.

Returns:

Returns attribute of text stamp.

setDigitalStamp

public boolean setDigitalStamp(CPDFStampAnnotation.DigitalStamp digitalStamp)

Sets attribute of digital stamp.

Parameters:

digitalStamp - Attribute of digital stamp.

Returns:

Returns whether to successfully set attribute of digital stamp.

getDigitalStamp

public CPDFStampAnnotation.DigitalStamp getDigitalStamp()

Gets attribute of digital stamp.

Returns:

Returns attribute of digital stamp.

setImageStamp

public boolean setImageStamp(java.lang.String imagePath)

Sets resource of image stamp.

Parameters:

imagePath - Image path of stamp.

Returns:

Returns whether to successfully set resource of image stamp.

getStampType

public CPDFStampAnnotation.StampType getStampType()

Gets stamp type.

Returns:

Returns stamp type

setStampSignature

public boolean setStampSignature(boolean isStampSignature)

isStampSignature

public boolean isStampSignature()

setIconName

public boolean setIconName(java.lang.String name)

Not in use currently

getIconName

public java.lang.String getIconName()

Not in use currently

updateAp

public boolean updateAp()

Description copied from class: CPDFAnnotation

Updates annotation appearance. Call this function to update annotation appearance after modifying annotation attribute.

Overrides:

updateAp in class CPDFAnnotation

Returns:

Returns whether to successfully update annotation appearance.

updateApWithBitmap

public boolean updateApWithBitmap(int[] pixels,
                                  int width,
                                  int height)

Description copied from class: CPDFAnnotation

Upadates annotation appearance by Bitmap.

Overrides:

updateApWithBitmap in class CPDFAnnotation

Parameters:

pixels - Bitmap pixels.

width - Bitmap width.

height - Bitmap height.

Returns:

Returns whether to successfully upadate annotation appearance.

getAppearanceByPixel

public int[] getAppearanceByPixel(int width,
                                  int height,
                                  CPDFAnnotation.AppearanceType type)

Description copied from class: CPDFAnnotation

Gets annotation appearance by pixel with Bitmap.

Overrides:

getAppearanceByPixel in class CPDFAnnotation

Parameters:

width - Bitmap width.

height - Bitmap height.

type - AppearanceType.

Returns:

Returns pixels with Bitmap.