java.awt
Class GraphicsDevice

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

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

The GraphicsDevice class describes the graphics devices that might be available in a particular graphics environment. These include screen and printer devices. Note that there can be many screens and many printers in an instance of GraphicsEnvironment sample code for java.awt.GraphicsEnvironment definition code for java.awt.GraphicsEnvironment . Each graphics device has one or more 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.

In a multi-screen environment, the GraphicsConfiguration objects can be used to render components on multiple screens. The following code sample demonstrates how to create a JFrame object for each GraphicsConfiguration on each screen device in the GraphicsEnvironment:

   GraphicsEnvironment ge = GraphicsEnvironment.
   getLocalGraphicsEnvironment();
   GraphicsDevice[] gs = ge.getScreenDevices();
   for (int j = 0; j < gs.length; j++) { 
      GraphicsDevice gd = gs[j];
      GraphicsConfiguration[] gc =
        gd.getConfigurations();
      for (int i=0; i < gc.length; i++) {
         JFrame f = new
         JFrame(gs[j].getDefaultConfiguration());
         Canvas c = new Canvas(gc[i]); 
         Rectangle gcBounds = gc[i].getBounds();
         int xoffs = gcBounds.x;
         int yoffs = gcBounds.y;
           f.getContentPane().add(c);
           f.setLocation((i*50)+xoffs, (i*60)+yoffs);
         f.show();
      }
   }
 

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

Field Summary
static int TYPE_IMAGE_BUFFER sample code for java.awt.GraphicsDevice.TYPE_IMAGE_BUFFER definition code for java.awt.GraphicsDevice.TYPE_IMAGE_BUFFER
          Device is an image buffer.
static int TYPE_PRINTER sample code for java.awt.GraphicsDevice.TYPE_PRINTER definition code for java.awt.GraphicsDevice.TYPE_PRINTER
          Device is a printer.
static int TYPE_RASTER_SCREEN sample code for java.awt.GraphicsDevice.TYPE_RASTER_SCREEN definition code for java.awt.GraphicsDevice.TYPE_RASTER_SCREEN
          Device is a raster screen.
 
Constructor Summary
protected GraphicsDevice sample code for java.awt.GraphicsDevice.GraphicsDevice() definition code for java.awt.GraphicsDevice.GraphicsDevice() ()
          This is an abstract class that cannot be instantiated directly.
 
Method Summary
 int getAvailableAcceleratedMemory sample code for java.awt.GraphicsDevice.getAvailableAcceleratedMemory() definition code for java.awt.GraphicsDevice.getAvailableAcceleratedMemory() ()
          This method returns the number of bytes available in accelerated memory on this device.
 GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration getBestConfiguration sample code for java.awt.GraphicsDevice.getBestConfiguration(java.awt.GraphicsConfigTemplate) definition code for java.awt.GraphicsDevice.getBestConfiguration(java.awt.GraphicsConfigTemplate) (GraphicsConfigTemplate sample code for java.awt.GraphicsConfigTemplate definition code for java.awt.GraphicsConfigTemplate  gct)
          Returns the "best" configuration possible that passes the criteria defined in the GraphicsConfigTemplate sample code for java.awt.GraphicsConfigTemplate definition code for java.awt.GraphicsConfigTemplate .
abstract  GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration [] getConfigurations sample code for java.awt.GraphicsDevice.getConfigurations() definition code for java.awt.GraphicsDevice.getConfigurations() ()
          Returns all of the GraphicsConfiguration objects associated with this GraphicsDevice.
abstract  GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration getDefaultConfiguration sample code for java.awt.GraphicsDevice.getDefaultConfiguration() definition code for java.awt.GraphicsDevice.getDefaultConfiguration() ()
          Returns the default GraphicsConfiguration associated with this GraphicsDevice.
 DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode getDisplayMode sample code for java.awt.GraphicsDevice.getDisplayMode() definition code for java.awt.GraphicsDevice.getDisplayMode() ()
          Returns the current display mode of this GraphicsDevice.
 DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode [] getDisplayModes sample code for java.awt.GraphicsDevice.getDisplayModes() definition code for java.awt.GraphicsDevice.getDisplayModes() ()
          Returns all display modes available for this GraphicsDevice.
 Window sample code for java.awt.Window definition code for java.awt.Window getFullScreenWindow sample code for java.awt.GraphicsDevice.getFullScreenWindow() definition code for java.awt.GraphicsDevice.getFullScreenWindow() ()
          Returns the Window object representing the full-screen window if the device is in full-screen mode.
