AFPRendererOption (Apache FOP Core 2.11 API)
Date: 2025-04-24

org.apache.fop.render.afp

## Enum AFPRendererOption

- java.lang.Object
- - java.lang.Enum<AFPRendererOption>
  - - org.apache.fop.render.afp.AFPRendererOption

- All Implemented Interfaces:
    Serializable, Comparable<AFPRendererOption>, RendererConfigOption

      public enum AFPRendererOption
      extends Enum<AFPRendererOption>
      implements RendererConfigOption

  An enumeration of the configuration options available for the AFP renderer.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `DEFAULT_RESOURCE_LEVELS`
    `GOCA`
    `GOCA_TEXT`
    `GOCA_WRAP_PSEG`
    `IMAGES`
    `IMAGES_DITHERING_QUALITY`
    `IMAGES_FS45`
    `IMAGES_JPEG`
    `IMAGES_MAPPING_OPTION`
    `IMAGES_MASK_ENABLED`
    `IMAGES_MODE`
    `IMAGES_NATIVE`
    `IMAGES_NATIVE_PDF`
    `IMAGES_WRAP_PSEG`
    `JPEG_ALLOW_JPEG_EMBEDDING`
    `JPEG_BITMAP_ENCODING_QUALITY`
    `JPEG_USE_IOCA_IMAGES`
    `LINE_WIDTH_CORRECTION`
    `RENDERER_RESOLUTION`
    `RESOURCE_GROUP_URI`
    `SHADING`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Object` | `getDefaultValue()`
    `String` | `getName()` The name of the option.
    `Class<?>` | `getType()`
    `static AFPRendererOption` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static AFPRendererOption[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### DEFAULT_RESOURCE_LEVELS

          public static final AFPRendererOption DEFAULT_RESOURCE_LEVELS

    - #### IMAGES

          public static final AFPRendererOption IMAGES

    - #### IMAGES_JPEG

          public static final AFPRendererOption IMAGES_JPEG

    - #### IMAGES_DITHERING_QUALITY

          public static final AFPRendererOption IMAGES_DITHERING_QUALITY

    - #### IMAGES_FS45

          public static final AFPRendererOption IMAGES_FS45

    - #### IMAGES_MASK_ENABLED

          public static final AFPRendererOption IMAGES_MASK_ENABLED

    - #### IMAGES_MAPPING_OPTION

          public static final AFPRendererOption IMAGES_MAPPING_OPTION

    - #### IMAGES_MODE

          public static final AFPRendererOption IMAGES_MODE

    - #### IMAGES_NATIVE

          public static final AFPRendererOption IMAGES_NATIVE

    - #### IMAGES_NATIVE_PDF

          public static final AFPRendererOption IMAGES_NATIVE_PDF

    - #### IMAGES_WRAP_PSEG

          public static final AFPRendererOption IMAGES_WRAP_PSEG

    - #### JPEG_ALLOW_JPEG_EMBEDDING

          public static final AFPRendererOption JPEG_ALLOW_JPEG_EMBEDDING

    - #### JPEG_BITMAP_ENCODING_QUALITY

          public static final AFPRendererOption JPEG_BITMAP_ENCODING_QUALITY

    - #### JPEG_USE_IOCA_IMAGES

          public static final AFPRendererOption JPEG_USE_IOCA_IMAGES

    - #### RENDERER_RESOLUTION

          public static final AFPRendererOption RENDERER_RESOLUTION

    - #### RESOURCE_GROUP_URI

          public static final AFPRendererOption RESOURCE_GROUP_URI

    - #### SHADING

          public static final AFPRendererOption SHADING

    - #### LINE_WIDTH_CORRECTION

          public static final AFPRendererOption LINE_WIDTH_CORRECTION

    - #### GOCA

          public static final AFPRendererOption GOCA

    - #### GOCA_WRAP_PSEG

          public static final AFPRendererOption GOCA_WRAP_PSEG

    - #### GOCA_TEXT

          public static final AFPRendererOption GOCA_TEXT

  - ### Method Detail

    - #### values

          public static AFPRendererOption[] 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 (AFPRendererOption c : AFPRendererOption.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static AFPRendererOption 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

    - #### getName

          public String getName()

      The name of the option.}
      Specified by:
        `getName` in interface `RendererConfigOption`

    - #### getType

          public Class<?> getType()

    - #### getDefaultValue

          public Object getDefaultValue()

      Specified by:
        `getDefaultValue` in interface `RendererConfigOption`

Copyright © 2025 Apache Software Foundation. All rights reserved.