org.verapdf.model.impl.pb.pd

Class PBoxPDAnnot

java.lang.Object

org.verapdf.model.GenericModelObject

org.verapdf.model.impl.pb.pd.PBoxPDObject

org.verapdf.model.impl.pb.pd.PBoxPDAnnot

All Implemented Interfaces:

Object, PDAnnot, PDObject

Direct Known Subclasses:

PBoxPD3DAnnot, PBoxPDLinkAnnot, PBoxPDPrinterMarkAnnot, PBoxPDTrapNetAnnot, PBoxPDWidgetAnnot

public class PBoxPDAnnot
extends PBoxPDObject
implements PDAnnot

Author:

Evgeniy Muravitskiy

Field Summary

Fields

Modifier and Type	Field and Description
static String	A
static String	ADDITIONAL_ACTION
static String	ANNOTATION_TYPE
static String	APPEARANCE
static String	C
static String	DICT
static String	IC
static String	LANG
static String	LINK
static int	MAX_COUNT_OF_ACTIONS
static String	PRINTER_MARK
static String	STREAM
static String	TRAP_NET
static String	TYPE_3D
static String	WIDGET
static int	X_AXIS
static int	Y_AXIS

Fields inherited from class org.verapdf.model.impl.pb.pd.PBoxPDObject

cMap, contentStream, MAX_NUMBER_OF_ELEMENTS, pdFontLike, simplePDObject

Fields inherited from class org.verapdf.model.GenericModelObject

contextDependent

Constructor Summary

Constructors

Constructor and Description
PBoxPDAnnot(PDAnnotation annot, PDResources pageResources, PDDocument document, PDFAFlavour flavour)
PBoxPDAnnot(PDAnnotation annot, PDResources pageResources, PDDocument document, PDFAFlavour flavour, String type)

Method Summary

Modifier and Type	Method and Description
static PBoxPDAnnot	createAnnot(PDAnnotation annot, PDResources pageResources, PDDocument document, PDFAFlavour flavour)
String	getAlt() the Alt entry of parent structure element
String	getAP() SPACE-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
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	getisOutsideCropBox() true, if annotation rectangle is outside page CropBox
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
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

Methods inherited from class org.verapdf.model.impl.pb.pd.PBoxPDObject

addAction, getID

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

Field Detail

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

C

public static final String C

See Also:

Constant Field Values

IC

public static final String IC

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

LINK

public static final String LINK

See Also:

Constant Field Values

PRINTER_MARK

public static final String PRINTER_MARK

See Also:

Constant Field Values

WIDGET

public static final String WIDGET

See Also:

Constant Field Values

TRAP_NET

public static final String TRAP_NET

See Also:

Constant Field Values

TYPE_3D

public static final String TYPE_3D

See Also:

Constant Field Values

MAX_COUNT_OF_ACTIONS

public static final int MAX_COUNT_OF_ACTIONS

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

Constructor Detail

PBoxPDAnnot

public PBoxPDAnnot(PDAnnotation annot,
                   PDResources pageResources,
                   PDDocument document,
                   PDFAFlavour flavour,
                   String type)

PBoxPDAnnot

public PBoxPDAnnot(PDAnnotation annot,
                   PDResources pageResources,
                   PDDocument document,
                   PDFAFlavour flavour)

Method Detail

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

SPACE-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

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

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

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

createAnnot

public static PBoxPDAnnot createAnnot(PDAnnotation annot,
                                      PDResources pageResources,
                                      PDDocument document,
                                      PDFAFlavour flavour)