com.qoppa.pdf.annotations
Interface RubberStamp

All Superinterfaces:

Annotation

public interface RubberStamp
extends Annotation

Interface representing a Rubber Stamp annotation in a PDF document.

Author:

Qoppa Software

Field Summary

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 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_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Image	createImage(double scale, int maxWidth, int maxHeight) Return an image for the current stamp.
String	getContents() Returns the annotation's text content.
String	getIconName() If this stamp was created using a default predefined stamp, returns the stamp's predefined name.
Image	getImage() If this stamp was created from an image, then it returns the image that it was created from.
int	getRotation() Gets the rotation.
void	setContents(String contents) Sets the annotation's text content.
void	setIconName(String iconName) Sets the name of the predefined stamp from the PDF format specs.
void	setImage(Image image)
void	setRotation(int rotation) Sets the rotation for standard or image stamps that do not have an appearance stream yet.
void	setRunInfo(Hashtable runInfo) Sets information used for stamps that have dynamic fields, such as the current date and time.

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

getActions, getBorderStyle, getBorderWidth, getColor, getComponent, getCreationDate, getCreator, getFlags, getModifiedDate, getName, getOpacity, getRectangle, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreationDate, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setSubtype, 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

Method Detail

setRunInfo

void setRunInfo(Hashtable 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:

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. (Confidential, As is, etc)

Parameters:

iconName - The predefined name.

getImage

Image getImage()

If this stamp was created from an image, then it returns the image that it was created from.

Returns:

The image that the stamp was created from.

setImage

void setImage(Image image)

getRotation

int getRotation()

Gets the rotation.

Returns:

rotation.

setRotation

void setRotation(int rotation)

Sets the rotation for standard or image stamps that do not have an appearance stream yet. Once the appearance stream is generated, this parameter is ignored and will not be saved in the pdf document. * @param rotation the rotation.