org.jpedal.objects.acroforms.creation

Class AnnotationFactory

java.lang.Object

org.jpedal.objects.acroforms.creation.AnnotationFactory

public class AnnotationFactory
extends Object

Constructor Summary

Constructors

Constructor and Description
AnnotationFactory()

Method Summary

Modifier and Type	Method and Description
static String	getCurrentDateAsString() Create a String to represent the current date.
static BufferedImage	getIcon(PdfObject form) Determine the type of annotation from the sub type value and call appropriate method to create an icon for the annotation
static BufferedImage	getIcon(PdfObject form, float scaling) Determine the type of annotation from the sub type value and call appropriate method to create an icon for the annotation with the given scaling applied
static String	getPngImageForAnnotation(PdfObject form) Get the image to be used to display an annotation based on the Name variable it contains.
static BufferedImage	getTextIcon(PdfObject form) Get the Icon to be used for Text annotations
static void	loadFontValues(byte[] DS, Component textInput, float scaling) Load the font style described in a DS string into a Component for use by some annotations (e.g FreeText annotations).
static void	renderFlattenedAnnotation(PdfObject form, DynamicVectorRenderer current, int pageNumber, int rotation) Method to create an icon to represent the annotation and render it.
static float[]	scanInkListTree(Object[] InkListArray, PdfObject form, Graphics g) Method to scan through an InkList array, draw the ink to the provided Graphics object and return the bounds of the InkList
static float[]	scanInkListTree(Object[] InkListArray, PdfObject form, Graphics g, float scaling) Method to scan through an InkList array, draw the ink to the provided Graphics object at the specified scaling and return the bounds of the InkList

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationFactory

public AnnotationFactory()

Method Detail

getIcon

public static BufferedImage getIcon(PdfObject form)

Determine the type of annotation from the sub type value and call appropriate method to create an icon for the annotation

Parameters:

form - PdfObject containing the annotation

Returns:

BufferedImage of the annotation or null if the supplied FormObject contains errors

getIcon

public static BufferedImage getIcon(PdfObject form,
                                    float scaling)

Determine the type of annotation from the sub type value and call appropriate method to create an icon for the annotation with the given scaling applied

Parameters:

form - PdfObject containing the annotation

scaling - Scaling to display the annotation at

Returns:

BufferedImage of the annotation or null if the supplied FormObject contains errors

scanInkListTree

public static float[] scanInkListTree(Object[] InkListArray,
                                      PdfObject form,
                                      Graphics g)

Method to scan through an InkList array, draw the ink to the provided Graphics object and return the bounds of the InkList

Parameters:

InkListArray - Object array representing an InkList

form - FormObject for the Ink annotation this InkList came from

g - Graphics object to draw the Ink to

Returns:

float array representing the Inks bounds in the order lowest x / y, largest x / x

scanInkListTree

public static float[] scanInkListTree(Object[] InkListArray,
                                      PdfObject form,
                                      Graphics g,
                                      float scaling)

Method to scan through an InkList array, draw the ink to the provided Graphics object at the specified scaling and return the bounds of the InkList

Parameters:

InkListArray - Object array representing an InkList

form - FormObject representing the Ink annotation this InkList came from

g - Graphics object to draw the Ink to

scaling - float value representing scaling where 1 equals 100%

Returns:

float array representing the Inks bounds in the order lowest x / y, largest x / x

getTextIcon

public static BufferedImage getTextIcon(PdfObject form)

Get the Icon to be used for Text annotations

Parameters:

form - PdfObject representing a TextAnnotation

Returns:

BufferedImage representing the icon for this annotation

loadFontValues

public static void loadFontValues(byte[] DS,
                                  Component textInput,
                                  float scaling)

Load the font style described in a DS string into a Component for use by some annotations (e.g FreeText annotations).

Parameters:

DS - byte[] representing the DS string

textInput - Component to be used by a given annotation

scaling - float value representing scaling where 1 is equal to 100%

getPngImageForAnnotation

public static String getPngImageForAnnotation(PdfObject form)

Get the image to be used to display an annotation based on the Name variable it contains. This method is intended for internal use with Text annotations only.

Parameters:

form - PdfObject representing a form Object

Returns:

String value representing the location of the image to use

renderFlattenedAnnotation

public static void renderFlattenedAnnotation(PdfObject form,
                                             DynamicVectorRenderer current,
                                             int pageNumber,
                                             int rotation)

Method to create an icon to represent the annotation and render it.

Parameters:

form - :: PdfObject to hold the annotation data

current - :: DynamicVectorRender to draw the annotation

pageNumber - :: Int value of the page number

rotation - :: Int value of the page rotation

getCurrentDateAsString

public static String getCurrentDateAsString()

Create a String to represent the current date.

Returns:

String representing the current date. The String has the format "D:YYYYMMDDHHMMSS" For instance January 1, 2000, 11:58:55 become D:20000101115855