com.alee.extended.magnifier

Enum MagnifierPosition

java.lang.Object

java.lang.Enum<MagnifierPosition>

com.alee.extended.magnifier.MagnifierPosition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MagnifierPosition>

public enum MagnifierPosition
extends java.lang.Enum<MagnifierPosition>

This enumeration represents available magnifier positioning types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
atCursor Position magnifier straight under the cursor location.
nearCursor Position magnifier aside of the cursor location.
staticComponent Position magnifier where its component is located.

Method Summary

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

atCursor

public static final MagnifierPosition atCursor

Position magnifier straight under the cursor location. This position will force you to always look at the magnified version of UI under the cursor.

nearCursor

public static final MagnifierPosition nearCursor

Position magnifier aside of the cursor location. This will allow you to see both magnified and normal versions of UI under the cursor.

staticComponent

public static final MagnifierPosition staticComponent

Position magnifier where its component is located. This will allow you to manually place magnifier on the UI.

Be aware that magnifier takes snapshots of the JLayeredPane and to avoid visual confusion is usualy placed on glass pane. Otherwise it will also display magnified version of itself if you hover it in the UI.

Method Detail

values

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

Returns:

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

valueOf

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