org.jpedal.objects
Class PdfAnnots

java.lang.Object
  org.jpedal.objects.PdfAnnots

public class PdfAnnots
extends java.lang.Object

holds data from annotations and provides methods to decode, store and retrieve PdfAnnotations.

Field Summary

static java.util.HashMap

fields

Constructor Summary

PdfAnnots(org.jpedal.io.PdfObjectReader currentPdfFile, int pageNumber)
sets up annotation object to hold content - (This method is used internally to generate the annotations and should not be called) If pageNumber not needed, pass in null

Method Summary

java.awt.Color	getAnnotColor(int i) get color for annotation
int	getAnnotCount() get number of annotations
java.lang.String	getAnnotObjectArea(int i) get area as it is stored in the PDF
java.util.Map	getAnnotRawData(int i) get raw PDF data for annotation - returns null if not in range (first annot is 0, not 1)
java.util.List	getAnnotRawDataList() get all raw PDF data for annotation
java.lang.String	getAnnotSubType(int i) get area as it is stored in the PDF
java.awt.Color	getBorderColor(int i) return color of border or black as default
java.awt.Stroke	getBorderStroke(int i) get stroke to use for border - return null if no border
java.lang.String	getField(int i, java.lang.String field) a text field
int	getPageNumber()
boolean	hasOwnIcon(int i) show if has own custom icon
void	readAnnots(byte[][] annotList) read the annotation from the page

Methods inherited from class java.lang.Object

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

Field Detail

fields

public static java.util.HashMap fields

Constructor Detail

PdfAnnots

public PdfAnnots(org.jpedal.io.PdfObjectReader currentPdfFile,
                 int pageNumber)

sets up annotation object to hold content - (This method is used internally to generate the annotations and should not be called) If pageNumber not needed, pass in null

Method Detail

readAnnots

public final void readAnnots(byte[][] annotList)

read the annotation from the page

getAnnotCount

public final int getAnnotCount()

get number of annotations

getAnnotRawData

public final java.util.Map getAnnotRawData(int i)

get raw PDF data for annotation - returns null if not in range (first annot is 0, not 1)

getAnnotRawDataList

public final java.util.List getAnnotRawDataList()

get all raw PDF data for annotation

hasOwnIcon

public final boolean hasOwnIcon(int i)

show if has own custom icon

getAnnotObjectArea

public final java.lang.String getAnnotObjectArea(int i)

get area as it is stored in the PDF

getAnnotColor

public final java.awt.Color getAnnotColor(int i)

get color for annotation

getBorderStroke

public final java.awt.Stroke getBorderStroke(int i)

get stroke to use for border - return null if no border

getAnnotSubType

public final java.lang.String getAnnotSubType(int i)

get area as it is stored in the PDF

getField

public java.lang.String getField(int i,
                                 java.lang.String field)

a text field

getBorderColor

public java.awt.Color getBorderColor(int i)

return color of border or black as default

getPageNumber

public int getPageNumber()