java.awt
Class GraphicsEnvironment

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.GraphicsEnvironment

public abstract class GraphicsEnvironment
extends Object sample code for java.lang.Object definition code for java.lang.Object

The GraphicsEnvironment class describes the collection of GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice objects and Font sample code for java.awt.Font definition code for java.awt.Font objects available to a Java(tm) application on a particular platform. The resources in this GraphicsEnvironment might be local or on a remote machine. GraphicsDevice objects can be screens, printers or image buffers and are the destination of Graphics2D sample code for java.awt.Graphics2D definition code for java.awt.Graphics2D drawing methods. Each GraphicsDevice has a number of GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration objects associated with it. These objects specify the different configurations in which the GraphicsDevice can be used.

See Also:
GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice , GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration

Constructor Summary
protected GraphicsEnvironment sample code for java.awt.GraphicsEnvironment.GraphicsEnvironment() definition code for java.awt.GraphicsEnvironment.GraphicsEnvironment() ()
          This is an abstract class and cannot be instantiated directly.
 
Method Summary
abstract  Graphics2D sample code for java.awt.Graphics2D definition code for java.awt.Graphics2D createGraphics sample code for java.awt.GraphicsEnvironment.createGraphics(java.awt.image.BufferedImage) definition code for java.awt.GraphicsEnvironment.createGraphics(java.awt.image.BufferedImage) (BufferedImage sample code for java.awt.image.BufferedImage definition code for java.awt.image.BufferedImage  img)
          Returns a Graphics2D object for rendering into the specified BufferedImage sample code for java.awt.image.BufferedImage definition code for java.awt.image.BufferedImage .
abstract  Font sample code for java.awt.Font definition code for java.awt.Font [] getAllFonts sample code for java.awt.GraphicsEnvironment.getAllFonts() definition code for java.awt.GraphicsEnvironment.getAllFonts() ()
          Returns an array containing a one-point size instance of all fonts available in this GraphicsEnvironment.
abstract  String sample code for java.lang.String definition code for java.lang.String [] getAvailableFontFamilyNames sample code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames() definition code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames() ()
          Returns an array containing the names of all font families in this GraphicsEnvironment localized for the default locale, as returned by Locale.getDefault().
abstract  String sample code for java.lang.String definition code for java.lang.String [] getAvailableFontFamilyNames sample code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames(java.util.Locale) definition code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames(java.util.Locale) (Locale sample code for java.util.Locale definition code for java.util.Locale  l)
          Returns an array containing the names of all font families in this GraphicsEnvironment localized for the specified locale.
 Point sample code for java.awt.Point definition code for java.awt.Point getCenterPoint sample code for java.awt.GraphicsEnvironment.getCenterPoint() definition code for java.awt.GraphicsEnvironment.getCenterPoint() ()
          Returns the Point where Windows should be centered.
abstract  GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice getDefaultScreenDevice sample code for java.awt.GraphicsEnvironment.getDefaultScreenDevice() definition code for java.awt.GraphicsEnvironment.getDefaultScreenDevice() ()
          Returns the default screen GraphicsDevice.
static GraphicsEnvironment sample code for java.awt.GraphicsEnvironment definition code for java.awt.GraphicsEnvironment getLocalGraphicsEnvironment sample code for java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment() definition code for java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment() ()
          Returns the local GraphicsEnvironment.
 Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle getMaximumWindowBounds sample code for java.awt.GraphicsEnvironment.getMaximumWindowBounds() definition code for java.awt.GraphicsEnvironment.getMaximumWindowBounds() ()
          Returns the maximum bounds for centered Windows.
abstract  GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice [] getScreenDevices sample code for java.awt.GraphicsEnvironment.getScreenDevices() definition code for java.awt.GraphicsEnvironment.getScreenDevices() ()
          Returns an array of all of the screen GraphicsDevice objects.
