Package com.itextpdf.layout.renderer.objectfit

Class ObjectFitApplyingResult

  • public class ObjectFitApplyingResult
extends java.lang.Object
    The class represents results of calculating of rendered image size after applying of the ObjectFit property.

    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectFitApplyingResult()
      Creates a new instance of the class with default values.
      ObjectFitApplyingResult​(double renderedImageWidth, double renderedImageHeight, boolean imageCuttingRequired)
      Creates a new instance of the class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getRenderedImageHeight()
      Getter for height of rendered image.
      double getRenderedImageWidth()
      Getter for width of rendered image.
      boolean isImageCuttingRequired()
      Getter for a boolean value showing if at least one dimension of rendered image is greater than expected image size.
      void setImageCuttingRequired​(boolean imageCuttingRequired)
      Setter for a boolean value showing if at least one dimension of rendered image is greater than expected image size.
      void setRenderedImageHeight​(double renderedImageHeight)
      Setter for height of rendered image.
      void setRenderedImageWidth​(double renderedImageWidth)
      Setter for width of rendered image.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • renderedImageWidth

        private double renderedImageWidth

      • renderedImageHeight

        private double renderedImageHeight

      • imageCuttingRequired

        private boolean imageCuttingRequired

    • Constructor Detail

      • ObjectFitApplyingResult

        public ObjectFitApplyingResult()
        Creates a new instance of the class with default values.

      • ObjectFitApplyingResult

        public ObjectFitApplyingResult​(double renderedImageWidth,
                               double renderedImageHeight,
                               boolean imageCuttingRequired)
        Creates a new instance of the class.
        Parameters:
        renderedImageWidth - is a width of the image to render
        renderedImageHeight - is a height of the image to render
        imageCuttingRequired - is a flag showing if rendered image should be clipped as its size is greater than size of the image container

    • Method Detail

      • getRenderedImageWidth

        public double getRenderedImageWidth()
        Getter for width of rendered image.
        Returns:
        width of rendered image

      • setRenderedImageWidth

        public void setRenderedImageWidth​(double renderedImageWidth)
        Setter for width of rendered image.
        Parameters:
        renderedImageWidth - is a new width of rendered image

      • getRenderedImageHeight

        public double getRenderedImageHeight()
        Getter for height of rendered image.
        Returns:
        height of rendered image

      • setRenderedImageHeight

        public void setRenderedImageHeight​(double renderedImageHeight)
        Setter for height of rendered image.
        Parameters:
        renderedImageHeight - is a new height of rendered image

      • isImageCuttingRequired

        public boolean isImageCuttingRequired()
        Getter for a boolean value showing if at least one dimension of rendered image is greater than expected image size. If true then image will be shown partially
        Returns:
        true if the image need to be cutting during rendering and false otherwise

      • setImageCuttingRequired

        public void setImageCuttingRequired​(boolean imageCuttingRequired)
        Setter for a boolean value showing if at least one dimension of rendered image is greater than expected image size. If true then image will be shown partially
        Parameters:
        imageCuttingRequired - is a new value of the cutting-required flag