Class PDFNet.PopupAnnot
PDFNet.PopupAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and
editing.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.PopupAnnot.create(doc, pos)
Creates a new Popup annotation in the specified document.
|
| <static> |
PDFNet.PopupAnnot.createFromAnnot(ann)
creates a Popup annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.PopupAnnot.createFromObj(d)
creates a Popup annotation and initializes it using given Cos/SDF object.
|
|
Returns the parent annotation of the Popup annotation.
|
|
|
isOpen()
Returns the initial opening condition of Popup.
|
|
|
setOpen(isopen)
sets the initial opening condition of Popup.
|
|
|
setParent(parent)
sets the Parent annotation of the Popup annotation.
|
Class Detail
PDFNet.PopupAnnot(id)
A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and
editing. It shall not appear alone but is associated with a markup annotation,
its parent annotation, and shall be used for editing the parent's text.
It shall have no appearance stream or associated actions of its own and
shall be identified by the Popup entry in the parent's annotation dictionary.
- Parameters:
- id
Method Detail
<static>
{PopupAnnot}
PDFNet.PopupAnnot.create(doc, pos)
Creates a new Popup annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the Popup annotation is added.
- {rect} pos
- A rectangle specifying the Popup annotation's bounds in default user space units.
- Returns:
- {PopupAnnot} A promise that resolves to a newly created blank Popup annotation.
<static>
{PopupAnnot}
PDFNet.PopupAnnot.createFromAnnot(ann)
creates a Popup annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the Popup annotation.
- Returns:
- {PopupAnnot} A promise that resolves to an object of type: "PopupAnnot" (generated documentation)
<static>
{PopupAnnot}
PDFNet.PopupAnnot.createFromObj(d)
creates a Popup annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {PopupAnnot} A promise that resolves to an object of type: "PopupAnnot" (generated documentation)
{Annot}
getParent()
Returns the parent annotation of the Popup annotation.
- Returns:
- {Annot} A promise that resolves to an annot object which is the parent annotation of the Popup annotation.
{boolean}
isOpen()
Returns the initial opening condition of Popup.
- Returns:
- {boolean} A promise that resolves to a bool indicating whether the Popup is initially open.
setOpen(isopen)
sets the initial opening condition of Popup.
(Optional)
- Parameters:
- {boolean} isopen
- A bool indicating whether the Popup is initially open.
setParent(parent)
sets the Parent annotation of the Popup annotation.
(Optional)
- Parameters:
- {Annot} parent
- An annot object which is the parent annotation of the Popup annotation.