abstract  String sample code for java.lang.String definition code for java.lang.String getIDstring sample code for java.awt.GraphicsDevice.getIDstring() definition code for java.awt.GraphicsDevice.getIDstring() ()
          Returns the identification string associated with this GraphicsDevice.
abstract  int getType sample code for java.awt.GraphicsDevice.getType() definition code for java.awt.GraphicsDevice.getType() ()
          Returns the type of this GraphicsDevice.
 boolean isDisplayChangeSupported sample code for java.awt.GraphicsDevice.isDisplayChangeSupported() definition code for java.awt.GraphicsDevice.isDisplayChangeSupported() ()
          Returns true if this GraphicsDevice supports low-level display changes.
 boolean isFullScreenSupported sample code for java.awt.GraphicsDevice.isFullScreenSupported() definition code for java.awt.GraphicsDevice.isFullScreenSupported() ()
          Returns true if this GraphicsDevice supports full-screen exclusive mode.
 void setDisplayMode sample code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) definition code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) (DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode  dm)
          Sets the display mode of this graphics device.
 void setFullScreenWindow sample code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window) definition code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window) (Window sample code for java.awt.Window definition code for java.awt.Window  w)
          Enter full-screen mode, or return to windowed mode.
 
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)
 

Field Detail

TYPE_RASTER_SCREEN sample code for java.awt.GraphicsDevice.TYPE_RASTER_SCREEN

public static final int TYPE_RASTER_SCREEN
Device is a raster screen.

See Also:
Constant Field Values

TYPE_PRINTER sample code for java.awt.GraphicsDevice.TYPE_PRINTER

public static final int TYPE_PRINTER
Device is a printer.

See Also:
Constant Field Values

TYPE_IMAGE_BUFFER sample code for java.awt.GraphicsDevice.TYPE_IMAGE_BUFFER

public static final int TYPE_IMAGE_BUFFER
Device is an image buffer. This buffer can reside in device or system memory but it is not physically viewable by the user.

See Also:
Constant Field Values
Constructor Detail

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

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

See Also:
GraphicsEnvironment.getScreenDevices() sample code for java.awt.GraphicsEnvironment.getScreenDevices() definition code for java.awt.GraphicsEnvironment.getScreenDevices() , GraphicsEnvironment.getDefaultScreenDevice() sample code for java.awt.GraphicsEnvironment.getDefaultScreenDevice() definition code for java.awt.GraphicsEnvironment.getDefaultScreenDevice() , GraphicsConfiguration.getDevice() sample code for java.awt.GraphicsConfiguration.getDevice() definition code for java.awt.GraphicsConfiguration.getDevice()
Method Detail

getType sample code for java.awt.GraphicsDevice.getType() definition code for java.awt.GraphicsDevice.getType()

public abstract int getType()
Returns the type of this GraphicsDevice.

Returns:
the type of this GraphicsDevice, which can either be TYPE_RASTER_SCREEN, TYPE_PRINTER or TYPE_IMAGE_BUFFER.
See Also:
TYPE_RASTER_SCREEN sample code for java.awt.GraphicsDevice.TYPE_RASTER_SCREEN definition code for java.awt.GraphicsDevice.TYPE_RASTER_SCREEN , TYPE_PRINTER sample code for java.awt.GraphicsDevice.TYPE_PRINTER definition code for java.awt.GraphicsDevice.TYPE_PRINTER , TYPE_IMAGE_BUFFER sample code for java.awt.GraphicsDevice.TYPE_IMAGE_BUFFER definition code for java.awt.GraphicsDevice.TYPE_IMAGE_BUFFER

getIDstring sample code for java.awt.GraphicsDevice.getIDstring() definition code for java.awt.GraphicsDevice.getIDstring()

public abstract String sample code for java.lang.String definition code for java.lang.String  getIDstring()
Returns the identification string associated with this GraphicsDevice.