static boolean isHeadless sample code for java.awt.GraphicsEnvironment.isHeadless() definition code for java.awt.GraphicsEnvironment.isHeadless() ()
          Tests whether or not a display, keyboard, and mouse can be supported in this environment.
 boolean isHeadlessInstance sample code for java.awt.GraphicsEnvironment.isHeadlessInstance() definition code for java.awt.GraphicsEnvironment.isHeadlessInstance() ()
          Returns whether or not a display, keyboard, and mouse can be supported in this graphics environment.
 void preferLocaleFonts sample code for java.awt.GraphicsEnvironment.preferLocaleFonts() definition code for java.awt.GraphicsEnvironment.preferLocaleFonts() ()
          Indicates a preference for locale-specific fonts in the mapping of logical fonts to physical fonts.
 void preferProportionalFonts sample code for java.awt.GraphicsEnvironment.preferProportionalFonts() definition code for java.awt.GraphicsEnvironment.preferProportionalFonts() ()
          Indicates a preference for proportional over non-proportional (e.g.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

GraphicsEnvironment sample code for java.awt.GraphicsEnvironment() definition code for java.awt.GraphicsEnvironment()

protected GraphicsEnvironment()
This is an abstract class and cannot be instantiated directly. Instances must be obtained from a suitable factory or query method.

Method Detail

getLocalGraphicsEnvironment sample code for java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment() definition code for java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment()

public static GraphicsEnvironment sample code for java.awt.GraphicsEnvironment definition code for java.awt.GraphicsEnvironment  getLocalGraphicsEnvironment()
Returns the local GraphicsEnvironment.

Returns:
the local GraphicsEnvironment

isHeadless sample code for java.awt.GraphicsEnvironment.isHeadless() definition code for java.awt.GraphicsEnvironment.isHeadless()

public static boolean isHeadless()
Tests whether or not a display, keyboard, and mouse can be supported in this environment. If this method returns true, a HeadlessException is thrown from areas of the Toolkit and GraphicsEnvironment that are dependent on a display, keyboard, or mouse.

Returns:
true if this environment cannot support a display, keyboard, and mouse; false otherwise
Since:
1.4
See Also:
HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException

isHeadlessInstance sample code for java.awt.GraphicsEnvironment.isHeadlessInstance() definition code for java.awt.GraphicsEnvironment.isHeadlessInstance()

public boolean isHeadlessInstance()
Returns whether or not a display, keyboard, and mouse can be supported in this graphics environment. If this returns true, HeadlessException will be thrown from areas of the graphics environment that are dependent on a display, keyboard, or mouse.

Returns:
true if a display, keyboard, and mouse can be supported in this environment; false otherwise
Since:
1.4
See Also:
HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException , isHeadless() sample code for java.awt.GraphicsEnvironment.isHeadless() definition code for java.awt.GraphicsEnvironment.isHeadless()

getScreenDevices sample code for java.awt.GraphicsEnvironment.getScreenDevices() definition code for java.awt.GraphicsEnvironment.getScreenDevices()

public abstract GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice [] getScreenDevices()
                                           throws HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException 
Returns an array of all of the screen GraphicsDevice objects.

Returns:
an array containing all the GraphicsDevice objects that represent screen devices
Throws:
HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException - if isHeadless() returns true
See Also:
isHeadless() sample code for java.awt.GraphicsEnvironment.isHeadless() definition code for java.awt.GraphicsEnvironment.isHeadless()

getDefaultScreenDevice sample code for java.awt.GraphicsEnvironment.getDefaultScreenDevice() definition code for java.awt.GraphicsEnvironment.getDefaultScreenDevice()

public abstract GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice  getDefaultScreenDevice()
                                               throws HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException 
Returns the default screen GraphicsDevice.

Returns:
the GraphicsDevice that represents the default screen device
Throws:
HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException - if isHeadless() returns true
See Also:
isHeadless() sample code for java.awt.GraphicsEnvironment.isHeadless() definition code for java.awt.GraphicsEnvironment.isHeadless()

createGraphics sample code for java.awt.GraphicsEnvironment.createGraphics(java.awt.image.BufferedImage) definition code for java.awt.GraphicsEnvironment.createGraphics(java.awt.image.BufferedImage)

public abstract Graphics2D sample code for java.awt.Graphics2D definition code for java.awt.Graphics2D  createGraphics(BufferedImage sample code for java.awt.image.BufferedImage definition code for java.awt.image.BufferedImage  img)
Returns a Graphics2D object for rendering into the specified BufferedImage sample code for java.awt.image.BufferedImage definition code for java.awt.image.BufferedImage .

Parameters:
img - the specified BufferedImage
Returns:
a Graphics2D to be used for rendering into the specified BufferedImage

getAllFonts sample code for java.awt.GraphicsEnvironment.getAllFonts() definition code for java.awt.GraphicsEnvironment.getAllFonts()

public abstract Font sample code for java.awt.Font definition code for java.awt.Font [] getAllFonts()
Returns an array containing a one-point size instance of all fonts available in this GraphicsEnvironment. Typical usage would be to allow a user to select a particular font. Then, the application can size the font and set various font attributes by calling the deriveFont method on the choosen instance.

This method provides for the application the most precise control over which Font instance is used to render text. If a font in this GraphicsEnvironment has multiple programmable variations, only one instance of that Font is returned in the array, and other variations must be derived by the application.

If a font in this environment has multiple programmable variations, such as Multiple-Master fonts, only one instance of that font is returned in the Font array. The other variations must be derived by the application.

Returns:
an array of Font objects
Since:
1.2
See Also:
getAvailableFontFamilyNames() sample code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames() definition code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames() , Font sample code for java.awt.Font definition code for java.awt.Font , Font.deriveFont(int, float) sample code for java.awt.Font.deriveFont(int, float) definition code for java.awt.Font.deriveFont(int, float) , Font.getFontName() sample code for java.awt.Font.getFontName() definition code for java.awt.Font.getFontName()

getAvailableFontFamilyNames sample code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames() definition code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames()

public abstract String sample code for java.lang.String definition code for java.lang.String [] getAvailableFontFamilyNames()
Returns an array containing the names of all font families in this GraphicsEnvironment localized for the default locale, as returned by Locale.getDefault().

Typical usage would be for presentation to a user for selection of a particular family name. An application can then specify this name when creating a font, in conjunction with a style, such as bold or italic, giving the font system flexibility in choosing its own best match among multiple fonts in the same font family.

Returns:
an array of String containing font family names localized for the default locale, or a suitable alternative name if no name exists for this locale.
Since:
1.2
See Also:
getAllFonts() sample code for java.awt.GraphicsEnvironment.getAllFonts() definition code for java.awt.GraphicsEnvironment.getAllFonts() , Font sample code for java.awt.Font definition code for java.awt.Font , Font.getFamily() sample code for java.awt.Font.getFamily() definition code for java.awt.Font.getFamily()

getAvailableFontFamilyNames sample code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames(java.util.Locale) definition code for java.awt.GraphicsEnvironment.getAvailableFontFamilyNames(java.util.Locale)

public abstract String sample code for java.lang.String definition code for java.lang.String [] getAvailableFontFamilyNames(Locale sample code for java.util.Locale definition code for java.util.Locale  l)
Returns an array containing the names of all font families in this GraphicsEnvironment localized for the specified locale.

Typical usage would be for presentation to a user for selection of a particular family name. An application can then specify this name when creating a font, in conjunction with a style, such as bold or italic, giving the font system flexibility in choosing its own best match among multiple fonts in the same font family.

Parameters:
l - a Locale sample code for java.util.Locale definition code for java.util.Locale object that represents a particular geographical, political, or cultural region. Specifying null is equivalent to specifying Locale.getDefault().
Returns:
an array of String containing font family names localized for the specified Locale, or a suitable alternative name if no name exists for the specified locale.
Since:
1.2
See Also:
getAllFonts() sample code for java.awt.GraphicsEnvironment.getAllFonts() definition code for java.awt.GraphicsEnvironment.getAllFonts() , Font sample code for java.awt.Font definition code for java.awt.Font , Font.getFamily() sample code for java.awt.Font.getFamily() definition code for java.awt.Font.getFamily()

preferLocaleFonts sample code for java.awt.GraphicsEnvironment.preferLocaleFonts() definition code for java.awt.GraphicsEnvironment.preferLocaleFonts()

public void preferLocaleFonts()
Indicates a preference for locale-specific fonts in the mapping of logical fonts to physical fonts. Calling this method indicates that font rendering should primarily use fonts specific to the primary writing system (the one indicated by the default encoding and the initial default locale). For example, if the primary writing system is Japanese, then characters should be rendered using a Japanese font if possible, and other fonts should only be used for characters for which the Japanese font doesn't have glyphs.

The actual change in font rendering behavior resulting from a call to this method is implementation dependent; it may have no effect at all, or the requested behavior may already match the default behavior. The behavior may differ between font rendering in lightweight and peered components. Since calling this method requests a different font, clients should expect different metrics, and may need to recalculate window sizes and layout. Therefore this method should be called before user interface initialisation.

Since:
1.5

preferProportionalFonts sample code for java.awt.GraphicsEnvironment.preferProportionalFonts() definition code for java.awt.GraphicsEnvironment.preferProportionalFonts()

public void preferProportionalFonts()
Indicates a preference for proportional over non-proportional (e.g. dual-spaced CJK fonts) fonts in the mapping of logical fonts to physical fonts. If the default mapping contains fonts for which proportional and non-proportional variants exist, then calling this method indicates the mapping should use a proportional variant.

The actual change in font rendering behavior resulting from a call to this method is implementation dependent; it may have no effect at all. The behavior may differ between font rendering in lightweight and peered components. Since calling this method requests a different font, clients should expect different metrics, and may need to recalculate window sizes and layout. Therefore this method should be called before user interface initialisation.

Since:
1.5

getCenterPoint sample code for java.awt.GraphicsEnvironment.getCenterPoint() definition code for java.awt.GraphicsEnvironment.getCenterPoint()

public Point sample code for java.awt.Point definition code for java.awt.Point  getCenterPoint()
                     throws HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException 
Returns the Point where Windows should be centered. It is recommended that centered Windows be checked to ensure they fit within the available display area using getMaximumWindowBounds().

Returns:
the point where Windows should be centered
Throws:
HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException - if isHeadless() returns true
Since:
1.4
See Also:
getMaximumWindowBounds() sample code for java.awt.GraphicsEnvironment.getMaximumWindowBounds() definition code for java.awt.GraphicsEnvironment.getMaximumWindowBounds()

getMaximumWindowBounds sample code for java.awt.GraphicsEnvironment.getMaximumWindowBounds() definition code for java.awt.GraphicsEnvironment.getMaximumWindowBounds()

public Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  getMaximumWindowBounds()
                                 throws HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException 
Returns the maximum bounds for centered Windows. These bounds account for objects in the native windowing system such as task bars and menu bars. The returned bounds will reside on a single display with one exception: on multi-screen systems where Windows should be centered across all displays, this method returns the bounds of the entire display area.

To get the usable bounds of a single display, use GraphicsConfiguration.getBounds() and Toolkit.getScreenInsets().

Returns:
the maximum bounds for centered Windows
Throws:
HeadlessException sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException - if isHeadless() returns true
Since:
1.4
See Also:
getCenterPoint() sample code for java.awt.GraphicsEnvironment.getCenterPoint() definition code for java.awt.GraphicsEnvironment.getCenterPoint() , GraphicsConfiguration.getBounds() sample code for java.awt.GraphicsConfiguration.getBounds() definition code for java.awt.GraphicsConfiguration.getBounds() , Toolkit.getScreenInsets(java.awt.GraphicsConfiguration) sample code for java.awt.Toolkit.getScreenInsets(java.awt.GraphicsConfiguration) definition code for java.awt.Toolkit.getScreenInsets(java.awt.GraphicsConfiguration)