Enum PageItem.SnapTarget

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PageItem.SnapTarget>
    Enclosing interface:
    PageItem

    public static enum PageItem.SnapTarget
    extends java.lang.Enum<PageItem.SnapTarget>
    An enumeration of the algorithms used to determine the position of an item when it is snapped against another item.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      TARGET_INSIDE
      Items with this target snap to the inside of other items.
      TARGET_MIXED
      Items with this target snap to the inside of cards when they are of different classes.
      TARGET_OUTSIDE
      Items with this target snap to the outside of other items.
    • Method Summary

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

      • TARGET_OUTSIDE

        public static final PageItem.SnapTarget TARGET_OUTSIDE
        Items with this target snap to the outside of other items.
      • TARGET_INSIDE

        public static final PageItem.SnapTarget TARGET_INSIDE
        Items with this target snap to the inside of other items.
      • TARGET_MIXED

        public static final PageItem.SnapTarget TARGET_MIXED
        Items with this target snap to the inside of cards when they are of different classes.
    • Method Detail

      • values

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

        public static PageItem.SnapTarget 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