com.qoppa.pdf

Class EmbedFileOptions

java.lang.Object

com.qoppa.pdf.EmbedFileOptions

public class EmbedFileOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
EmbedFileOptions(String desc, String relation) Create an EmbedFileOptions object with the given description and relationship.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the description of the embedded file (to be saved in the embedded file specifications dictionary).
String	getRelationship() Gets the relationship of the embedded file in relation to the document (to be saved in the embedded file specifications dictionary).
boolean	isZugferdInvoice() Returns a boolean indicating whether the embedded file is a ZUGFeRD invoice.
void	setZugferdInvoice(boolean isZugferd) Indicates if the embedded file is a ZUGFeRD invoice.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbedFileOptions

public EmbedFileOptions(String desc,
                        String relation)

Create an EmbedFileOptions object with the given description and relationship. Relationship and Description will be saved in the embedded file specifications dictionary.

Parameters:

desc - The description of the embedded file

relation - The relationship of the embedded file relative to the document

Method Detail

getDescription

public String getDescription()

Gets the description of the embedded file (to be saved in the embedded file specifications dictionary).

Returns:

The description

getRelationship

public String getRelationship()

Gets the relationship of the embedded file in relation to the document (to be saved in the embedded file specifications dictionary).

Returns:

The relationship

setZugferdInvoice

public void setZugferdInvoice(boolean isZugferd)

Indicates if the embedded file is a ZUGFeRD invoice. When this is on, an additional entry will be saved in the root catalog of the document that points to the embedded file.

Parameters:

isZugferd - true or false

isZugferdInvoice

public boolean isZugferdInvoice()

Returns a boolean indicating whether the embedded file is a ZUGFeRD invoice.

Returns:

true or false