de.intarsys.pdf.pd
Class PDMarkupAnnotation

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

All Implemented Interfaces:

ICOSObjectListener, IAdditionalActionSupport, IAttributeSupport

Direct Known Subclasses:

PDFileAttachmentAnnotation, PDStampAnnotation, PDTextAnnotation, PDTextMarkupAnnotation

public class PDMarkupAnnotation
extends PDAnnotation

A generic markup snnotation implementation.

Nested Class Summary

static class

PDMarkupAnnotation.MetaClass The meta class implementation

Field Summary

static COSName	CN_Subtype_Circle
static COSName	CN_Subtype_Ink
static COSName	CN_Subtype_Line
static COSName	CN_Subtype_Polygon
static COSName	CN_Subtype_PolyLine
static COSName	CN_Subtype_Square
static COSName	DK_CA
static COSName	DK_CreationDate
static COSName	DK_IC
static COSName	DK_InkList
static COSName	DK_IRT
static COSName	DK_L
static COSName	DK_Popup
static COSName	DK_RC
static COSName	DK_Subj
static COSName	DK_T
static COSName	DK_Vertices
static PDMarkupAnnotation.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_Contents, DK_F, 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

COSObject	cosSetField(COSName name, COSObject cosObj) Set a field value in this.
CDSDate	getCreationDate()
float[]	getInnerColor()
PDAnnotation	getInReplyTo()
double	getOpacity()
PDAnnotation	getPopup()
String	getRichContent()
String	getSubject()
String	getSubtypeLabel() A String representation of this.
String	getText()
boolean	isMarkupAnnotation() true if this is a PDMarkupAnnotation.
void	setInnerColor(float[] color)
void	setOpacity(float value)
void	setPopup(PDPopupAnnotation popup)
void	setSubject(String value)
void	setText(String text)

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

addAction, basicGetFlags, basicSetFlags, canReceiveFocus, copy, dispose, getAction, getAdditionalActions, getAppearance, getAppearanceState, getAppearanceStates, getBorderStyle, getBorderStyleName, getBorderStyleWidth, getColor, getContents, getFlags, getModified, getName, getNormalizedRectangle, getPage, getRectangle, getSupportedTriggerEvents, invalidateCaches, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrint, isReadOnly, isToggleNoView, isWidgetAnnotation, setAction, setAdditionalActions, setAppearance, setAppearanceState, setBorderStyle, setBorderStyleName, setBorderStyleWidth, setColor, setContents, 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, 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 PDMarkupAnnotation.MetaClass META

The meta class instance

DK_CreationDate

public static final COSName DK_CreationDate

DK_Subj

public static final COSName DK_Subj

DK_T

public static final COSName DK_T

DK_Popup

public static final COSName DK_Popup

DK_CA

public static final COSName DK_CA

DK_L

public static final COSName DK_L

DK_RC

public static final COSName DK_RC

DK_Vertices

public static final COSName DK_Vertices

CN_Subtype_Ink

public static final COSName CN_Subtype_Ink

CN_Subtype_Square

public static final COSName CN_Subtype_Square

CN_Subtype_Circle

public static final COSName CN_Subtype_Circle

CN_Subtype_Line

public static final COSName CN_Subtype_Line

CN_Subtype_Polygon

public static final COSName CN_Subtype_Polygon

CN_Subtype_PolyLine

public static final COSName CN_Subtype_PolyLine

DK_InkList

public static final COSName DK_InkList

DK_IC

public static final COSName DK_IC

DK_IRT

public static final COSName DK_IRT

Method Detail

getText

public String getText()

setText

public void setText(String text)

getSubject

public String getSubject()

getInReplyTo

public PDAnnotation getInReplyTo()

setSubject

public void setSubject(String value)

getCreationDate

public CDSDate getCreationDate()

getPopup

public PDAnnotation getPopup()

setPopup

public void setPopup(PDPopupAnnotation popup)

getOpacity

public double getOpacity()

setOpacity

public void setOpacity(float value)

getRichContent

public String getRichContent()

getInnerColor

public float[] getInnerColor()

setInnerColor

public void setInnerColor(float[] color)

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.

isMarkupAnnotation

public boolean isMarkupAnnotation()

Description copied from class: PDAnnotation

true if this is a PDMarkupAnnotation.

Overrides:

isMarkupAnnotation in class PDAnnotation

Returns:

true if this is a PDMarkupAnnotation.

cosSetField

public COSObject cosSetField(COSName name,
                             COSObject cosObj)

Description copied from class: COSBasedObject

Set a field value in this. The previously associated object is returned.

This method requires the base object to be a COSDictionary.

Overrides:

cosSetField in class COSBasedObject

Parameters:

name - The field to set

cosObj - The object to set in the field

Returns:

The previously associated object is returned.