com.datalogics.PDFL

Class FileAttachment

java.lang.Object

com.datalogics.PDFL.FileAttachment

public class FileAttachment
extends java.lang.Object

A file attachment. Any file can be attached to the PDF document. The class allows to create attachment and manipulate by its content.

Constructor Summary

Constructors

Constructor and Description
FileAttachment(Document doc, java.lang.String fileName) Allows to add attachment into the PDF document.

Method Summary

Modifier and Type	Method and Description
void	delete()
float	getCollectionItemNumber(CollectionSchemaField collectionField) GetCollectionItemNumber allows to obtain collection item according to the specified schema field.
java.lang.String	getCollectionItemString(CollectionSchemaField collectionField) GetCollectionItemString allows to obtain collection item value according to the specified schema field.
java.lang.String	getFileName() Allow to obtain attachment's file name.
long	getFileSize() Allows to obtain attachment's size.
void	saveToFile(java.lang.String fileName) Allows to save attachment to the specified file.
void	saveToStream(javax.imageio.stream.ImageOutputStream stream) Saves a FileAttachment to a javax.imageio.stream.ImageInputStream.
void	setCollectionItemNumber(CollectionSchemaField collectionField, float value) SetCollectionItemNumber allows to add key to the collection item dictionary.
void	setCollectionItemString(CollectionSchemaField collectionField, java.lang.String value) SetCollectionItemString allows to add key to the collection item dictionary.
void	updateFromFile(java.lang.String fileName) Allows to update attachment from another file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileAttachment

public FileAttachment(Document doc,
                      java.lang.String fileName)

Allows to add attachment into the PDF document.

Parameters:

doc - The PDF document (reference).

fileName - The path to file which will be attached to the document.

Method Detail

delete

public void delete()

saveToStream

public void saveToStream(javax.imageio.stream.ImageOutputStream stream)
                  throws java.io.IOException

Saves a FileAttachment to a javax.imageio.stream.ImageInputStream.

Parameters:

stream - The stream from which to save the FileAttachment.

Throws:

java.io.IOException

saveToFile

public void saveToFile(java.lang.String fileName)

Allows to save attachment to the specified file.

Parameters:

fileName - The path where attachment will be saved.

updateFromFile

public void updateFromFile(java.lang.String fileName)

Allows to update attachment from another file.

Parameters:

fileName - The path to the file from which attachment will be updated.

getFileSize

public long getFileSize()

Allows to obtain attachment's size.

Returns:

The attachment's size in bytes.

getFileName

public java.lang.String getFileName()

Allow to obtain attachment's file name.

Returns:

The attachment's file name.

setCollectionItemNumber

public void setCollectionItemNumber(CollectionSchemaField collectionField,
                                    float value)

SetCollectionItemNumber allows to add key to the collection item dictionary.

Parameters:

collectionField - schema field which contains information about data type. The parameter's subtype should be a Number.

value - the item's value.

getCollectionItemNumber

public float getCollectionItemNumber(CollectionSchemaField collectionField)

GetCollectionItemNumber allows to obtain collection item according to the specified schema field.

Parameters:

collectionField - the field for which item value should be retrieved.

Returns:

collection items value

setCollectionItemString

public void setCollectionItemString(CollectionSchemaField collectionField,
                                    java.lang.String value)

SetCollectionItemString allows to add key to the collection item dictionary.

Parameters:

collectionField - schema field which contains information about data type. The parameter's subtype should be a Text.

value - the item's value.

getCollectionItemString

public java.lang.String getCollectionItemString(CollectionSchemaField collectionField)

GetCollectionItemString allows to obtain collection item value according to the specified schema field.

Parameters:

collectionField - the field for which item value should be retrieved.

Returns:

collection items value