com.jme3.app

Enum LostFocusBehavior

java.lang.Object

java.lang.Enum<LostFocusBehavior>

com.jme3.app.LostFocusBehavior

All Implemented Interfaces:

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

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

Defines the behavior of an application when it is not in focus or minimized.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Disabled No lost focus behavior.
PauseOnLostFocus The application will not update when unfocused.
ThrottleOnLostFocus The application will update at a reduced rate when unfocused.

Method Summary

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

Disabled

public static final LostFocusBehavior Disabled

No lost focus behavior. The application will update and render as usual.

PauseOnLostFocus

public static final LostFocusBehavior PauseOnLostFocus

The application will not update when unfocused. For online or real-time applications, this might not be preferable. For other applications, it is best to keep it on so that CPU usage is not used when not necessary.

ThrottleOnLostFocus

public static final LostFocusBehavior ThrottleOnLostFocus

The application will update at a reduced rate when unfocused. This is a compromise between Disabled and PauseOnLostFocus, allowing the application to update at a reduced rate (20 updates per second), but without rendering.

Method Detail

values

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

Returns:

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

valueOf

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