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

public class PDFEmbeddedFileAttachment extends PDFExtensionAttachment
This is the pass-through value object for the PDF extension.
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • ELEMENT

      protected static final String ELEMENT
      element name
      See Also:
    • ATT_NAME

      private static final String ATT_NAME
      name of file to be embedded
      See Also:
    • ATT_SRC

      private static final String ATT_SRC
      source of file to be embedded (URI)
      See Also:
    • ATT_DESC

      private static final String ATT_DESC
      a description of the file to be embedded
      See Also:
    • filename

      private String filename
      filename attribute
    • unicodeFilename

      private String unicodeFilename
      unicode filename attribute
    • desc

      private String desc
      description attribute (optional)
    • src

      private String src
      source name attribute
  • Constructor Details

    • PDFEmbeddedFileAttachment

      public PDFEmbeddedFileAttachment()
      No-argument contructor.
    • PDFEmbeddedFileAttachment

      public PDFEmbeddedFileAttachment(String filename, String src, String desc)
      Default constructor.
      Parameters:
      filename - the name of the file
      src - the location of the file
      desc - the description of the file
  • Method Details

    • getFilename

      public String getFilename()
      Returns the file name.
      Returns:
      the file name
    • getUnicodeFilename

      public String getUnicodeFilename()
      Returns the unicode file name.
      Returns:
      the file name
    • setFilename

      public void setFilename(String name)
      Sets the file name.
      Parameters:
      name - The file name to set.
    • getDesc

      public String getDesc()
      Returns the file description.
      Returns:
      the description
    • setDesc

      public void setDesc(String desc)
      Sets the description of the file.
      Parameters:
      desc - the description to set
    • getSrc

      public String getSrc()
      Returns the source URI of the file.
      Returns:
      the source URI
    • setSrc

      public void setSrc(String src)
      Sets the source URI of the file.
      Parameters:
      src - the source URI
    • getCategory

      public String 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 interface ExtensionAttachment
      Overrides:
      getCategory in class PDFExtensionAttachment
      Returns:
      the category URI
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getElement

      protected String getElement()
      Returns:
      the element name
    • toSAX

      public void toSAX(ContentHandler handler) throws SAXException
      Throws:
      SAXException