|
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.PdfSquareAnnot
com.gnostice.pdfone.PdfCircleAnnot
public class PdfCircleAnnot
This class represents a circle annotation. A circle annotation can also oval in shape.
// Create a PDF page PdfPage page1 = new PdfPage(); // Create a PDF font PdfFont fontHelvetica = PdfFont.create("Helvetica", 15,PdfEncodings.WINANSI); fontHelvetica.setColor(Color.BLUE); page.writeText("Circle Annotations", fontHelvetica, 80, 280); // Create a circle annotation and set its properties PdfCircleAnnot circleAnnot1 = new PdfCircleAnnot(new PdfRect(100, 320, 120, 80), Color.RED); circleAnnot1.setSubject("Annotation Subject"); circleAnnot1.setTitle("Title"); circleAnnot1.setContents("This is a Circle Annotation"); circleAnnot1.setBorderStyle(PdfCircleAnnot.BORDERSTYLE_DASHED); circleAnnot1.setBorderWidth(3); circleAnnot1.setColor(Color.RED); // Add the annotation to the page page1.addAnnotation(circleAnnot1);
Field Summary |
---|
Constructor Summary | |
---|---|
PdfCircleAnnot()
Zero-argument default constructor. |
|
PdfCircleAnnot(PdfRect r,
Color c)
Constructs a circle annotation with specified rectangle, flags, and color. |
|
PdfCircleAnnot(PdfRect r,
int flags)
Constructs a circle annotation with specified rectangle and flags. |
|
PdfCircleAnnot(PdfRect r,
int flags,
Color c)
Constructs a circle annotation with specified rectangle, flags, and color. |
|
PdfCircleAnnot(PdfRect r,
String subject,
String contents,
String title)
Constructs a circle annotation with specified rectangle and popup window subject, contents, and title. |
|
PdfCircleAnnot(PdfRect r,
String subject,
String contents,
String title,
Color c)
Constructs a circle annotation with specified rectangle, color, and popup window subject, contents and title. |
|
PdfCircleAnnot(PdfRect r,
String subject,
String contents,
String title,
int flags)
Constructs a circle annotation with specified rectangle, flags, and popup window subject, contents and title. |
|
PdfCircleAnnot(PdfRect r,
String subject,
String contents,
String title,
int flags,
Color c)
Constructs a circle annotation with specified rectangle, flags, color and popup window subject, contents and title. |
Method Summary | |
---|---|
Object |
clone()
|
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). |
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). |
Methods inherited from class com.gnostice.pdfone.PdfSquareAnnot |
---|
getCloudIntensity, getInteriorColor, getTransparency, isCloudy, setCloudIntensity, setCloudy, setInteriorColor, setTransparency |
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 |
Constructor Detail |
---|
public PdfCircleAnnot()
public PdfCircleAnnot(PdfRect r, String subject, String contents, String title) throws IOException, PdfException
r
- annotation
rectanglesubject
- text displayed in the subject line of the annotation's
popup windowcontents
- text displayed as the contents of the annotation's
popup windowtitle
- text displayed in the title in the annotation's
popup window
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfCircleAnnot(PdfRect r, String subject, String contents, String title, Color c) throws IOException, PdfException
r
- annotation
rectanglesubject
- text displayed in the subject line of the
annotation's popup windowcontents
- text displayed as the contents of the annotation's
popup windowtitle
- text displayed as the contents of the annotation's
popup windowc
- color of the circle
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfCircleAnnot(PdfRect r, String subject, String contents, String title, int flags) throws IOException, PdfException
r
- annotation
rectanglesubject
- text displayed in the subject line of the
annotation's popup windowcontents
- text displayed as the contents of the annotation's
popup windowtitle
- text displayed in the title in the annotation's
popup windowflags
- annotation attributes
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfCircleAnnot(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
annotation's popup windowcontents
- text displayed as the contents of the annotation's
popup windowtitle
- text displayed in the title in the annotation's
popup windowflags
- annotation attributes
c
- color of the circle
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfCircleAnnot(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 PdfCircleAnnot(PdfRect r, int flags, Color c) throws IOException, PdfException
r
- annotation
rectangleflags
- annotation attributes
c
- color of the circle
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfCircleAnnot(PdfRect r, Color c) throws IOException, PdfException
r
- annotation
rectanglec
- color of the circle
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.Method Detail |
---|
public Object clone()
clone
in class PdfSquareAnnot
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 annotationgetPopup()
public PdfAppearanceStream getDownAppearance()
getNormalAppearance()
,
getDownAppearance()
,
setNormalAppearance(PdfAppearanceStream)
,
setRolloverAppearance(PdfAppearanceStream)
,
setDownAppearance(PdfAppearanceStream)
public void setDownAppearance(PdfAppearanceStream downAppearance)
getNormalAppearance()
,
getDownAppearance()
,
getRolloverAppearance()
,
setNormalAppearance(PdfAppearanceStream)
,
setRolloverAppearance(PdfAppearanceStream)
public PdfAppearanceStream getNormalAppearance()
getDownAppearance()
,
getRolloverAppearance()
,
setNormalAppearance(PdfAppearanceStream)
,
setDownAppearance(PdfAppearanceStream)
,
setRolloverAppearance(PdfAppearanceStream)
public void setNormalAppearance(PdfAppearanceStream normalAppearance)
normalAppearance
- the specified appearance streamsetDownAppearance(PdfAppearanceStream)
,
setRolloverAppearance(PdfAppearanceStream)
,
getNormalAppearance()
,
getDownAppearance()
,
getRolloverAppearance()
public PdfAppearanceStream getRolloverAppearance()
getNormalAppearance()
,
getDownAppearance()
,
setNormalAppearance(PdfAppearanceStream)
,
setDownAppearance(PdfAppearanceStream)
,
setRolloverAppearance(PdfAppearanceStream)
public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
rolloverAppearance
- the specified appearance streamsetNormalAppearance(PdfAppearanceStream)
,
setDownAppearance(PdfAppearanceStream)
,
getNormalAppearance()
,
getDownAppearance()
,
getRolloverAppearance()
|
Pro. Ed. v5.4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |