Package org.verapdf.gf.model.impl.pd

Class GFPDAnnot

java.lang.Object

org.verapdf.model.GenericModelObject

org.verapdf.gf.model.impl.pd.GFPDObject

org.verapdf.gf.model.impl.pd.GFPDAnnot

All Implemented Interfaces:

Object, PDAnnot, PDObject

Direct Known Subclasses:

GFPD3DAnnot, GFPDLinkAnnot, GFPDMarkupAnnot, GFPDMovieAnnot, GFPDPopupAnnot, GFPDPrinterMarkAnnot, GFPDRichMediaAnnot, GFPDScreenAnnot, GFPDSoundAnnot, GFPDTrapNetAnnot, GFPDWatermarkAnnot, GFPDWidgetAnnot

public class GFPDAnnot
extends GFPDObject
implements PDAnnot

Author:

Maksim Bezrukov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A
static final String	ADDITIONAL_ACTION
static final String	ANNOTATION_TYPE
static final String	APPEARANCE
static final String	BM
static final String	CARET
static final String	CIRCLE
static final String	DICT
static final String	FILE_ATTACHMENT
static final String	FREE_TEXT
static final String	HIGHLIGHT
static final String	INK
static final String	LANG
static final String	LINE
static final String	LINK
static final String	MOVIE
static final String	POLYGON
static final String	POLYLINE
static final String	POPUP
static final String	PRINTER_MARK
static final String	REDACT
protected final PDResourcesHandler	resources
static final String	RICH_MEDIA
static final String	SCREEN
static final String	SOUND
static final String	SQUARE
static final String	SQUIGGLY
static final String	STAMP
static final String	STREAM
static final String	STRIKE_OUT
static final String	TEXT
static final String	TRAP_NET
static final String	TYPE_3D
static final String	UNDERLINE
static final String	WATERMARK
static final String	WIDGET
static final int	X_AXIS
static final int	Y_AXIS

Fields inherited from class org.verapdf.gf.model.impl.pd.GFPDObject

contentStream, document, id, MAX_NUMBER_OF_ELEMENTS, pdcMap, pdFont, simpleCOSObject, simplePDObject

Fields inherited from class org.verapdf.model.GenericModelObject

contextDependent

Constructor Summary

Constructors

Constructor	Description
GFPDAnnot(PDAnnotation annot, PDResourcesHandler pageResources, PDPage page)
GFPDAnnot(PDAnnotation annot, PDResourcesHandler pageResources, PDPage page, String type)

Method Summary

Modifier and Type	Method	Description
static GFPDAnnot	createAnnot(PDAnnotation annot, PDResourcesHandler pageResources, PDPage page)
String	getAlt()	the Alt entry of parent structure element
String	getAP()	ampersand-separated list of all keys in the annotation's appearance dictionary (AP key)
Double	getCA()	annotation opacity (CA key)
Boolean	getcontainsA()	true if the annotation dictionary contains the A entry
Boolean	getcontainsAA()	true if the annotation dictionary contains the AA entry
Boolean	getcontainsC()	true if the annotation dictionary contains the C entry
Boolean	getcontainsIC()	true if the annotation dictionary contains the IC entry
String	getContents()	the value of the /Contents entry
Long	getF()	annotation flags
String	getFT()	the value of the /FT entry (Field type), in case this is the widget annotation representing the form field, or null, if this entry is not present
Double	getheight()	the height of the annotation computed as an absolute value of the difference of value 2 and value 4 of the Rect entry
Boolean	getisArtifact()	true if this annotation is contained in an Artifact structure element (directly or indirectly)
Boolean	getisOutsideCropBox()	true, if annotation rectangle is outside page CropBox
COSString	getLang()
List<? extends Object>	getLinkedObjects(String link)
String	getN_type()	the type of the normal appearance entry (/N key) in the annotation appearance dictionary (/AP key) or null, if the normal appearance is not present
protected COSObject	getParentDictionary()
String	getstructParentObjectKey()	indirect object number and generation number of the parent struct element of the annotation
String	getstructParentStandardType()	struct parent element standard type
String	getstructParentType()	struct parent element type
String	getSubtype()	annotation subtype
Double	getwidth()	the width of the annotation computed as an absolute value of the difference of value 1 and value 3 of the Rect entry
protected boolean	isSignature()

