Annotation Interface OverlayPanel


@Retention(RUNTIME) @Target(TYPE) @Documented public @interface OverlayPanel
Declares a class as a simple annotation-rendered overlay panel.

Annotated overlay panel classes should implement OverlayBinding so they can be referenced from PluginDescriptor#overlay().

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    Heading and accent color in ARGB format.
    int
    Panel background color in ARGB format.
    int
    Panel border color in ARGB format.
    int
    Gap between text columns in pixels.
    int
    Number of text columns in the panel.
    int
    Corner arc used by the panel background.
    int
    Font size used for text rows.
    int
    Gap between text rows in pixels.
    int
    Horizontal panel padding in pixels.
    int
    Vertical panel padding in pixels.
    Panel anchor position.
    int
    Text color in ARGB format.
    Optional heading rendered above text rows.
    int
    Horizontal inset from the canvas edge.
    int
    Vertical inset from the canvas edge.
  • Element Details

    • position

      OverlayPosition position
      Panel anchor position.
      Default:
      TOP_LEFT
    • x

      int x
      Horizontal inset from the canvas edge.
      Default:
      8
    • y

      int y
      Vertical inset from the canvas edge.
      Default:
      8
    • title

      String title
      Optional heading rendered above text rows.
      Default:
      ""
    • text

      int text
      Text color in ARGB format.
      Default:
      -2630168
    • accent

      int accent
      Heading and accent color in ARGB format.
      Default:
      -8530948
    • background

      int background
      Panel background color in ARGB format.
      Default:
      -670363368
    • border

      int border
      Panel border color in ARGB format. Use 0 for no border.
      Default:
      2050049628
    • fontSize

      int fontSize
      Font size used for text rows.
      Default:
      10
    • paddingX

      int paddingX
      Horizontal panel padding in pixels.
      Default:
      10
    • paddingY

      int paddingY
      Vertical panel padding in pixels.
      Default:
      8
    • gap

      int gap
      Gap between text rows in pixels.
      Default:
      3
    • columns

      int columns
      Number of text columns in the panel.
      Default:
      1
    • columnGap

      int columnGap
      Gap between text columns in pixels.
      Default:
      18
    • cornerArc

      int cornerArc
      Corner arc used by the panel background.
      Default:
      8