/*
* @(#)GraphicsDevice.java 1.30 03/12/19
*
* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package java.awt;
import java.awt.image.ColorModel;
/**
* 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 {@link GraphicsEnvironment}. Each
* graphics device has one or more {@link 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 GraphicsEnvironment * @see GraphicsConfiguration * @version 1.30, 12/19/03 */ public abstract class GraphicsDevice { private Window fullScreenWindow; private Rectangle windowedModeBounds; /** * This is an abstract class that cannot be instantiated directly. * Instances must be obtained from a suitable factory or query method. * @see GraphicsEnvironment#getScreenDevices * @see GraphicsEnvironment#getDefaultScreenDevice * @see GraphicsConfiguration#getDevice */ protected GraphicsDevice() { } /** * Device is a raster screen. */ public final static int TYPE_RASTER_SCREEN = 0; /** * Device is a printer. */ public final static int TYPE_PRINTER = 1; /** * Device is an image buffer. This buffer can reside in device * or system memory but it is not physically viewable by the user. */ public final static int TYPE_IMAGE_BUFFER = 2; /** * Returns the type of this
GraphicsDevice
.
* @return the type of this GraphicsDevice
, which can
* either be TYPE_RASTER_SCREEN, TYPE_PRINTER or TYPE_IMAGE_BUFFER.
* @see #TYPE_RASTER_SCREEN
* @see #TYPE_PRINTER
* @see #TYPE_IMAGE_BUFFER
*/
public abstract int getType();
/**
* 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
* {@link System#getProperty(String) getProperty} method of the
* System class with "java.vendor".
* @return a String
that is the identification
* of this GraphicsDevice
.
*/
public abstract String getIDstring();
/**
* Returns all of the GraphicsConfiguration
* objects associated with this GraphicsDevice
.
* @return an array of GraphicsConfiguration
* objects that are associated with this
* GraphicsDevice
.
*/
public abstract GraphicsConfiguration[] getConfigurations();
/**
* Returns the default GraphicsConfiguration
* associated with this GraphicsDevice
.
* @return the default GraphicsConfiguration
* of this GraphicsDevice
.
*/
public abstract GraphicsConfiguration getDefaultConfiguration();
/**
* Returns the "best" configuration possible that passes the
* criteria defined in the {@link GraphicsConfigTemplate}.
* @param gct the GraphicsConfigTemplate
object
* used to obtain a valid GraphicsConfiguration
* @return a GraphicsConfiguration
that passes
* the criteria defined in the specified
* GraphicsConfigTemplate
.
* @see GraphicsConfigTemplate
*/
public GraphicsConfiguration
getBestConfiguration(GraphicsConfigTemplate gct) {
GraphicsConfiguration[] configs = getConfigurations();
return gct.getBestConfiguration(configs);
}
/**
* Returns true
if this GraphicsDevice
* supports full-screen exclusive mode.
* @return whether full-screen exclusive mode is available for
* this graphics device
* @since 1.4
*/
public boolean isFullScreenSupported() {
return false;
}
/**
* Enter full-screen mode, or return to windowed mode.
*
* If isFullScreenSupported
returns true
, full
* screen mode is considered to be exclusive, which implies:
*
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).
*
* 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.
*
* @param 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.
* @see #isFullScreenSupported
* @see #getFullScreenWindow
* @see #setDisplayMode
* @see Component#enableInputMethods
* @see Component#setVisible
* @since 1.4
*/
public void setFullScreenWindow(Window w) {
// Get display mode before changing the full screen window
DisplayMode dm;
if (w == null) {
dm = null;
} else {
dm = getDisplayMode();
}
if (fullScreenWindow != null && windowedModeBounds != null) {
fullScreenWindow.setBounds(windowedModeBounds);
}
// Set the full screen window
fullScreenWindow = w;
if (fullScreenWindow != null) {
windowedModeBounds = fullScreenWindow.getBounds();
fullScreenWindow.setBounds(0, 0, dm.getWidth(), dm.getHeight());
fullScreenWindow.setVisible(true);
fullScreenWindow.toFront();
}
}
/**
* Returns the Window
object representing the
* full-screen window if the device is in full-screen mode.
*
* @return the full-screen window, or null
if the device is
* not in full-screen mode.
* @see #setFullScreenWindow(Window)
* @since 1.4
*/
public Window getFullScreenWindow() {
return fullScreenWindow;
}
/**
* Returns true
if this GraphicsDevice
* supports low-level display changes.
* @return 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.
* @see #setDisplayMode
* @since 1.4
*/
public boolean isDisplayChangeSupported() {
return false;
}
/**
* Sets the display mode of this graphics device. This may only be allowed
* in full-screen, exclusive mode.
* @param dm the new display mode of this graphics device
* @exception IllegalArgumentException if the DisplayMode
* supplied is null
, or is not available in the array returned
* by getDisplayModes
* @exception UnsupportedOperationException if
* isDisplayChangeSupported
returns false
* @see #getDisplayMode
* @see #getDisplayModes
* @see #isDisplayChangeSupported
* @since 1.4
*/
public void setDisplayMode(DisplayMode dm) {
throw new UnsupportedOperationException("Cannot change display mode");
}
/**
* Returns the current display mode of this
* GraphicsDevice
.
* @return the current display mode of this graphics device.
* @see #setDisplayMode(DisplayMode)
* @since 1.4
*/
public DisplayMode getDisplayMode() {
GraphicsConfiguration gc = getDefaultConfiguration();
Rectangle r = gc.getBounds();
ColorModel cm = gc.getColorModel();
return new DisplayMode(r.width, r.height, cm.getPixelSize(), 0);
}
/**
* Returns all display modes available for this
* GraphicsDevice
.
* @return all of the display modes available for this graphics device.
* @since 1.4
*/
public DisplayMode[] getDisplayModes() {
return new DisplayMode[] { getDisplayMode() };
}
/**
* 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 {@link ImageCapabilities} object
* associated with a VolatileImage that can be used to determine
* whether a particular VolatileImage has been created in accelerated
* memory.
* @return number of bytes available in accelerated memory.
* A negative return value indicates that accelerated memory
* is unlimited.
* @see java.awt.image.VolatileImage#flush
* @see ImageCapabilities#isAccelerated
*/
public int getAvailableAcceleratedMemory() {
return -1;
}
}