javafx.application

Enum ConditionalFeature

java.lang.Object

java.lang.Enum<ConditionalFeature>

javafx.application.ConditionalFeature

All Implemented Interfaces:

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

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

Defines a set of conditional (optional) features. These features may not be available on all platforms. An application that wants to know whether a particular feature is available may query this using the Platform.isSupported() function. Using a conditional feature on a platform that does not support it will not cause an exception. In general, the conditional feature will just be ignored. See the documentation for each feature for more detail.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EFFECT Indicates that filter effects are available on the platform.
INPUT_METHOD Indicates that text input method is available on the platform.
SCENE3D Indicates that 3D is available on the platform.
SHAPE_CLIP Indicates that clipping against an arbitrary shape is available on the platform.
TRANSPARENT_WINDOW Indicates that the system supports full window transparency.

Method Summary

Methods

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

SCENE3D

public static final ConditionalFeature SCENE3D

Indicates that 3D is available on the platform. If an application attempts to use 3D transforms or a 3D camera on a platform that does not support 3D, then the transform or camera is ignored; it effectively becomes the identity transform.

EFFECT

public static final ConditionalFeature EFFECT

Indicates that filter effects are available on the platform. If an application uses an effect on a platform that does not support it, the effect will be ignored.

SHAPE_CLIP

public static final ConditionalFeature SHAPE_CLIP

Indicates that clipping against an arbitrary shape is available on the platform. If an application specifies a clip node on a platform that does not support clipping against an arbitrary shape, the node will be clipped to the bounds of the specified clip node rather than its geometric shape.

INPUT_METHOD

public static final ConditionalFeature INPUT_METHOD

Indicates that text input method is available on the platform. If an application specifies an input method on a platform that does not support it, the input method will be ignored.

TRANSPARENT_WINDOW

public static final ConditionalFeature TRANSPARENT_WINDOW

Indicates that the system supports full window transparency. Transparent windows will have only limited or no functionality on a platform that doesn't support it.

NOTE: Currently, this support is available on all platforms except Linux systems without the XComposite extension. The XShape extension is used in that case, so the window edges are aliased.

Method Detail

values

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

Returns:

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

valueOf

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