Package nl.talsmasoftware.umldoclet.configuration

Enum ImageConfig.Format

java.lang.Object
java.lang.Enum<ImageConfig.Format>
nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format
All Implemented Interfaces:
Serializable, Comparable<ImageConfig.Format>
Enclosing interface:
ImageConfig
public static enum ImageConfig.Format extends Enum<ImageConfig.Format>
Supported image formats.

  • Enum Constant Details

    • SVG

      public static final ImageConfig.Format SVG
      Value to indicate UML diagrams must be rendered as SVG (scalable vector graphics) images.

      This format is the default and recommended format, as they have the following advantages over the other formats:

      • Size. UML diagrams can be represented as compact SVG images.
      • Scalability. SVG images can be scaled almost without limits.
      • Links. SVG images allow us to embed links in the UML diagrams.

    • SVG_IMG

      public static final ImageConfig.Format SVG_IMG
      This option generates the same images as the SVG images, but embeds them in the generated documentation as plain HTML <img> tags instead of objects.

      This allows loading the documentation in tools like Microsoft Word and keeping the images, where embedded SVG objects are problematic.

      It is recommended as a fallback option if the default SVG option is giving you issues. Links will be embedded inside the SVG images, but will not be clickable in most browsers unfortunately.

    • PNG

      public static final ImageConfig.Format PNG
      Value to indicate UML diagrams must be rendered as PNG (Portable Network Graphics) images.

      This is a raster-graphics format that supports lossless compression. This format is usually only used if SVG is not an option.

    • EPS

      public static final ImageConfig.Format EPS
      Value to indicate UML diagrams must be rendered as EPS (Encapsulated Postscript) images.

      This format is most appropriate for print.

  • Field Details

    • fileExtension

      public final String fileExtension
      The file extension for images of this format.

  • Method Details

    • values

      public static ImageConfig.Format[] 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 ImageConfig.Format 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