com.cete.dynamicpdf
Class EmbeddedFile

java.lang.Object
  com.cete.dynamicpdf.EmbeddedFile

public class EmbeddedFile
extends java.lang.Object

Represents a PDF document's EmbeddedFile entry.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

EmbeddedFile(byte[] file, java.lang.String fileName, java.util.Date modifiedDate)
Initializes a new instance of the EmbeddedFile class.

EmbeddedFile(java.io.FileInputStream file, java.lang.String fileName, java.util.Date modifiedDate)
Initializes a new instance of the EmbeddedFile class.

EmbeddedFile(java.lang.String filePath)
Initializes a new instance of the EmbeddedFile class.

Method Summary

void	drawReference(DocumentWriter writer) Draws a reference to the EmbeddedFile indirect object.
java.lang.String	fileName() Gets the file name of the embedded file.
java.lang.String	getDescription() Gets the description of the embedded file.
java.lang.String	getMimeType() Gets the mime type of the embedded file.
EmbeddedFileRelation	getRelation() Gets the embedded file relation.
void	setDescription(java.lang.String value) Sets the description of the embedded file.
void	setFileName(java.lang.String value) Sets the file name of the embedded file.
void	setMimeType(java.lang.String value) Sets the mime type of the embedded file.
void	setRelation(EmbeddedFileRelation value) Sets the embedded file relation.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedFile

public EmbeddedFile(byte[] file,
                    java.lang.String fileName,
                    java.util.Date modifiedDate)

Initializes a new instance of the EmbeddedFile class.

Parameters:

file - The byte array of the file need to be embedded

fileName - Name of the file embedded

modifiedDate - Last modifieddate of the file

See Also:

EmbeddedFile

EmbeddedFile

public EmbeddedFile(java.io.FileInputStream file,
                    java.lang.String fileName,
                    java.util.Date modifiedDate)

Initializes a new instance of the EmbeddedFile class.

Parameters:

file - The FileStream of the file need to be embedded

fileName - Name of the file embedded

modifiedDate - Last modifieddate of the file

See Also:

EmbeddedFile

EmbeddedFile

public EmbeddedFile(java.lang.String filePath)

Initializes a new instance of the EmbeddedFile class.

Parameters:

filePath - The physical path to the file need to be embedded

See Also:

EmbeddedFile

Method Detail

drawReference

public void drawReference(DocumentWriter writer)

Draws a reference to the EmbeddedFile indirect object.

Parameters:

writer - DocumentWriter object to receive the embedded file indirect object.

See Also:

DocumentWriter

fileName

public java.lang.String fileName()

Gets the file name of the embedded file.

Returns:

string the file name of the embedded file.

setFileName

public void setFileName(java.lang.String value)

Sets the file name of the embedded file.

Parameters:

value - The string value indicates the file name of the embedded file.

getRelation

public EmbeddedFileRelation getRelation()

Gets the embedded file relation.

Returns:

string value. The embedded file relation.

setRelation

public void setRelation(EmbeddedFileRelation value)

Sets the embedded file relation.

Parameters:

value - The string value specifies the embedded file relation.

getMimeType

public java.lang.String getMimeType()

Gets the mime type of the embedded file.

Returns:

string value. The mime type of the embedded file.

setMimeType

public void setMimeType(java.lang.String value)

Sets the mime type of the embedded file.

Parameters:

value - The string value specifies the mime type of the embedded file.

getDescription

public java.lang.String getDescription()

Gets the description of the embedded file.

Returns:

string value. The description of the embedded file.

setDescription

public void setDescription(java.lang.String value)

Sets the description of the embedded file.

Parameters:

value - The string value specifies the description of the embedded file.