Methods inherited from class org.verapdf.gf.model.impl.pd.GFPDObject

getentries, getID, getobjectKey

Methods inherited from class org.verapdf.model.GenericModelObject

getContext, getExtraContext, getLinks, getObjectType, getProperties, getSuperTypes, isContextDependent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.verapdf.model.baselayer.Object

getContext, getExtraContext, getID, getLinks, getObjectType, getProperties, getSuperTypes, isContextDependent

Methods inherited from interface org.verapdf.model.pdlayer.PDObject

getentries, getobjectKey

Field Details

ANNOTATION_TYPE

public static final String ANNOTATION_TYPE

See Also:

• Constant Field Values

DICT

public static final String DICT

See Also:

• Constant Field Values

STREAM

public static final String STREAM

See Also:

• Constant Field Values

APPEARANCE

public static final String APPEARANCE

See Also:

• Constant Field Values

A

public static final String A

See Also:

• Constant Field Values

ADDITIONAL_ACTION

public static final String ADDITIONAL_ACTION

See Also:

• Constant Field Values

LANG

public static final String LANG

See Also:

• Constant Field Values

BM

public static final String BM

See Also:

• Constant Field Values

TYPE_3D

public static final String TYPE_3D

See Also:

• Constant Field Values

CARET

public static final String CARET

See Also:

• Constant Field Values

CIRCLE

public static final String CIRCLE

See Also:

• Constant Field Values

FILE_ATTACHMENT

public static final String FILE_ATTACHMENT

See Also:

• Constant Field Values

FREE_TEXT

public static final String FREE_TEXT

See Also:

• Constant Field Values

HIGHLIGHT

public static final String HIGHLIGHT

See Also:

• Constant Field Values

INK

public static final String INK

See Also:

• Constant Field Values

LINE

public static final String LINE

See Also:

• Constant Field Values

LINK

public static final String LINK

See Also:

• Constant Field Values

MOVIE

public static final String MOVIE

See Also:

• Constant Field Values

POLYGON

public static final String POLYGON

See Also:

• Constant Field Values

POLYLINE

public static final String POLYLINE

See Also:

• Constant Field Values

POPUP

public static final String POPUP

See Also:

• Constant Field Values

PRINTER_MARK

public static final String PRINTER_MARK

See Also:

• Constant Field Values

REDACT

public static final String REDACT

See Also:

• Constant Field Values

RICH_MEDIA

public static final String RICH_MEDIA

See Also:

• Constant Field Values

SCREEN

public static final String SCREEN

See Also:

• Constant Field Values

SOUND

public static final String SOUND

See Also:

• Constant Field Values

STAMP

public static final String STAMP

See Also:

• Constant Field Values

STRIKE_OUT

public static final String STRIKE_OUT

See Also:

• Constant Field Values

SQUARE

public static final String SQUARE

See Also:

• Constant Field Values

SQUIGGLY

public static final String SQUIGGLY

See Also:

• Constant Field Values

TEXT

public static final String TEXT

See Also:

• Constant Field Values

TRAP_NET

public static final String TRAP_NET

See Also:

• Constant Field Values

WATERMARK

public static final String WATERMARK

See Also:

• Constant Field Values

UNDERLINE

public static final String UNDERLINE

See Also:

• Constant Field Values

WIDGET

public static final String WIDGET

See Also:

• Constant Field Values

X_AXIS

public static final int X_AXIS

See Also:

• Constant Field Values

Y_AXIS

public static final int Y_AXIS

See Also:

• Constant Field Values

resources

protected final PDResourcesHandler resources

Constructor Details

GFPDAnnot

public GFPDAnnot(PDAnnotation annot,
 PDResourcesHandler pageResources,
 PDPage page)

GFPDAnnot

public GFPDAnnot(PDAnnotation annot,
 PDResourcesHandler pageResources,
 PDPage page,
 String type)

Method Details