A particular program might use more than one GraphicsDevice in a GraphicsEnvironment. This method returns a String identifying a particular GraphicsDevice in the local GraphicsEnvironment. Although there is no public method to set this String, a programmer can use the String for debugging purposes. Vendors of the JavaTM Runtime Environment can format the return value of the String. To determine how to interpret the value of the String, contact the vendor of your Java Runtime. To find out who the vendor is, from your program, call the getProperty sample code for java.lang.System.getProperty(java.lang.String) definition code for java.lang.System.getProperty(java.lang.String) method of the System class with "java.vendor".

Returns:
a String that is the identification of this GraphicsDevice.

getConfigurations sample code for java.awt.GraphicsDevice.getConfigurations() definition code for java.awt.GraphicsDevice.getConfigurations()

public abstract GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration [] getConfigurations()
Returns all of the GraphicsConfiguration objects associated with this GraphicsDevice.

Returns:
an array of GraphicsConfiguration objects that are associated with this GraphicsDevice.

getDefaultConfiguration sample code for java.awt.GraphicsDevice.getDefaultConfiguration() definition code for java.awt.GraphicsDevice.getDefaultConfiguration()

public abstract GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration  getDefaultConfiguration()
Returns the default GraphicsConfiguration associated with this GraphicsDevice.

Returns:
the default GraphicsConfiguration of this GraphicsDevice.

getBestConfiguration sample code for java.awt.GraphicsDevice.getBestConfiguration(java.awt.GraphicsConfigTemplate) definition code for java.awt.GraphicsDevice.getBestConfiguration(java.awt.GraphicsConfigTemplate)

public GraphicsConfiguration sample code for java.awt.GraphicsConfiguration definition code for java.awt.GraphicsConfiguration  getBestConfiguration(GraphicsConfigTemplate sample code for java.awt.GraphicsConfigTemplate definition code for java.awt.GraphicsConfigTemplate  gct)
Returns the "best" configuration possible that passes the criteria defined in the GraphicsConfigTemplate sample code for java.awt.GraphicsConfigTemplate definition code for java.awt.GraphicsConfigTemplate .

Parameters:
gct - the GraphicsConfigTemplate object used to obtain a valid GraphicsConfiguration
Returns:
a GraphicsConfiguration that passes the criteria defined in the specified GraphicsConfigTemplate.
See Also:
GraphicsConfigTemplate sample code for java.awt.GraphicsConfigTemplate definition code for java.awt.GraphicsConfigTemplate

isFullScreenSupported sample code for java.awt.GraphicsDevice.isFullScreenSupported() definition code for java.awt.GraphicsDevice.isFullScreenSupported()

public boolean isFullScreenSupported()
Returns true if this GraphicsDevice supports full-screen exclusive mode.

Returns:
whether full-screen exclusive mode is available for this graphics device
Since:
1.4

setFullScreenWindow sample code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window) definition code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window)

public void setFullScreenWindow(Window sample code for java.awt.Window definition code for java.awt.Window  w)
Enter full-screen mode, or return to windowed mode.

If isFullScreenSupported returns true, full screen mode is considered to be exclusive, which implies:

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).

When entering full-screen exclusive mode, if the window to be used as the full-screen window is not visible, this method will make it visible. It will remain visible when returning to windowed mode.

When returning to windowed mode from an exclusive full-screen window, any display changes made by calling setDisplayMode are automatically restored to their original state.

Parameters:
w - a window to use as the full-screen window; null if returning to windowed mode. Some platforms expect the fullscreen window to be a top-level component (i.e., a Frame); therefore it is preferable to use a Frame here rather than a Window.
Since:
1.4
See Also:
isFullScreenSupported() sample code for java.awt.GraphicsDevice.isFullScreenSupported() definition code for java.awt.GraphicsDevice.isFullScreenSupported() , getFullScreenWindow() sample code for java.awt.GraphicsDevice.getFullScreenWindow() definition code for java.awt.GraphicsDevice.getFullScreenWindow() , setDisplayMode(java.awt.DisplayMode) sample code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) definition code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) , Component.enableInputMethods(boolean) sample code for java.awt.Component.enableInputMethods(boolean) definition code for java.awt.Component.enableInputMethods(boolean) , Component.setVisible(boolean) sample code for java.awt.Component.setVisible(boolean) definition code for java.awt.Component.setVisible(boolean)

