com.alee.extended.window
Enum PopOverDirection

java.lang.Object
  java.lang.Enum<PopOverDirection>
      com.alee.extended.window.PopOverDirection

All Implemented Interfaces:

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

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

This enumeration represents possible WebPopOver dialog display ways relative to invoker component. Be aware that left/right direction is affected by WebPopOver component orientation.

Author:

Mikle Garin

See Also:

WebPopOver

Enum Constant Summary

down
Display pop-over below invoker component.

left
Display pop-over leading to the invoker component.

right
Display pop-over trailing to the invoker component.

up
Display pop-over above invoker component.

Method Summary

int	getCornerSide(boolean ltr) Returns WebPopOver corner side.
PopOverDirection[]	getPriority() Returns directions check priority according to preferred direction.
static PopOverDirection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PopOverDirection[]	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

up

public static final PopOverDirection up

Display pop-over above invoker component.

down

public static final PopOverDirection down

Display pop-over below invoker component.

left

public static final PopOverDirection left

Display pop-over leading to the invoker component. This will also take pop-over component orientation into account.

right

public static final PopOverDirection right

Display pop-over trailing to the invoker component. This will also take pop-over component orientation into account.

Method Detail

values

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

Returns:

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

valueOf

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

getPriority

public PopOverDirection[] getPriority()

Returns directions check priority according to preferred direction.

Returns:

directions check priority

getCornerSide

public int getCornerSide(boolean ltr)

Returns WebPopOver corner side.

Parameters:

ltr - whether pop-over has LTR orientation or not

Returns:

WebPopOver corner side