Package com.ironsoftware.ironpdf.image

Enum ImageBehavior

java.lang.Object
java.lang.Enum<ImageBehavior>
com.ironsoftware.ironpdf.image.ImageBehavior
All Implemented Interfaces:
Serializable, Comparable<ImageBehavior>, java.lang.constant.Constable
public enum ImageBehavior extends Enum<ImageBehavior>
Defines layout behavior relative to the page size when creating a PDF from images.

See: PdfDocument.fromImage(List, ImageBehavior)

  • Enum Constant Details

    • CENTERED_ON_PAGE

      public static final ImageBehavior CENTERED_ON_PAGE
      Image will be placed on center of the page

    • FIT_TO_PAGE

      public static final ImageBehavior FIT_TO_PAGE
      Image will fit to the defined page size whilst maintaining aspect ratio.

    • FIT_TO_PAGE_AND_MAINTAIN_ASPECT_RATIO

      public static final ImageBehavior FIT_TO_PAGE_AND_MAINTAIN_ASPECT_RATIO
      Image will fit to the page and keep aspect ratio

    • CROP_PAGE

      public static final ImageBehavior CROP_PAGE
      Page will be scaled to exactly match the original image dimensions.

    • TOP_LEFT_CORNER_OF_PAGE

      public static final ImageBehavior TOP_LEFT_CORNER_OF_PAGE
      Image will be placed to the left top corner of the page

    • BOTTOM_LEFT_CORNER_OF_PAGE

      public static final ImageBehavior BOTTOM_LEFT_CORNER_OF_PAGE
      Image will be placed to the left bottom corner of the page

    • TOP_RIGHT_CORNER_OF_PAGE

      public static final ImageBehavior TOP_RIGHT_CORNER_OF_PAGE
      Image will be placed to the right top corner of the page

    • BOTTOM_RIGHT_CORNER_OF_PAGE

      public static final ImageBehavior BOTTOM_RIGHT_CORNER_OF_PAGE
      Image will be placed to the right bottom corner of the page

  • Method Details

    • values

      public static ImageBehavior[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ImageBehavior valueOf(String name)
      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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null