OpenJDK 27 · java.awt.GraphicsConfigTemplate · APIdia, the JavaDoc alternative

The GraphicsConfigTemplate class is used to obtain a valid GraphicsConfiguration. A user instantiates one of these objects and then sets all non-default attributes as desired. The GraphicsDevice#getBestConfiguration method found in the GraphicsDevice class is then called with this GraphicsConfigTemplate. A valid GraphicsConfiguration is returned that meets or exceeds what was requested in the GraphicsConfigTemplate.

Field Summary

Modifier and Type	Field and Description
public static final int	PREFERRED Value used for "Enum" (Integer) type.
public static final int	REQUIRED Value used for "Enum" (Integer) type.
private static final long	serialVersionUID Use serialVersionUID from JDK 1.6 for interoperability.
public static final int	UNNECESSARY Value used for "Enum" (Integer) type.

Constructor Summary

Access	Constructor and Description
public	GraphicsConfigTemplate() This class is an abstract class so only subclasses can be instantiated.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public abstract GraphicsConfiguration	Returns: a `GraphicsConfiguration` object that is the best configuration possible. getBestConfiguration(GraphicsConfiguration[] the array of `GraphicsConfiguration` objects to choose from. gc) Returns the "best" configuration possible that passes the criteria defined in the `GraphicsConfigTemplate`.
public abstract boolean	Returns: `true` if this `GraphicsConfiguration` object can be used to create surfaces that support the indicated features; `false` if the `GraphicsConfiguration` can not be used to create a drawing surface usable by this Java(tm) API. isGraphicsConfigSupported(GraphicsConfiguration the `GraphicsConfiguration` object to test gc) Returns a `boolean` indicating whether or not the specified `GraphicsConfiguration` can be used to create a drawing surface that supports the indicated features.

public abstract GraphicsConfiguration

Returns:

a GraphicsConfiguration object that is the best configuration possible.

getBestConfiguration(GraphicsConfiguration[]

the array of GraphicsConfiguration objects to choose from.

gc)

Returns the "best" configuration possible that passes the criteria defined in the GraphicsConfigTemplate.

public abstract boolean

Returns:

true if this GraphicsConfiguration object can be used to create surfaces that support the indicated features; false if the GraphicsConfiguration can not be used to create a drawing surface usable by this Java(tm) API.

isGraphicsConfigSupported(GraphicsConfiguration

the GraphicsConfiguration object to test

gc)

Returns a boolean indicating whether or not the specified GraphicsConfiguration can be used to create a drawing surface that supports the indicated features.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

PREFERRED	back to summary
public static final int PREFERRED Value used for "Enum" (Integer) type. States that this feature is desired for the `GraphicsConfiguration` object. A selection with this feature is preferred over a selection that does not include this feature, although both selections can be considered valid matches.

REQUIRED	back to summary
public static final int REQUIRED Value used for "Enum" (Integer) type. States that this feature is required for the `GraphicsConfiguration` object. If this feature is not available, do not select the `GraphicsConfiguration` object.

serialVersionUID	back to summary
private static final long serialVersionUID Use serialVersionUID from JDK 1.6 for interoperability. Annotations @Serial

UNNECESSARY	back to summary
public static final int UNNECESSARY Value used for "Enum" (Integer) type. States that this feature is not necessary for the selection of the `GraphicsConfiguration` object. A selection without this feature is preferred over a selection that includes this feature since it is not used.

Constructor Detail

GraphicsConfigTemplate	back to summary
public GraphicsConfigTemplate() This class is an abstract class so only subclasses can be instantiated.

Method Detail

getBestConfiguration back to summary

getBestConfiguration	back to summary
public abstract GraphicsConfiguration getBestConfiguration(GraphicsConfiguration[] gc) Returns the "best" configuration possible that passes the criteria defined in the `GraphicsConfigTemplate`. Parameters gc:GraphicsConfiguration[] the array of `GraphicsConfiguration` objects to choose from. Returns:GraphicsConfiguration a `GraphicsConfiguration` object that is the best configuration possible. See Also `GraphicsConfiguration`

public abstract GraphicsConfiguration getBestConfiguration(GraphicsConfiguration[] gc)

Returns the "best" configuration possible that passes the criteria defined in the GraphicsConfigTemplate.

Parameters

gc:GraphicsConfiguration[]: the array of GraphicsConfiguration objects to choose from.

Returns:GraphicsConfiguration

a GraphicsConfiguration object that is the best configuration possible.

See Also

GraphicsConfiguration

isGraphicsConfigSupported back to summary

isGraphicsConfigSupported	back to summary
public abstract boolean isGraphicsConfigSupported(GraphicsConfiguration gc) Returns a `boolean` indicating whether or not the specified `GraphicsConfiguration` can be used to create a drawing surface that supports the indicated features. Parameters gc:GraphicsConfiguration the `GraphicsConfiguration` object to test Returns:boolean `true` if this `GraphicsConfiguration` object can be used to create surfaces that support the indicated features; `false` if the `GraphicsConfiguration` can not be used to create a drawing surface usable by this Java(tm) API.

public abstract boolean isGraphicsConfigSupported(GraphicsConfiguration gc)