Package com.adobe.internal.pdftoolkit.core.cos

Class CosSaveParams

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class CosSaveParams
extends java.lang.Object
implements java.lang.Cloneable

    • Constructor Summary

      Constructors 
      Constructor Description
      CosSaveParams​(int saveStyle)
      Constructor with specified save style.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Produce a simple, shallow clone.
      boolean getCloseAfterSave()
      Returns true if document to be closed after save.
      java.util.Map getExtensions()
      Returns version extensions.
      boolean getForceCompress()
      Returns true if force compression to be used.
      java.lang.String getHeader()
      Returns header.
      java.lang.String getHeaderToken()
      Returns header token.
      int getSaveStyle()
      Returns save style to save with.
      boolean getSaveToCopy()
      Save the CosDocument to the ByteWriter given during save but do NOT make it the backing store and continue to use the existing one.
      ByteWriter getTempByteWriter()
      Only for internal engineering use.
      java.lang.String getVersion()
      Returns version to save with.
      int getXrefStyle()
      Returns xref style to save with.
      void setCloseAfterSave​(boolean closeAfterSave)
      Sets true if document to be closed after save.
      void setExtensions​(java.util.Map extensions)
      Sets version extensions to use.
      void setForceCompress​(boolean forceCompress)
      Specifies if force compression to be used.
      void setHeader​(java.lang.String header)
      Sets header to sue while saving.
      void setHeaderToken​(java.lang.String headerToken)
      Sets header token.
      void setSaveStyle​(int saveStyle)
      Sets save style to save with.
      void setSaveToCopy​(boolean saveToCopy)
      Save the CosDocument to the ByteWriter given during save but do NOT make it the backing store and continue to use the existing one.
      void setTempByteWriter​(ByteWriter tempByteWriter)
      Only for internal engineering use.
      void setVersion​(java.lang.String version)
      Sets version to save with.
      void setXrefStyle​(int xrefstyle)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CosSaveParams

        public CosSaveParams​(int saveStyle)
        Constructor with specified save style.

    • Method Detail

      • setHeader

        public void setHeader​(java.lang.String header)
        Sets header to sue while saving.

      • getHeader

        public java.lang.String getHeader()
        Returns header.

      • getHeaderToken

        public java.lang.String getHeaderToken()
        Returns header token.

      • setVersion

        public void setVersion​(java.lang.String version)
        Sets version to save with.

      • getVersion

        public java.lang.String getVersion()
        Returns version to save with.

      • getExtensions

        public java.util.Map getExtensions()
        Returns version extensions.

      • setExtensions

        public void setExtensions​(java.util.Map extensions)
        Sets version extensions to use.

      • setXrefStyle

        public void setXrefStyle​(int xrefstyle)
        Parameters:
        xrefstyle - - int enum for specifying full save xref style: CURRENT_XREF - use existing style (default for existing document) XREFTABLE - xref table (default for new document) XREFSTREAM - xref stream (required if compressed object streams) XREFHYBRID - hybrid (compressed object streams only visible to v 1.5 or later)

      • getXrefStyle

        public int getXrefStyle()
        Returns xref style to save with.

      • setSaveStyle

        public void setSaveStyle​(int saveStyle)
        Sets save style to save with.

      • getSaveStyle

        public int getSaveStyle()
        Returns save style to save with.

      • setCloseAfterSave

        public void setCloseAfterSave​(boolean closeAfterSave)
        Sets true if document to be closed after save.

      • getCloseAfterSave

        public boolean getCloseAfterSave()
        Returns true if document to be closed after save.

      • setForceCompress

        public void setForceCompress​(boolean forceCompress)
        Specifies if force compression to be used.

      • getForceCompress

        public boolean getForceCompress()
        Returns true if force compression to be used.

      • setTempByteWriter

        public void setTempByteWriter​(ByteWriter tempByteWriter)
        Only for internal engineering use. This api can change without notice.

      • getTempByteWriter

        public ByteWriter getTempByteWriter()
        Only for internal engineering use. This api can change without notice.

      • setSaveToCopy

        public void setSaveToCopy​(boolean saveToCopy)
        Save the CosDocument to the ByteWriter given during save but do NOT make it the backing store and continue to use the existing one.
        Parameters:
        saveToCopy - will document be saved as a copy

      • getSaveToCopy

        public boolean getSaveToCopy()
        Save the CosDocument to the ByteWriter given during save but do NOT make it the backing store and continue to use the existing one.

      • clone

        public java.lang.Object clone()
        Produce a simple, shallow clone.