getFullScreenWindow sample code for java.awt.GraphicsDevice.getFullScreenWindow() definition code for java.awt.GraphicsDevice.getFullScreenWindow()

public Window sample code for java.awt.Window definition code for java.awt.Window  getFullScreenWindow()
Returns the Window object representing the full-screen window if the device is in full-screen mode.

Returns:
the full-screen window, or null if the device is not in full-screen mode.
Since:
1.4
See Also:
setFullScreenWindow(Window) sample code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window) definition code for java.awt.GraphicsDevice.setFullScreenWindow(java.awt.Window)

isDisplayChangeSupported sample code for java.awt.GraphicsDevice.isDisplayChangeSupported() definition code for java.awt.GraphicsDevice.isDisplayChangeSupported()

public boolean isDisplayChangeSupported()
Returns true if this GraphicsDevice supports low-level display changes.

Returns:
whether low-level display changes are supported for this graphics device. Note that this may or may not be dependent on full-screen exclusive mode.
Since:
1.4
See Also:
setDisplayMode(java.awt.DisplayMode) sample code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) definition code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode)

setDisplayMode sample code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) definition code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode)

public void setDisplayMode(DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode  dm)
Sets the display mode of this graphics device. This may only be allowed in full-screen, exclusive mode.

Parameters:
dm - the new display mode of this graphics device
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the DisplayMode supplied is null, or is not available in the array returned by getDisplayModes
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - if isDisplayChangeSupported returns false
Since:
1.4
See Also:
getDisplayMode() sample code for java.awt.GraphicsDevice.getDisplayMode() definition code for java.awt.GraphicsDevice.getDisplayMode() , getDisplayModes() sample code for java.awt.GraphicsDevice.getDisplayModes() definition code for java.awt.GraphicsDevice.getDisplayModes() , isDisplayChangeSupported() sample code for java.awt.GraphicsDevice.isDisplayChangeSupported() definition code for java.awt.GraphicsDevice.isDisplayChangeSupported()

getDisplayMode sample code for java.awt.GraphicsDevice.getDisplayMode() definition code for java.awt.GraphicsDevice.getDisplayMode()

public DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode  getDisplayMode()
Returns the current display mode of this GraphicsDevice.

Returns:
the current display mode of this graphics device.
Since:
1.4
See Also:
setDisplayMode(DisplayMode) sample code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode) definition code for java.awt.GraphicsDevice.setDisplayMode(java.awt.DisplayMode)

getDisplayModes sample code for java.awt.GraphicsDevice.getDisplayModes() definition code for java.awt.GraphicsDevice.getDisplayModes()

public DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode [] getDisplayModes()
Returns all display modes available for this GraphicsDevice.

Returns:
all of the display modes available for this graphics device.
Since:
1.4

getAvailableAcceleratedMemory sample code for java.awt.GraphicsDevice.getAvailableAcceleratedMemory() definition code for java.awt.GraphicsDevice.getAvailableAcceleratedMemory()

public int getAvailableAcceleratedMemory()
This method returns the number of bytes available in accelerated memory on this device. Some images are created or cached in accelerated memory on a first-come, first-served basis. On some operating systems, this memory is a finite resource. Calling this method and scheduling the creation and flushing of images carefully may enable applications to make the most efficient use of that finite resource.
Note that the number returned is a snapshot of how much memory is available; some images may still have problems being allocated into that memory. For example, depending on operating system, driver, memory configuration, and thread situations, the full extent of the size reported may not be available for a given image. There are further inquiry methods on the ImageCapabilities sample code for java.awt.ImageCapabilities definition code for java.awt.ImageCapabilities object associated with a VolatileImage that can be used to determine whether a particular VolatileImage has been created in accelerated memory.

Returns:
number of bytes available in accelerated memory. A negative return value indicates that accelerated memory is unlimited.
See Also:
VolatileImage.flush() sample code for java.awt.image.VolatileImage.flush() definition code for java.awt.image.VolatileImage.flush() , ImageCapabilities.isAccelerated() sample code for java.awt.ImageCapabilities.isAccelerated() definition code for java.awt.ImageCapabilities.isAccelerated()