Class FormatRenderProperties


  • public class FormatRenderProperties
    extends java.lang.Object
    Defines a set of render properties for a specified format. Used by VirtualViewer to remember properties set in the web.xml.
    • Constructor Summary

      Constructors 
      Constructor Description
      FormatRenderProperties​(int bitDepth, int dpi, int format)
      Create a set of render properties for the given format.
      FormatRenderProperties​(int bitDepth, int dpi, int format, double width, double height)
      Create a set of render properties for the given format.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getBitDepth()  
      int getDpi()  
      double getHeight()  
      int getMaxPageRender()
      As a way to control memory use, this will be passed in to SnowDocFactory and limit how many pages of an xlsx will be rendered.
      int getRenderFormat()  
      double getWidth()  
      void setBitDepth​(int bitDepth)  
      void setDpi​(int dpi)  
      void setFormat​(int format)  
      void setHeight​(double height)  
      void setMaxPageRender​(int maximumPagesToRender)
      As a way to control memory use, this will be passed in to SnowDocFactory and limit how many pages of an xlsx will be rendered.
      void setWidth​(double width)  
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FormatRenderProperties

        public FormatRenderProperties​(int bitDepth,
                                      int dpi,
                                      int format)
        Create a set of render properties for the given format.
        Parameters:
        bitDepth - number of bits used for color information
        dpi - dots per inch
        format - format type code
      • FormatRenderProperties

        public FormatRenderProperties​(int bitDepth,
                                      int dpi,
                                      int format,
                                      double width,
                                      double height)
        Create a set of render properties for the given format.
        Parameters:
        bitDepth - number of bits used for color information
        dpi - dots per inch
        format - format type code
        width - default width
        height - default height
    • Method Detail

      • getBitDepth

        public int getBitDepth()
        Returns:
        number of bits used for color information
      • setBitDepth

        public void setBitDepth​(int bitDepth)
        Parameters:
        bitDepth - the bitDepth to set
      • getDpi

        public int getDpi()
        Returns:
        dpi
      • setDpi

        public void setDpi​(int dpi)
        Parameters:
        dpi - the dpi to set
      • getRenderFormat

        public int getRenderFormat()
        Returns:
        the format
      • setFormat

        public void setFormat​(int format)
        Parameters:
        format - the format to set
      • getWidth

        public double getWidth()
        Returns:
        the width
      • setWidth

        public void setWidth​(double width)
        Parameters:
        width - default width to set
      • getHeight

        public double getHeight()
        Returns:
        height
      • setHeight

        public void setHeight​(double height)
        Parameters:
        height - default height to set
      • setMaxPageRender

        public void setMaxPageRender​(int maximumPagesToRender)
        As a way to control memory use, this will be passed in to SnowDocFactory and limit how many pages of an xlsx will be rendered. It is not currently used for formats other than xlsx.
        Parameters:
        maximumPagesToRender - Limit how many pages of an xlsx will be rendered
      • getMaxPageRender

        public int getMaxPageRender()
        As a way to control memory use, this will be passed in to SnowDocFactory and limit how many pages of an xlsx will be rendered. It is not currently used for formats other than xlsx.
        Returns:
        how many pages of an xlsx will be rendered