Package org.apache.poi.hemf.record.emfplus

Enum HemfPlusImage.EmfPlusPixelFormat

    • Field Detail

      • id

        public final int id

    • Method Detail

      • values

        public static HemfPlusImage.EmfPlusPixelFormat[] 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 (HemfPlusImage.EmfPlusPixelFormat c : HemfPlusImage.EmfPlusPixelFormat.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HemfPlusImage.EmfPlusPixelFormat 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

      • valueOf

        public static HemfPlusImage.EmfPlusPixelFormat valueOf​(int id)
        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:
        id - 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

      • getGDIEnumIndex

        public int getGDIEnumIndex()
        The pixel format enumeration index.

      • getBitsPerPixel

        public int getBitsPerPixel()
        The total number of bits per pixel.

      • isPaletteIndexed

        public boolean isPaletteIndexed()
        If set, the pixel values are indexes into a palette. If clear, the pixel values are actual colors.

      • isGDISupported

        public boolean isGDISupported()
        If set, the pixel format is supported in Windows GDI. If clear, the pixel format is not supported in Windows GDI.

      • isAlpha

        public boolean isAlpha()
        If set, the pixel format includes an alpha transparency component. If clear, the pixel format does not include a component that specifies transparency.

      • isPreMultiplied

        public boolean isPreMultiplied()
        If set, each color component in the pixel has been premultiplied by the pixel's alpha transparency value. If clear, each color component is multiplied by the pixel's alpha transparency value when the source pixel is blended with the destination pixel.

      • isExtendedColors

        public boolean isExtendedColors()
        If set, the pixel format supports extended colors in 16-bits per channel. If clear, extended colors are not supported.

      • isCanonical

        public boolean isCanonical()
        If set, the pixel format is "canonical", which means that 32 bits per pixel are supported, with 24-bits for color components and an 8-bit alpha channel. If clear, the pixel format is not canonical.