com.fs.starfarer.api.ui

Enum TooltipMakerAPI.TooltipLocation

java.lang.Object

java.lang.Enum<TooltipMakerAPI.TooltipLocation>

com.fs.starfarer.api.ui.TooltipMakerAPI.TooltipLocation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TooltipMakerAPI.TooltipLocation>

Enclosing interface:

TooltipMakerAPI

public static enum TooltipMakerAPI.TooltipLocation
extends java.lang.Enum<TooltipMakerAPI.TooltipLocation>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE
BELOW
LEFT
RIGHT

Method Summary

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

LEFT

public static final TooltipMakerAPI.TooltipLocation LEFT

RIGHT

public static final TooltipMakerAPI.TooltipLocation RIGHT

ABOVE

public static final TooltipMakerAPI.TooltipLocation ABOVE

BELOW

public static final TooltipMakerAPI.TooltipLocation BELOW

Method Detail

values

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

Returns:

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

valueOf

public static TooltipMakerAPI.TooltipLocation 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