getSubtype

public String getSubtype()

Description copied from interface: PDAnnot

annotation subtype

Specified by:

getSubtype in interface PDAnnot

getAP

public String getAP()

Description copied from interface: PDAnnot

ampersand-separated list of all keys in the annotation's appearance dictionary (AP key)

Specified by:

getAP in interface PDAnnot

getF

public Long getF()

Description copied from interface: PDAnnot

annotation flags

Specified by:

getF in interface PDAnnot

getCA

public Double getCA()

Description copied from interface: PDAnnot

annotation opacity (CA key)

Specified by:

getCA in interface PDAnnot

getN_type

public String getN_type()

Description copied from interface: PDAnnot

the type of the normal appearance entry (/N key) in the annotation appearance dictionary (/AP key) or null, if the normal appearance is not present

Specified by:

getN_type in interface PDAnnot

getcontainsC

public Boolean getcontainsC()

Description copied from interface: PDAnnot

true if the annotation dictionary contains the C entry

Specified by:

getcontainsC in interface PDAnnot

getcontainsIC

public Boolean getcontainsIC()

Description copied from interface: PDAnnot

true if the annotation dictionary contains the IC entry

Specified by:

getcontainsIC in interface PDAnnot

getFT

public String getFT()

Description copied from interface: PDAnnot

the value of the /FT entry (Field type), in case this is the widget annotation representing the form field, or null, if this entry is not present

Specified by:

getFT in interface PDAnnot

getwidth

public Double getwidth()

Description copied from interface: PDAnnot

the width of the annotation computed as an absolute value of the difference of value 1 and value 3 of the Rect entry

Specified by:

getwidth in interface PDAnnot

getheight

public Double getheight()

Description copied from interface: PDAnnot

the height of the annotation computed as an absolute value of the difference of value 2 and value 4 of the Rect entry

Specified by:

getheight in interface PDAnnot

getcontainsAA

public Boolean getcontainsAA()

Description copied from interface: PDAnnot

true if the annotation dictionary contains the AA entry

Specified by:

getcontainsAA in interface PDAnnot

getstructParentType

public String getstructParentType()

Description copied from interface: PDAnnot

struct parent element type

Specified by:

getstructParentType in interface PDAnnot

getstructParentStandardType

public String getstructParentStandardType()

Description copied from interface: PDAnnot

struct parent element standard type

Specified by:

getstructParentStandardType in interface PDAnnot

getstructParentObjectKey

public String getstructParentObjectKey()

Description copied from interface: PDAnnot

indirect object number and generation number of the parent struct element of the annotation

Specified by:

getstructParentObjectKey in interface PDAnnot

getParentDictionary

protected COSObject getParentDictionary()

getLang

public COSString getLang()

getContents

public String getContents()

Description copied from interface: PDAnnot

the value of the /Contents entry

Specified by:

getContents in interface PDAnnot

getAlt

public String getAlt()

Description copied from interface: PDAnnot

the Alt entry of parent structure element

Specified by:

getAlt in interface PDAnnot

getisOutsideCropBox

public Boolean getisOutsideCropBox()

Description copied from interface: PDAnnot

true, if annotation rectangle is outside page CropBox

Specified by:

getisOutsideCropBox in interface PDAnnot

getcontainsA

public Boolean getcontainsA()

Description copied from interface: PDAnnot

true if the annotation dictionary contains the A entry

Specified by:

getcontainsA in interface PDAnnot

getisArtifact

public Boolean getisArtifact()

Description copied from interface: PDAnnot

true if this annotation is contained in an Artifact structure element (directly or indirectly)

Specified by:

getisArtifact in interface PDAnnot

getLinkedObjects

public List<? extends Object> getLinkedObjects(String link)

Specified by:

getLinkedObjects in interface Object

Overrides:

getLinkedObjects in class GenericModelObject

Parameters:

link - - the name of a link

Returns:

List of objects with the given link

isSignature

protected boolean isSignature()

createAnnot

public static GFPDAnnot createAnnot(PDAnnotation annot,
 PDResourcesHandler pageResources,
 PDPage page)