icy.painter

Enum Overlay.OverlayPriority

java.lang.Object

java.lang.Enum<Overlay.OverlayPriority>

icy.painter.Overlay.OverlayPriority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Overlay.OverlayPriority>

Enclosing class:

Overlay

public static enum Overlay.OverlayPriority
extends java.lang.Enum<Overlay.OverlayPriority>

Define the overlay priority:

 Lowest   |   BACKGROUND  (below image)
          |   IMAGE       (image level)
          |   SHAPE       (just over the image)
          |   TEXT        (over image and shape)
          |   TOOLTIP     (all over the rest)
 Highest  |   TOPMOST     (absolute topmost)
 

You have 4 levels for each category (except TOPMOST) for finest adjustment:

 Lowest   |   LOW
          |   NORMAL
          |   HIGH
 Highest  |   TOP
 

TOP level should be used to give focus to a specific Overlay over all other in the same category.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKGROUND_HIGH
BACKGROUND_LOW
BACKGROUND_NORMAL
BACKGROUND_TOP
IMAGE_HIGH
IMAGE_LOW
IMAGE_NORMAL
IMAGE_TOP
SHAPE_HIGH
SHAPE_LOW
SHAPE_NORMAL
SHAPE_TOP
TEXT_HIGH
TEXT_LOW
TEXT_NORMAL
TEXT_TOP
TOOLTIP_HIGH
TOOLTIP_LOW
TOOLTIP_NORMAL
TOOLTIP_TOP
TOPMOST

Method Summary

Methods

Modifier and Type	Method and Description
static Overlay.OverlayPriority	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Overlay.OverlayPriority[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BACKGROUND_LOW

public static final Overlay.OverlayPriority BACKGROUND_LOW

BACKGROUND_NORMAL

public static final Overlay.OverlayPriority BACKGROUND_NORMAL

BACKGROUND_HIGH

public static final Overlay.OverlayPriority BACKGROUND_HIGH

BACKGROUND_TOP

public static final Overlay.OverlayPriority BACKGROUND_TOP

IMAGE_LOW

public static final Overlay.OverlayPriority IMAGE_LOW

IMAGE_NORMAL

public static final Overlay.OverlayPriority IMAGE_NORMAL

IMAGE_HIGH

public static final Overlay.OverlayPriority IMAGE_HIGH

IMAGE_TOP

public static final Overlay.OverlayPriority IMAGE_TOP

SHAPE_LOW

public static final Overlay.OverlayPriority SHAPE_LOW

SHAPE_NORMAL

public static final Overlay.OverlayPriority SHAPE_NORMAL

SHAPE_HIGH

public static final Overlay.OverlayPriority SHAPE_HIGH

SHAPE_TOP

public static final Overlay.OverlayPriority SHAPE_TOP

TEXT_LOW

public static final Overlay.OverlayPriority TEXT_LOW

TEXT_NORMAL

public static final Overlay.OverlayPriority TEXT_NORMAL

TEXT_HIGH

public static final Overlay.OverlayPriority TEXT_HIGH

TEXT_TOP

public static final Overlay.OverlayPriority TEXT_TOP

TOOLTIP_LOW

public static final Overlay.OverlayPriority TOOLTIP_LOW

TOOLTIP_NORMAL

public static final Overlay.OverlayPriority TOOLTIP_NORMAL

TOOLTIP_HIGH

public static final Overlay.OverlayPriority TOOLTIP_HIGH

TOOLTIP_TOP

public static final Overlay.OverlayPriority TOOLTIP_TOP

TOPMOST

public static final Overlay.OverlayPriority TOPMOST

Method Detail

values

public static Overlay.OverlayPriority[] 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 (Overlay.OverlayPriority c : Overlay.OverlayPriority.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Overlay.OverlayPriority 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