Enum RectangleAnchor

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RectangleAnchor>

    public enum RectangleAnchor
    extends java.lang.Enum<RectangleAnchor>
    Used to indicate an anchor point for a rectangle.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String name
      The name.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private RectangleAnchor​(java.lang.String name)
      Private constructor.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.awt.geom.Rectangle2D createRectangle​(Size2D dimensions, double anchorX, double anchorY, RectangleAnchor anchor)
      Creates a new rectangle with the specified dimensions that is aligned to the given anchor point (anchorX, anchorY).
      java.awt.geom.Point2D getAnchorPoint​(java.awt.geom.Rectangle2D rectangle)
      Returns the anchor point relative to the specified rectangle.
      java.lang.String toString()
      Returns a string representing the object.
      static RectangleAnchor valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RectangleAnchor[] 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, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • name

        private final java.lang.String name
        The name.
    • Constructor Detail

      • RectangleAnchor

        private RectangleAnchor​(java.lang.String name)
        Private constructor.
        Parameters:
        name - the name.
    • Method Detail

      • values

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

        public static RectangleAnchor 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
      • getAnchorPoint

        public java.awt.geom.Point2D getAnchorPoint​(java.awt.geom.Rectangle2D rectangle)
        Returns the anchor point relative to the specified rectangle.
        Parameters:
        rectangle - the rectangle (null not permitted).
        Returns:
        The anchor point (never null).
      • toString

        public java.lang.String toString()
        Returns a string representing the object.
        Overrides:
        toString in class java.lang.Enum<RectangleAnchor>
        Returns:
        The string.
      • createRectangle

        public static java.awt.geom.Rectangle2D createRectangle​(Size2D dimensions,
                                                                double anchorX,
                                                                double anchorY,
                                                                RectangleAnchor anchor)
        Creates a new rectangle with the specified dimensions that is aligned to the given anchor point (anchorX, anchorY).
        Parameters:
        dimensions - the dimensions (null not permitted).
        anchorX - the x-anchor.
        anchorY - the y-anchor.
        anchor - the anchor (null not permitted).
        Returns:
        A rectangle.