|
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.PdfPopUpAnnot
This class represents a popup annotation. A popup annotation is
actually the popup window of another annotation and hence cannot
exist independently. It can be associated with another markup
annotation using the annotation's setPopup()
method.
Field Summary |
Constructor Summary | |
PdfPopUpAnnot()
Zero-argument default constructor |
|
PdfPopUpAnnot(PdfRect r,
Color c)
Creates a popup annotation with specified annotation rectangle and border color. |
|
PdfPopUpAnnot(PdfRect r,
int flags)
Creates a popup annotation with specified annotation rectangle and annotation attributes. |
|
PdfPopUpAnnot(PdfRect r,
int flags,
Color c)
Creates a popup annotation with specified annotation rectangle, annotation attributes, and border color. |
|
PdfPopUpAnnot(PdfRect r,
String subject,
String contents,
String title)
Creates a popup annotation with specified annotation rectangle, subject, content, and title. |
|
PdfPopUpAnnot(PdfRect r,
String subject,
String contents,
String title,
Color c)
Creates a popup annotation with specified annotation rectangle, subject, content, and title. |
|
PdfPopUpAnnot(PdfRect r,
String subject,
String contents,
String title,
int flags)
Creates a popup annotation with specified annotation rectangle, subject, content, title, and annotation attributes. |
|
PdfPopUpAnnot(PdfRect r,
String subject,
String contents,
String title,
int flags,
Color c)
Creates a popup annotation with specified annotation rectangle, subject, content, title, annotation attributes, and border color. |
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). |
PdfAnnot |
getParent()
Returns annotation for which this annotation is used as the popup window. |
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). |
boolean |
isOpen()
Returns whether the popup is kept open by default by the viewer. |
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 |
setOpen(boolean open)
Specifies whether the popup needs to be kept open by default by the viewer. |
void |
setParent(PdfAnnot parent)
Specifies this annotation to be used as popup window of another specified annotation. |
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.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 PdfPopUpAnnot()
public PdfPopUpAnnot(PdfRect r, String subject, String contents, String title) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject linecontents
- text contents displayed by the popuptitle
- text displayed in the title of the popup
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfPopUpAnnot(PdfRect r, String subject, String contents, String title, Color c) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject linecontents
- text contents displayed by the popuptitle
- text displayed in the title of the popupc
- border color
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfPopUpAnnot(PdfRect r, String subject, String contents, String title, int flags) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject linecontents
- text contents displayed by the popuptitle
- text displayed in the title of the popupflags
- annotation attributes
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfPopUpAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c) throws IOException, PdfException
r
- annotation rectanglesubject
- text displayed in the subject linecontents
- text contents displayed by the popuptitle
- text displayed in the title of the popupflags
- annotation attributes
c
- border color
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfPopUpAnnot(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 PdfPopUpAnnot(PdfRect r, int flags, Color c) throws IOException, PdfException
r
- annotation rectangleflags
- annotation attributes
c
- border color
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.public PdfPopUpAnnot(PdfRect r, Color c) throws IOException, PdfException
r
- annotation rectanglec
- border color
IOException
- if an I/O error occurs.
PdfException
- if an illegal argument is supplied.Method Detail |
public Object clone()
public PdfAnnot getParent()
setParent(PdfAnnot)
public void setParent(PdfAnnot parent)
parent
- annotation for which this annotation will be used as
popup windowgetParent()
public boolean isOpen()
true
if the popup is kept open.
false
if otherwise.setOpen(boolean)
public void setOpen(boolean open)
open
- true
if the popup needs to be kept open.
false
if otherwise.isOpen()
public PdfPopUpAnnot getPopup()
com.gnostice.pdfone.PdfProAnnot
public void setPopup(PdfPopUpAnnot popup, boolean overridePopUpProperties)
com.gnostice.pdfone.PdfProAnnot
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 |