Package net.runelite.client.ui.overlay

Enum OverlayPosition

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OverlayPosition>
    public enum OverlayPosition
extends java.lang.Enum<OverlayPosition>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABOVE_CHATBOX_RIGHT
      Place overlay directly above right side of chatbox
      BOTTOM_LEFT
      Place overlay in the bottom left viewport area
      BOTTOM_RIGHT
      Place overlay in the bottom right viewport area
      CANVAS_TOP_RIGHT
      Place overlay in the top right most area possible
      DETACHED
      Deprecated.
      DYNAMIC
      Overlay places itself where it wants
      TOOLTIP
      Tooltip overlay
      TOP_CENTER
      Place overlay in the top center viewport area
      TOP_LEFT
      Place overlay in the top left viewport area
      TOP_RIGHT
      Place overlay in the top right viewport area

    • Method Summary

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

      • DETACHED

        @Deprecated
public static final OverlayPosition DETACHED
        Deprecated.
        Not attached anywhere, but still movable Deprecated. Use DYNAMIC and setMovable(true)

      • DYNAMIC

        public static final OverlayPosition DYNAMIC
        Overlay places itself where it wants

      • TOP_LEFT

        public static final OverlayPosition TOP_LEFT
        Place overlay in the top left viewport area

      • TOP_CENTER

        public static final OverlayPosition TOP_CENTER
        Place overlay in the top center viewport area

      • TOP_RIGHT

        public static final OverlayPosition TOP_RIGHT
        Place overlay in the top right viewport area

      • BOTTOM_LEFT

        public static final OverlayPosition BOTTOM_LEFT
        Place overlay in the bottom left viewport area

      • BOTTOM_RIGHT

        public static final OverlayPosition BOTTOM_RIGHT
        Place overlay in the bottom right viewport area

      • ABOVE_CHATBOX_RIGHT

        public static final OverlayPosition ABOVE_CHATBOX_RIGHT
        Place overlay directly above right side of chatbox

      • CANVAS_TOP_RIGHT

        public static final OverlayPosition CANVAS_TOP_RIGHT
        Place overlay in the top right most area possible

    • Method Detail

      • values

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

      • valueOf

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