java.awt

Class GraphicsDevice


public abstract class GraphicsDevice
extends Object

This describes a graphics device available to the given environment. This includes screen and printer devices, and the different configurations for each device. Also, this allows you to create virtual devices which operate over a multi-screen environment.
Since:
1.3
See Also:
GraphicsEnvironment, GraphicsConfiguration

Field Summary

static int
TYPE_IMAGE_BUFFER
Device is an image buffer not visible to the user.
static int
TYPE_PRINTER
Device is a printer.
static int
TYPE_RASTER_SCREEN
Device is a raster screen.

Constructor Summary

GraphicsDevice()
The default constructor.

Method Summary

int
getAvailableAcceleratedMemory()
Return the number of bytes available in accelerated memory on this device.
GraphicsConfiguration
getBestConfiguration(GraphicsConfigTemplate template)
Return the best configuration, according to the criteria in the given template.
abstract GraphicsConfiguration[]
getConfigurations()
Return all configurations valid for this device.
abstract GraphicsConfiguration
getDefaultConfiguration()
Return the default configuration for this device.
DisplayMode
getDisplayMode()
Returns the current display mode of this device, or null if unknown.
DisplayMode[]
getDisplayModes()
Return an array of all available display modes.
Window
getFullScreenWindow()
Returns the current full-screen window of the device, or null if no window is full-screen.
abstract String
getIDstring()
Returns an identification string for the device.
abstract int
getType()
Returns the type of the device.
boolean
isDisplayChangeSupported()
Returns whether this device supports low-level display changes.
boolean
isFullScreenSupported()
Returns true if the device supports full-screen exclusive mode.
void
setDisplayMode(DisplayMode mode)
Sets the display mode.
void
setFullScreenWindow(Window w)
Toggle the given window between full screen and normal mode.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE_IMAGE_BUFFER

public static final int TYPE_IMAGE_BUFFER
Device is an image buffer not visible to the user.
Field Value:
2

TYPE_PRINTER

public static final int TYPE_PRINTER
Device is a printer.
Field Value:
1

TYPE_RASTER_SCREEN

public static final int TYPE_RASTER_SCREEN
Device is a raster screen.
Field Value:
0

Constructor Details

GraphicsDevice

protected GraphicsDevice()
The default constructor.

Method Details

getAvailableAcceleratedMemory

public int getAvailableAcceleratedMemory()
Return the number of bytes available in accelerated memory on this device. The device may support creation or caching on a first-come, first-served basis, depending on the operating system and driver. Memory may be a finite resource, and because of multi-threading, you are not guaranteed that the result of this method ensures your image will successfully be put in accelerated memory. A negative result means the memory is unlimited. The default implementation assumes no special memory is available, and returns 0.
Returns:
the size of accelerated memory available

getBestConfiguration

public GraphicsConfiguration getBestConfiguration(GraphicsConfigTemplate template)
Return the best configuration, according to the criteria in the given template.
Parameters:
template - the template to adjust by
Returns:
the best configuration
Throws:
NullPointerException - if template is null

getConfigurations

public abstract GraphicsConfiguration[] getConfigurations()
Return all configurations valid for this device.
Returns:
an array of configurations

getDefaultConfiguration

public abstract GraphicsConfiguration getDefaultConfiguration()
Return the default configuration for this device.
Returns:
the default configuration

getDisplayMode

public DisplayMode getDisplayMode()
Returns the current display mode of this device, or null if unknown.
Returns:
the current display mode
Since:
1.4

getDisplayModes

public DisplayMode[] getDisplayModes()
Return an array of all available display modes. This implementation returns a 0-length array, so subclasses must override this.
Returns:
the array of available modes
Since:
1.4

getFullScreenWindow

public Window getFullScreenWindow()
Returns the current full-screen window of the device, or null if no window is full-screen.
Returns:
the full-screen window
Since:
1.4

getIDstring

public abstract String getIDstring()
Returns an identification string for the device. This can be vendor-specific, and may be useful for debugging.
Returns:
the identification

getType

public abstract int getType()
Returns the type of the device.
Returns:
the device type

isDisplayChangeSupported

public boolean isDisplayChangeSupported()
Returns whether this device supports low-level display changes. This may depend on whether full-screen exclusive mode is available. XXX The default implementation returns false for now.
Returns:
true if display changes are supported
Since:
1.4

isFullScreenSupported

public boolean isFullScreenSupported()
Returns true if the device supports full-screen exclusive mode. The default implementation returns true; subclass it if this is not the case.
Returns:
true if full screen support is available
Since:
1.4

setDisplayMode

public void setDisplayMode(DisplayMode mode)
Sets the display mode. This may be dependent on the availability of full-screen exclusive mode.
Parameters:
mode - the new mode
Throws:
IllegalArgumentException - if the new mode is not in getDisplayModes
UnsupportedOperationException - if ! isDisplayChangeSupported()
Since:
1.4

setFullScreenWindow

public void setFullScreenWindow(Window w)
Toggle the given window between full screen and normal mode. The previous full-screen window, if different, is restored; if the given window is null, no window will be full screen. If isFullScreenSupported() returns true, full screen mode is considered to be exclusive, which implies:
  • Windows cannot overlap the full-screen window. All other application windows will always appear beneath the full-screen window in the Z-order.
  • Input method windows are disabled. It is advisable to call Component.enableInputMethods(false) to make a component a non-client of the input method framework.

If isFullScreenSupported() returns false, full-screen exclusive mode is simulated by resizing the window to the size of the screen and positioning it at (0,0). This is also what this method does. If a device supports real fullscreen mode then it should override this method as well as #isFullScreenSupported and #getFullScreenWindow.
Parameters:
w - the window to toggle
Since:
1.4

GraphicsDevice.java -- information about a graphics device Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.