|
Gnostice PDFOne
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.gnostice.pdfone.PdfAnnot
com.gnostice.pdfone.PdfProAnnot
com.gnostice.pdfone.PdfStampAnnot
This class represents a stamp annotation. This class provides
numerous constructors for creating a stamp annotations. By default,
the annotation icon will be that of "DRAFT." To change the icon,
use setStamp(String)
with one of the
constants
defined in this class for annotation
icons. You can also specify certain
annotation attributes
to change the
way in which the annotation is displayed, allowed to interact with
the user, or printed.
// Create a PDF page PdfPage page = new PdfPage(); // Create a stamp annotation and set its properties PdfStampAnnot stampAnnot = new PdfStampAnnot(); stampAnnot.setRect(200, 100, 100, 50); stampAnnot.setStamp(PdfStampAnnot.CONFIDENTIAL); stampAnnot.setSubject("Stamp Annotation Demo."); stampAnnot.setTitle("Demo."); stampAnnot.setContents("This is a stamp annotation"); // Add the annotation to the page page.addAnnotation(stampAnnot);
Field Summary | |
static String |
APPROVED
Constant for stamp annotation icon "APPROVED." |
static String |
ASIS
Constant for stamp annotation icon "AS IS." |
static String |
CONFIDENTIAL
Constant for stamp annotation icon "CONFIDENTIAL." |
static String |
DEPARTMENTAL
Constant for stamp annotation icon "DEPARTMENTAL." |
static String |
DRAFT
Constant for stamp annotation icon "DRAFT." |
static String |
EXPERIMENTAL
Constant for stamp annotation icon "EXPERIMENTAL." |
static String |
EXPIRED
Constant for stamp annotation icon "EXPIRED." |
static String |
FINAL
Constant for stamp annotation icon "FINAL." |
static String |
FOR_COMMENT
Constant for stamp annotation icon "FOR COMMENT." |
static String |
FOR_PUBLIC_RELEASE
Constant for stamp annotation icon "FOR PUBLIC RELEASE." |
static String |
NOT_APPROVED
Constant for stamp annotation icon "NOT APPROVED." |
static String |
NOT_FOR_PUBLIC_RELEASE
Constant for stamp annotation icon "NOT FOR PUBLIC RELEASE." |
static String |
SOLD
Constant for stamp annotation icon "SOLD." |
static String |
TOP_SECRET
Constant for stamp annotation icon "TOP SECRET." |
Constructor Summary | |
PdfStampAnnot()
Creates a new stamp annotation. |
|
PdfStampAnnot(PdfRect r,
Color c)
Creates a new stamp annotation with specified annotation rectangle and popup window color. |
|
PdfStampAnnot(PdfRect r,
int flags)
Creates a new stamp annotation with specified annotation rectangle and annotation attributes. |
|
PdfStampAnnot(PdfRect r,
int flags,
Color c)
Creates a new stamp annotation with specified annotation rectangle, annotation attributes, and popup window color. |
|
PdfStampAnnot(PdfRect r,
String subject,
String contents,
String title)
Creates a new stamp annotation with specified annotation rectangle, and popup window subject, content and title. |
|
PdfStampAnnot(PdfRect r,
String subject,
String contents,
String title,
Color c)
Creates a new stamp annotation with specified annotation rectangle, and popup window color, subject, content and title. |
|
PdfStampAnnot(PdfRect r,
String subject,
String contents,
String title,
int flags)
Creates a new stamp annotation with specified annotation rectangle, popup window subject, content and title, and annotation attributes. |
|
PdfStampAnnot(PdfRect r,
String subject,
String contents,
String title,
int flags,
Color c)
Creates a new stamp annotation with specified annotation rectangle, popup window color, subject, content and title, and annotation attributes. |
Method Summary | |
PdfAppearanceStream |
getDownAppearance()
Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button. |
PdfAppearanceStream |
getNormalAppearance()
Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field). |
PdfPopUpAnnot |
getPopup()
Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation. |
PdfAppearanceStream |
getRolloverAppearance()
Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button). |
String |
getStamp()
Returns stamp annotation icon. |
float |
getTransparency()
|
void |
setDownAppearance(PdfAppearanceStream downAppearance)
Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button. |
void |
setNormalAppearance(PdfAppearanceStream normalAppearance)
Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field). |
void |
setPopup(PdfPopUpAnnot popup,
boolean overridePopUpProperties)
Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation. |
void |
setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button). |
void |
setStamp(String stamp)
Specifies stamp annotation icon. |
void |
setTransparency(float transparecyLevel)
|
Methods inherited from class com.gnostice.pdfone.PdfAnnot |
delete, getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, getType, hashCode, isDeleted, isShowRect, setAnnotName, setBorderStyle, setBorderWidth, setColor, setContents, setDashPattern, setFlags, setRect, setRect, setRect, setRect, setRect, setShowRect, setSubject, setTitle |
Methods inherited from class java.lang.Object |
equals, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String APPROVED
public static final String ASIS
public static final String CONFIDENTIAL
public static final String DEPARTMENTAL
public static final String DRAFT
public static final String EXPERIMENTAL
public static final String EXPIRED
public static final String FINAL
public static final String FOR_COMMENT
public static final String FOR_PUBLIC_RELEASE
public static final String NOT_APPROVED
public static final String NOT_FOR_PUBLIC_RELEASE
public static final String SOLD
public static final String TOP_SECRET
Constructor Detail |
public PdfStampAnnot()
setStamp(String)
,
getStamp()
public PdfStampAnnot(PdfRect r, String subject, String contents, String title) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject line of the annotation
popup windowcontents
- text displayed as content by annotation popup windowtitle
- text displayed in the title of the annotation popup
window
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.setStamp(String)
,
getStamp()
public PdfStampAnnot(PdfRect r, String subject, String contents, String title, Color c) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject line of the popup
windowcontents
- text contents of the popup windowtitle
- text displayed in the title of the popup windowc
- color of the border of the popup window
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfStampAnnot(PdfRect r, String subject, String contents, String title, int flags) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject line of the popup
windowcontents
- text contents of the popup windowtitle
- text displayed in the title of the popup windowflags
- annotation attributes
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfStampAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject line of the popup
windowcontents
- text contents of the popup windowtitle
- text displayed in the title of the popup windowflags
- annotation attributes
c
- color of the border of the popup window
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfStampAnnot(PdfRect r, int flags) throws IOException, PdfException
r
- annotation rectangleflags
- annotation attributes
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfStampAnnot(PdfRect r, int flags, Color c) throws IOException, PdfException
r
- annotation rectangleflags
- annotation attributes
c
- color of the border of the popup window
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfStampAnnot(PdfRect r, Color c) throws IOException, PdfException
r
- annotation rectanglec
- color of the border of the popup window
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.Method Detail |
public String getStamp()
setStamp(String)
public void setStamp(String stamp)
stamp
- constant identifying the stamp annotation icongetStamp()
public void setTransparency(float transparecyLevel)
public float getTransparency()
public PdfPopUpAnnot getPopup()
public void setPopup(PdfPopUpAnnot popup, boolean overridePopUpProperties)
popup
- popup annotation that needs to be used as the popup
windowoverridePopUpProperties
- whether a viewer application should override the
properties of the popup annotation with those of
this annotationPdfProAnnot.getPopup()
public PdfAppearanceStream getDownAppearance()
PdfProAnnot.getNormalAppearance()
,
PdfProAnnot.getDownAppearance()
,
PdfProAnnot.setNormalAppearance(PdfAppearanceStream)
,
PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)
,
PdfProAnnot.setDownAppearance(PdfAppearanceStream)
public void setDownAppearance(PdfAppearanceStream downAppearance)
PdfProAnnot.getNormalAppearance()
,
PdfProAnnot.getDownAppearance()
,
PdfProAnnot.getRolloverAppearance()
,
PdfProAnnot.setNormalAppearance(PdfAppearanceStream)
,
PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)
public PdfAppearanceStream getNormalAppearance()
PdfProAnnot.getDownAppearance()
,
PdfProAnnot.getRolloverAppearance()
,
PdfProAnnot.setNormalAppearance(PdfAppearanceStream)
,
PdfProAnnot.setDownAppearance(PdfAppearanceStream)
,
PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)
public void setNormalAppearance(PdfAppearanceStream normalAppearance)
normalAppearance
- the specified appearance streamPdfProAnnot.setDownAppearance(PdfAppearanceStream)
,
PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)
,
PdfProAnnot.getNormalAppearance()
,
PdfProAnnot.getDownAppearance()
,
PdfProAnnot.getRolloverAppearance()
public PdfAppearanceStream getRolloverAppearance()
PdfProAnnot.getNormalAppearance()
,
PdfProAnnot.getDownAppearance()
,
PdfProAnnot.setNormalAppearance(PdfAppearanceStream)
,
PdfProAnnot.setDownAppearance(PdfAppearanceStream)
,
PdfProAnnot.setRolloverAppearance(PdfAppearanceStream)
public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
rolloverAppearance
- the specified appearance streamPdfProAnnot.setNormalAppearance(PdfAppearanceStream)
,
PdfProAnnot.setDownAppearance(PdfAppearanceStream)
,
PdfProAnnot.getNormalAppearance()
,
PdfProAnnot.getDownAppearance()
,
PdfProAnnot.getRolloverAppearance()
|
Pro. Ed. v5.0.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |