org.apache.pdfbox.pdmodel.interactive.annotation: public class: PDAnnotationPopup

org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationPopup [javadoc | source]

java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
      org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup

All Implemented Interfaces:
COSObjectable

This is the class that represents a popup annotation. Introduced in PDF 1.3 specification

author: Paul - King

version: $ - Revision: 1.2 $

Field Summary
public static final String	SUB_TYPE	The type of annotation.

Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
FLAG_INVISIBLE, FLAG_HIDDEN, FLAG_PRINTED, FLAG_NO_ZOOM, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_READ_ONLY, FLAG_LOCKED, FLAG_TOGGLE_NO_VIEW

Constructor:

Constructor:
public PDAnnotationPopup() { super(); getDictionary() .setItem( COSName.SUBTYPE, COSName.getPDFName( SUB_TYPE ) ); } Constructor.
public PDAnnotationPopup(COSDictionary field) { super( field ); } Creates a popup annotation from a COSDictionary, expected to be a correct object definition. Parameters: `field` - the PDF objet to represent as a field.

 public PDAnnotationPopup() {
        super();
        getDictionary()
                .setItem( COSName.SUBTYPE, COSName.getPDFName( SUB_TYPE ) );
}

Constructor.

 public PDAnnotationPopup(COSDictionary field) {
        super( field );
}

Creates a popup annotation from a COSDictionary, expected to be a correct object definition.

Parameters:

field - the PDF objet to represent as a field.

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup Summary:
getOpen, getParent, setOpen, setParent

Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getPage, getRectangle, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView

Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:

createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getPage, getRectangle, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup Detail:
public boolean getOpen() { return getDictionary().getBoolean( "Open" , false ); } This will retrieve the initial state of the annotation, open Or closed (default closed).
public PDAnnotationMarkup getParent() { PDAnnotationMarkup am = null; try { am = (PDAnnotationMarkup) PDAnnotation.createAnnotation( getDictionary().getDictionaryObject( "Parent", "P" ) ); } catch (IOException ioe) { // Couldn't construct the annotation, so return null i.e. do nothing } return am; } This will retrieve the markup annotation which this popup relates to.
public void setOpen(boolean open) { getDictionary().setBoolean( "Open" , open ); } This will set inital state of the annotation, open or closed.
public void setParent(PDAnnotationMarkup annot) { getDictionary().setItem( COSName.PARENT, annot.getDictionary() ); } This will set the markup annotation which this popup relates to.

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup Detail:

 public boolean getOpen() {
        return getDictionary().getBoolean( "Open" , false );
}

This will retrieve the initial state of the annotation, open Or closed (default closed).

 public PDAnnotationMarkup getParent() {
        PDAnnotationMarkup am = null;
        try
        {
            am = (PDAnnotationMarkup)
                PDAnnotation.createAnnotation( getDictionary().getDictionaryObject( "Parent", "P" ) );
        }
        catch (IOException ioe)
        {
            // Couldn't construct the annotation, so return null i.e. do nothing
        }
        return am;
}

This will retrieve the markup annotation which this popup relates to.

 public  void setOpen(boolean open) {
        getDictionary().setBoolean( "Open" , open );
}

This will set inital state of the annotation, open or closed.

 public  void setParent(PDAnnotationMarkup annot) {
        getDictionary().setItem( COSName.PARENT, annot.getDictionary() );
}

This will set the markup annotation which this popup relates to.