Package org.mapfish.print.attribute.map

Enum AreaOfInterest.AoiDisplay

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLIP
      Set a clip for the area (IE only show the area of interest).
      NONE
      Do not show the Area of interest on the map.
      RENDER
      Draw the entire map and render the AOI polygon on the map.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AreaOfInterest.AoiDisplay valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AreaOfInterest.AoiDisplay[] 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

      • RENDER

        public static final AreaOfInterest.AoiDisplay RENDER
        Draw the entire map and render the AOI polygon on the map. This is the default.

      • NONE

        public static final AreaOfInterest.AoiDisplay NONE
        Do not show the Area of interest on the map. In this case another processor will likely make use of the AOI.

    • Method Detail

      • values

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

      • valueOf

        public static AreaOfInterest.AoiDisplay 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