Class PdfRendition


public class PdfRendition extends PdfObjectWrapper<PdfDictionary>
This a wrapper around a rendition dictionary. See ISO 32000-1 sections,
  • Constructor Details

    • PdfRendition

      public PdfRendition (PdfDictionary pdfObject)
      Creates a new wrapper around an existing PdfDictionary
      pdfObject - a rendition object to create a wrapper for
    • PdfRendition

      public PdfRendition (String file, PdfFileSpec fs, String mimeType)
      Creates a new wrapper around a newly created media rendition dictionary object.
      file - a text string specifying the name of the file to display
      fs - a file specification that specifies the actual media data
      mimeType - an ASCII string identifying the type of data
  • Method Details

    • flush

      public void flush()
      To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call PdfObjectWrapper.makeIndirect(PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.
      flush in class PdfObjectWrapper<PdfDictionary>
    • isWrappedObjectMustBeIndirect

      protected boolean isWrappedObjectMustBeIndirect()
      Defines if the object behind this wrapper must be an indirect object in the resultant document.

      If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

      Return value of this method shouldn't depend on any logic, it should return always true or false.
      Specified by:
      isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>
      true if in the resultant document the object behind the wrapper must be indirect, otherwise false.