File Doc Category Size Date Package
GraphicsConfigTemplate.java API Doc Java SE 5 API 3358 Fri Aug 26 14:56:44 BST 2005 java.awt

GraphicsConfigTemplate

java.lang.Object

public abstract class GraphicsConfigTemplate extends Object implements Serializable

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

see: GraphicsDevice
see: GraphicsConfiguration
version: 1.16, 12/19/03
since: 1.2

Fields 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.
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.
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.
Constructors Summary
public GraphicsConfigTemplate()
This class is an abstract class so only subclasses can be instantiated.

Methods Summary
public abstract java.awt.GraphicsConfiguration getBestConfiguration(java.awt.GraphicsConfiguration[] gc)
Returns the "best" configuration possible that passes the criteria defined in the GraphicsConfigTemplate.
param
gc the array of GraphicsConfiguration objects to choose from.
return
a GraphicsConfiguration object that is the best configuration possible.
see
GraphicsConfiguration
public abstract boolean isGraphicsConfigSupported(java.awt.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.
param
gc the GraphicsConfiguration object to test
return
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.