Package io.scanbot.pdf.model

Enum PageFit

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum PageFit
extends Enum<PageFit>

    Page fit.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class PageFit.Companion

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FIT_IN

      Fit image into page. May leave white borders if the aspect ratio of the image and the page don't match. Preserves image aspect ratio.
      FILL_IN

      Fill page with image. Will crop the image if the aspect ratio of the image and the page don't match. Preserves image aspect ratio.
      STRETCH

      Stretch image to fill the entire page. The image will never be cropped and there will never be any white borders left, but the image aspect ratio will be made to match the page aspect ratio.
      NONE

      No resizing, centers the image on the page. The physical size of the image will be determined by the dpi parameter.

    • Method Summary

      Modifier and Type Method Description
      final String toJson()
      final PageFit valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<PageFit> values() Returns an array containing the constants of this enum type, in the order they're declared.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • valueOf

         final PageFit valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<PageFit> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.