Class PDFEmbeddedFileAttachment
java.lang.Object
org.apache.fop.render.pdf.extensions.PDFExtensionAttachment
org.apache.fop.render.pdf.extensions.PDFEmbeddedFileAttachment
- All Implemented Interfaces:
ExtensionAttachment
,org.apache.xmlgraphics.util.XMLizable
This is the pass-through value object for the PDF extension.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
a description of the file to be embeddedprivate static final String
name of file to be embeddedprivate static final String
source of file to be embedded (URI)private String
description attribute (optional)protected static final String
element nameprivate String
filename attributeprivate static final long
private String
source name attributeprivate String
unicode filename attributeFields inherited from class org.apache.fop.render.pdf.extensions.PDFExtensionAttachment
CATEGORY, PREFIX
-
Constructor Summary
ConstructorsConstructorDescriptionNo-argument contructor.PDFEmbeddedFileAttachment
(String filename, String src, String desc) Default constructor. -
Method Summary
Modifier and TypeMethodDescriptionThis method returns a category URI that allows a processor (layout manager or renderer) to determine if it supports this object.getDesc()
Returns the file description.protected String
Returns the file name.getSrc()
Returns the source URI of the file.Returns the unicode file name.void
Sets the description of the file.void
setFilename
(String name) Sets the file name.void
Sets the source URI of the file.void
toSAX
(ContentHandler handler) toString()
Methods inherited from class org.apache.fop.render.pdf.extensions.PDFExtensionAttachment
getPrefix
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
ELEMENT
element name- See Also:
-
ATT_NAME
name of file to be embedded- See Also:
-
ATT_SRC
source of file to be embedded (URI)- See Also:
-
ATT_DESC
a description of the file to be embedded- See Also:
-
filename
filename attribute -
unicodeFilename
unicode filename attribute -
desc
description attribute (optional) -
src
source name attribute
-
-
Constructor Details
-
PDFEmbeddedFileAttachment
public PDFEmbeddedFileAttachment()No-argument contructor. -
PDFEmbeddedFileAttachment
Default constructor.- Parameters:
filename
- the name of the filesrc
- the location of the filedesc
- the description of the file
-
-
Method Details
-
getFilename
Returns the file name.- Returns:
- the file name
-
getUnicodeFilename
Returns the unicode file name.- Returns:
- the file name
-
setFilename
Sets the file name.- Parameters:
name
- The file name to set.
-
getDesc
Returns the file description.- Returns:
- the description
-
setDesc
Sets the description of the file.- Parameters:
desc
- the description to set
-
getSrc
Returns the source URI of the file.- Returns:
- the source URI
-
setSrc
Sets the source URI of the file.- Parameters:
src
- the source URI
-
getCategory
This method returns a category URI that allows a processor (layout manager or renderer) to determine if it supports this object.- Specified by:
getCategory
in interfaceExtensionAttachment
- Overrides:
getCategory
in classPDFExtensionAttachment
- Returns:
- the category URI
-
toString
-
getElement
- Returns:
- the element name
-
toSAX
- Throws:
SAXException
-