Package net.coobird.thumbnailator.geometry

Enum Positions

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Positions>, Position
    public enum Positions
extends java.lang.Enum<Positions>
implements Position
    An enum of predefined Positions.

    Primary use of this enum is for selecting a position to place watermarks (using the Watermark class), captions (using the Caption class) and other ImageFilters.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOTTOM_CENTER
      Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the bottom of the enclosing image.
      BOTTOM_LEFT
      Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom left-hand corner of the enclosing image.
      BOTTOM_RIGHT
      Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom right-hand corner of the enclosing image.
      CENTER
      Calculates the Point at which an enclosed image should be placed horizontally and vertically centered in the enclosing image.
      CENTER_LEFT
      Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the left-hand corner of the enclosing image.
      CENTER_RIGHT
      Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the right-hand corner of the enclosing image.
      TOP_CENTER
      Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the top of the enclosing image.
      TOP_LEFT
      Calculates the Point at which an enclosed image should be placed if it is to be placed at the top left-hand corner of the enclosing image.
      TOP_RIGHT
      Calculates the Point at which an enclosed image should be placed if it is to be placed at the top right-hand corner of the enclosing image.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Positions()  

    • Method Summary

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

      • TOP_LEFT

        public static final Positions TOP_LEFT
        Calculates the Point at which an enclosed image should be placed if it is to be placed at the top left-hand corner of the enclosing image.

      • TOP_CENTER

        public static final Positions TOP_CENTER
        Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the top of the enclosing image.

      • TOP_RIGHT

        public static final Positions TOP_RIGHT
        Calculates the Point at which an enclosed image should be placed if it is to be placed at the top right-hand corner of the enclosing image.

      • CENTER_LEFT

        public static final Positions CENTER_LEFT
        Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the left-hand corner of the enclosing image.

      • CENTER

        public static final Positions CENTER
        Calculates the Point at which an enclosed image should be placed horizontally and vertically centered in the enclosing image.

      • CENTER_RIGHT

        public static final Positions CENTER_RIGHT
        Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the right-hand corner of the enclosing image.

      • BOTTOM_LEFT

        public static final Positions BOTTOM_LEFT
        Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom left-hand corner of the enclosing image.

      • BOTTOM_CENTER

        public static final Positions BOTTOM_CENTER
        Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the bottom of the enclosing image.

      • BOTTOM_RIGHT

        public static final Positions BOTTOM_RIGHT
        Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom right-hand corner of the enclosing image.

    • Constructor Detail

      • Positions

        private Positions()

    • Method Detail

      • values

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

      • valueOf

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