de.intarsys.pdf.pd
Class PDPopupAnnotation

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDAnnotation
              de.intarsys.pdf.pd.PDPopupAnnotation

All Implemented Interfaces:

ICOSObjectListener, IAdditionalActionSupport, IAttributeSupport

public class PDPopupAnnotation
extends PDAnnotation

The implementation of a popup window definition within the document. The popup window is associated with other annotations to enable the user to give comments and replies.

Nested Class Summary

static class

PDPopupAnnotation.MetaClass The meta class implementation

Field Summary

static COSName	CN_Subtype_Popup
static COSName	DK_Open
static COSName	DK_Parent
static COSName	DK_T
static PDPopupAnnotation.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDAnnotation

ANNOTATION_ACTION_TRIGGERS, CN_Type_Annot, DK_A, DK_AP, DK_AS, DK_Border, DK_BS, DK_C, DK_CA, DK_Contents, DK_F, DK_IC, DK_M, DK_NM, DK_OC, DK_P, DK_Rect, DK_StructParent

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Fields inherited from interface de.intarsys.pdf.pd.IAdditionalActionSupport

DK_AA

Method Summary

float[]	getColor() The color values for this.
String	getContents() The contents String for this.
CDSDate	getModified() The last modification date.
PDPage	getPage() Try to access the PDPage we are on.
PDAnnotation	getParent()
String	getSubject()
String	getSubtypeLabel() A String representation of this.
String	getText()
boolean	isOpen()
void	setContents(String contents) Assign a content String.
void	setOpen(boolean open)
void	setParent(PDAnnotation parent)
void	setSubject(String subject)

Methods inherited from class de.intarsys.pdf.pd.PDAnnotation

addAction, basicGetFlags, basicSetFlags, canReceiveFocus, copy, dispose, getAction, getAdditionalActions, getAppearance, getAppearanceState, getAppearanceStates, getBorderStyle, getBorderStyleName, getBorderStyleWidth, getFlags, getName, getNormalizedRectangle, getRectangle, getSupportedTriggerEvents, invalidateCaches, isHidden, isInvisible, isLocked, isMarkupAnnotation, isNoRotate, isNoView, isNoZoom, isPrint, isReadOnly, isToggleNoView, isWidgetAnnotation, setAction, setAdditionalActions, setAppearance, setAppearanceState, setBorderStyle, setBorderStyleName, setBorderStyleWidth, setColor, setHidden, setInvisible, setLocked, setName, setNoRotate, setNoView, setNoZoom, setPrint, setReadOnly, setRectangle, setToggleNoView, supportsPrint, toString, touch

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

META

public static final PDPopupAnnotation.MetaClass META

The meta class instance

CN_Subtype_Popup

public static final COSName CN_Subtype_Popup

DK_T

public static final COSName DK_T

DK_Parent

public static final COSName DK_Parent

DK_Open

public static final COSName DK_Open

Method Detail

getText

public String getText()

getParent

public PDAnnotation getParent()

setParent

public void setParent(PDAnnotation parent)

getContents

public String getContents()

Description copied from class: PDAnnotation

The contents String for this.

Overrides:

getContents in class PDAnnotation

Returns:

The contents String for this.

setContents

public void setContents(String contents)

Description copied from class: PDAnnotation

Assign a content String.

Overrides:

setContents in class PDAnnotation

Parameters:

contents - The new content String.

getSubject

public String getSubject()

getPage

public PDPage getPage()

Description copied from class: PDAnnotation

Try to access the PDPage we are on. This may return null, as this reference is not required by the spec.

Overrides:

getPage in class PDAnnotation

Returns:

Try to access the PDPage we are on.

setSubject

public void setSubject(String subject)

getModified

public CDSDate getModified()

Description copied from class: PDAnnotation

The last modification date.

Overrides:

getModified in class PDAnnotation

Returns:

The last modification date.

getColor

public float[] getColor()

Description copied from class: PDAnnotation

The color values for this.

Overrides:

getColor in class PDAnnotation

Returns:

The color values for this.

isOpen

public boolean isOpen()

setOpen

public void setOpen(boolean open)

getSubtypeLabel

public String getSubtypeLabel()

Description copied from class: PDAnnotation

A String representation of this.

Specified by:

getSubtypeLabel in class PDAnnotation

Returns:

A String representation of this.