This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.awt
class GraphicsConfigTemplate

java.lang.Object extended by java.awt.GraphicsConfigTemplate
All Implemented Interfaces:
Serializable

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.


Field Summary
static int PREFERRED
          Value used for "Enum" (Integer) type.
static int REQUIRED
          Value used for "Enum" (Integer) type.
static int UNNECESSARY
          Value used for "Enum" (Integer) type.
 
Constructor Summary

          This class is an abstract class so only subclasses can be instantiated.
 
Method Summary
abstract GraphicsConfiguration

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

          Returns a boolean indicating whether or not the specified GraphicsConfiguration can be used to create a drawing surface that supports the indicated features.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PREFERRED

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

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.

UNNECESSARY

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

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

Method Detail

getBestConfiguration

public abstract GraphicsConfiguration getBestConfiguration(GraphicsConfiguration[] gc)
Returns the "best" configuration possible that passes the criteria defined in the GraphicsConfigTemplate.

Parameters:
gc - the array of GraphicsConfiguration objects to choose from.
Returns:
a GraphicsConfiguration object that is the best configuration possible.

isGraphicsConfigSupported

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 - the GraphicsConfiguration object to test
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.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.