Package com.pdftools.pdf2image

Enum BackgroundType

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

    The background type to use when rendering into an image

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      TRANSPARENT
      Transparent background
      WHITE
      White background

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BackgroundType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BackgroundType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • WHITE

        public static final BackgroundType WHITE

        White background

        The input PDF content will be rendered on a white background.

      • TRANSPARENT

        public static final BackgroundType TRANSPARENT

        Transparent background

        The input PDF content will be rendered into an image with an alpha channel and no background.

    • Method Detail

      • values

        public static BackgroundType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (BackgroundType c : BackgroundType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BackgroundType valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null