< prev index next >
src/java.desktop/share/classes/java/awt/GraphicsConfiguration.java
Print this page
@@ -32,48 +32,48 @@
import java.awt.image.WritableRaster;
import sun.awt.image.SunVolatileImage;
/**
- * The <code>GraphicsConfiguration</code> class describes the
+ * The {@code GraphicsConfiguration} class describes the
* characteristics of a graphics destination such as a printer or monitor.
- * There can be many <code>GraphicsConfiguration</code> objects associated
+ * There can be many {@code GraphicsConfiguration} objects associated
* with a single graphics device, representing different drawing modes or
* capabilities. The corresponding native structure will vary from platform
* to platform. For example, on X11 windowing systems,
- * each visual is a different <code>GraphicsConfiguration</code>.
- * On Microsoft Windows, <code>GraphicsConfiguration</code>s represent
+ * each visual is a different {@code GraphicsConfiguration}.
+ * On Microsoft Windows, {@code GraphicsConfiguration}s represent
* PixelFormats available in the current resolution and color depth.
* <p>
* In a virtual device multi-screen environment in which the desktop
* area could span multiple physical screen devices, the bounds of the
- * <code>GraphicsConfiguration</code> objects are relative to the
+ * {@code GraphicsConfiguration} objects are relative to the
* virtual coordinate system. When setting the location of a
* component, use {@link #getBounds() getBounds} to get the bounds of
- * the desired <code>GraphicsConfiguration</code> and offset the location
- * with the coordinates of the <code>GraphicsConfiguration</code>,
+ * the desired {@code GraphicsConfiguration} and offset the location
+ * with the coordinates of the {@code GraphicsConfiguration},
* as the following code sample illustrates:
* </p>
*
* <pre>
* Frame f = new Frame(gc); // where gc is a GraphicsConfiguration
* Rectangle bounds = gc.getBounds();
* f.setLocation(10 + bounds.x, 10 + bounds.y); </pre>
*
* <p>
* To determine if your environment is a virtual device
- * environment, call <code>getBounds</code> on all of the
- * <code>GraphicsConfiguration</code> objects in your system. If
+ * environment, call {@code getBounds} on all of the
+ * {@code GraphicsConfiguration} objects in your system. If
* any of the origins of the returned bounds is not (0, 0),
* your environment is a virtual device environment.
*
* <p>
- * You can also use <code>getBounds</code> to determine the bounds
- * of the virtual device. To do this, first call <code>getBounds</code> on all
- * of the <code>GraphicsConfiguration</code> objects in your
+ * You can also use {@code getBounds} to determine the bounds
+ * of the virtual device. To do this, first call {@code getBounds} on all
+ * of the {@code GraphicsConfiguration} objects in your
* system. Then calculate the union of all of the bounds returned
- * from the calls to <code>getBounds</code>. The union is the
+ * from the calls to {@code getBounds}. The union is the
* bounds of the virtual device. The following code sample
* calculates the bounds of the virtual device.
*
* <pre>{@code
* Rectangle virtualBounds = new Rectangle();
@@ -123,50 +123,50 @@
protected GraphicsConfiguration() {
}
/**
* Returns the {@link GraphicsDevice} associated with this
- * <code>GraphicsConfiguration</code>.
- * @return a <code>GraphicsDevice</code> object that is
- * associated with this <code>GraphicsConfiguration</code>.
+ * {@code GraphicsConfiguration}.
+ * @return a {@code GraphicsDevice} object that is
+ * associated with this {@code GraphicsConfiguration}.
*/
public abstract GraphicsDevice getDevice();
/**
* Returns a {@link BufferedImage} with a data layout and color model
- * compatible with this <code>GraphicsConfiguration</code>. This
+ * compatible with this {@code GraphicsConfiguration}. This
* method has nothing to do with memory-mapping
- * a device. The returned <code>BufferedImage</code> has
+ * a device. The returned {@code BufferedImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
- * @param width the width of the returned <code>BufferedImage</code>
- * @param height the height of the returned <code>BufferedImage</code>
- * @return a <code>BufferedImage</code> whose data layout and color
- * model is compatible with this <code>GraphicsConfiguration</code>.
+ * @param width the width of the returned {@code BufferedImage}
+ * @param height the height of the returned {@code BufferedImage}
+ * @return a {@code BufferedImage} whose data layout and color
+ * model is compatible with this {@code GraphicsConfiguration}.
*/
public BufferedImage createCompatibleImage(int width, int height) {
ColorModel model = getColorModel();
WritableRaster raster =
model.createCompatibleWritableRaster(width, height);
return new BufferedImage(model, raster,
model.isAlphaPremultiplied(), null);
}
/**
- * Returns a <code>BufferedImage</code> that supports the specified
+ * Returns a {@code BufferedImage} that supports the specified
* transparency and has a data layout and color model
- * compatible with this <code>GraphicsConfiguration</code>. This
+ * compatible with this {@code GraphicsConfiguration}. This
* method has nothing to do with memory-mapping
- * a device. The returned <code>BufferedImage</code> has a layout and
+ * a device. The returned {@code BufferedImage} has a layout and
* color model that can be optimally blitted to a device
- * with this <code>GraphicsConfiguration</code>.
- * @param width the width of the returned <code>BufferedImage</code>
- * @param height the height of the returned <code>BufferedImage</code>
+ * with this {@code GraphicsConfiguration}.
+ * @param width the width of the returned {@code BufferedImage}
+ * @param height the height of the returned {@code BufferedImage}
* @param transparency the specified transparency mode
- * @return a <code>BufferedImage</code> whose data layout and color
- * model is compatible with this <code>GraphicsConfiguration</code>
+ * @return a {@code BufferedImage} whose data layout and color
+ * model is compatible with this {@code GraphicsConfiguration}
* and also supports the specified transparency.
* @throws IllegalArgumentException if the transparency is not a valid value
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
* @see Transparency#TRANSLUCENT
@@ -188,19 +188,19 @@
}
/**
* Returns a {@link VolatileImage} with a data layout and color model
- * compatible with this <code>GraphicsConfiguration</code>.
- * The returned <code>VolatileImage</code>
+ * compatible with this {@code GraphicsConfiguration}.
+ * The returned {@code VolatileImage}
* may have data that is stored optimally for the underlying graphics
* device and may therefore benefit from platform-specific rendering
* acceleration.
- * @param width the width of the returned <code>VolatileImage</code>
- * @param height the height of the returned <code>VolatileImage</code>
- * @return a <code>VolatileImage</code> whose data layout and color
- * model is compatible with this <code>GraphicsConfiguration</code>.
+ * @param width the width of the returned {@code VolatileImage}
+ * @param height the height of the returned {@code VolatileImage}
+ * @return a {@code VolatileImage} whose data layout and color
+ * model is compatible with this {@code GraphicsConfiguration}.
* @see Component#createVolatileImage(int, int)
* @since 1.4
*/
public VolatileImage createCompatibleVolatileImage(int width, int height) {
VolatileImage vi = null;
@@ -214,20 +214,20 @@
return vi;
}
/**
* Returns a {@link VolatileImage} with a data layout and color model
- * compatible with this <code>GraphicsConfiguration</code>.
- * The returned <code>VolatileImage</code>
+ * compatible with this {@code GraphicsConfiguration}.
+ * The returned {@code VolatileImage}
* may have data that is stored optimally for the underlying graphics
* device and may therefore benefit from platform-specific rendering
* acceleration.
- * @param width the width of the returned <code>VolatileImage</code>
- * @param height the height of the returned <code>VolatileImage</code>
+ * @param width the width of the returned {@code VolatileImage}
+ * @param height the height of the returned {@code VolatileImage}
* @param transparency the specified transparency mode
- * @return a <code>VolatileImage</code> whose data layout and color
- * model is compatible with this <code>GraphicsConfiguration</code>.
+ * @return a {@code VolatileImage} whose data layout and color
+ * model is compatible with this {@code GraphicsConfiguration}.
* @throws IllegalArgumentException if the transparency is not a valid value
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
* @see Transparency#TRANSLUCENT
* @see Component#createVolatileImage(int, int)
@@ -246,24 +246,24 @@
return vi;
}
/**
* Returns a {@link VolatileImage} with a data layout and color model
- * compatible with this <code>GraphicsConfiguration</code>, using
+ * compatible with this {@code GraphicsConfiguration}, using
* the specified image capabilities.
- * If the <code>caps</code> parameter is null, it is effectively ignored
+ * If the {@code caps} parameter is null, it is effectively ignored
* and this method will create a VolatileImage without regard to
- * <code>ImageCapabilities</code> constraints.
+ * {@code ImageCapabilities} constraints.
*
- * The returned <code>VolatileImage</code> has
+ * The returned {@code VolatileImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
- * @return a <code>VolatileImage</code> whose data layout and color
- * model is compatible with this <code>GraphicsConfiguration</code>.
- * @param width the width of the returned <code>VolatileImage</code>
- * @param height the height of the returned <code>VolatileImage</code>
+ * @return a {@code VolatileImage} whose data layout and color
+ * model is compatible with this {@code GraphicsConfiguration}.
+ * @param width the width of the returned {@code VolatileImage}
+ * @param height the height of the returned {@code VolatileImage}
* @param caps the image capabilities
* @exception AWTException if the supplied image capabilities could not
* be met by this graphics configuration
* @since 1.4
*/
@@ -274,26 +274,26 @@
Transparency.OPAQUE);
}
/**
* Returns a {@link VolatileImage} with a data layout and color model
- * compatible with this <code>GraphicsConfiguration</code>, using
+ * compatible with this {@code GraphicsConfiguration}, using
* the specified image capabilities and transparency value.
- * If the <code>caps</code> parameter is null, it is effectively ignored
+ * If the {@code caps} parameter is null, it is effectively ignored
* and this method will create a VolatileImage without regard to
- * <code>ImageCapabilities</code> constraints.
+ * {@code ImageCapabilities} constraints.
*
- * The returned <code>VolatileImage</code> has
+ * The returned {@code VolatileImage} has
* a layout and color model that is closest to this native device
* configuration and can therefore be optimally blitted to this
* device.
- * @param width the width of the returned <code>VolatileImage</code>
- * @param height the height of the returned <code>VolatileImage</code>
+ * @param width the width of the returned {@code VolatileImage}
+ * @param height the height of the returned {@code VolatileImage}
* @param caps the image capabilities
* @param transparency the specified transparency mode
- * @return a <code>VolatileImage</code> whose data layout and color
- * model is compatible with this <code>GraphicsConfiguration</code>.
+ * @return a {@code VolatileImage} whose data layout and color
+ * model is compatible with this {@code GraphicsConfiguration}.
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
* @see Transparency#TRANSLUCENT
* @throws IllegalArgumentException if the transparency is not a valid value
* @exception AWTException if the supplied image capabilities could not
@@ -315,57 +315,57 @@
return vi;
}
/**
* Returns the {@link ColorModel} associated with this
- * <code>GraphicsConfiguration</code>.
- * @return a <code>ColorModel</code> object that is associated with
- * this <code>GraphicsConfiguration</code>.
+ * {@code GraphicsConfiguration}.
+ * @return a {@code ColorModel} object that is associated with
+ * this {@code GraphicsConfiguration}.
*/
public abstract ColorModel getColorModel();
/**
- * Returns the <code>ColorModel</code> associated with this
- * <code>GraphicsConfiguration</code> that supports the specified
+ * Returns the {@code ColorModel} associated with this
+ * {@code GraphicsConfiguration} that supports the specified
* transparency.
* @param transparency the specified transparency mode
- * @return a <code>ColorModel</code> object that is associated with
- * this <code>GraphicsConfiguration</code> and supports the
+ * @return a {@code ColorModel} object that is associated with
+ * this {@code GraphicsConfiguration} and supports the
* specified transparency or null if the transparency is not a valid
* value.
* @see Transparency#OPAQUE
* @see Transparency#BITMASK
* @see Transparency#TRANSLUCENT
*/
public abstract ColorModel getColorModel(int transparency);
/**
* Returns the default {@link AffineTransform} for this
- * <code>GraphicsConfiguration</code>. This
- * <code>AffineTransform</code> is typically the Identity transform
- * for most normal screens. The default <code>AffineTransform</code>
+ * {@code GraphicsConfiguration}. This
+ * {@code AffineTransform} is typically the Identity transform
+ * for most normal screens. The default {@code AffineTransform}
* maps coordinates onto the device such that 72 user space
* coordinate units measure approximately 1 inch in device
* space. The normalizing transform can be used to make
* this mapping more exact. Coordinates in the coordinate space
- * defined by the default <code>AffineTransform</code> for screen and
+ * defined by the default {@code AffineTransform} for screen and
* printer devices have the origin in the upper left-hand corner of
* the target region of the device, with X coordinates
* increasing to the right and Y coordinates increasing downwards.
* For image buffers not associated with a device, such as those not
- * created by <code>createCompatibleImage</code>,
- * this <code>AffineTransform</code> is the Identity transform.
- * @return the default <code>AffineTransform</code> for this
- * <code>GraphicsConfiguration</code>.
+ * created by {@code createCompatibleImage},
+ * this {@code AffineTransform} is the Identity transform.
+ * @return the default {@code AffineTransform} for this
+ * {@code GraphicsConfiguration}.
*/
public abstract AffineTransform getDefaultTransform();
/**
*
- * Returns a <code>AffineTransform</code> that can be concatenated
- * with the default <code>AffineTransform</code>
- * of a <code>GraphicsConfiguration</code> so that 72 units in user
+ * Returns a {@code AffineTransform} that can be concatenated
+ * with the default {@code AffineTransform}
+ * of a {@code GraphicsConfiguration} so that 72 units in user
* space equals 1 inch in device space.
* <p>
* For a particular {@link Graphics2D}, g, one
* can reset the transformation to create
* such a mapping by using the following pseudocode:
@@ -373,31 +373,31 @@
* GraphicsConfiguration gc = g.getDeviceConfiguration();
*
* g.setTransform(gc.getDefaultTransform());
* g.transform(gc.getNormalizingTransform());
* </pre>
- * Note that sometimes this <code>AffineTransform</code> is identity,
+ * Note that sometimes this {@code AffineTransform} is identity,
* such as for printers or metafile output, and that this
- * <code>AffineTransform</code> is only as accurate as the information
+ * {@code AffineTransform} is only as accurate as the information
* supplied by the underlying system. For image buffers not
* associated with a device, such as those not created by
- * <code>createCompatibleImage</code>, this
- * <code>AffineTransform</code> is the Identity transform
+ * {@code createCompatibleImage}, this
+ * {@code AffineTransform} is the Identity transform
* since there is no valid distance measurement.
- * @return an <code>AffineTransform</code> to concatenate to the
- * default <code>AffineTransform</code> so that 72 units in user
+ * @return an {@code AffineTransform} to concatenate to the
+ * default {@code AffineTransform} so that 72 units in user
* space is mapped to 1 inch in device space.
*/
public abstract AffineTransform getNormalizingTransform();
/**
- * Returns the bounds of the <code>GraphicsConfiguration</code>
+ * Returns the bounds of the {@code GraphicsConfiguration}
* in the device coordinates. In a multi-screen environment
* with a virtual device, the bounds can have negative X
* or Y origins.
* @return the bounds of the area covered by this
- * <code>GraphicsConfiguration</code>.
+ * {@code GraphicsConfiguration}.
* @since 1.3
*/
public abstract Rectangle getBounds();
private static class DefaultBufferCapabilities extends BufferCapabilities {
@@ -406,11 +406,11 @@
}
}
/**
* Returns the buffering capabilities of this
- * <code>GraphicsConfiguration</code>.
+ * {@code GraphicsConfiguration}.
* @return the buffering capabilities of this graphics
* configuration object
* @since 1.4
*/
public BufferCapabilities getBufferCapabilities() {
@@ -421,11 +421,11 @@
return defaultBufferCaps;
}
/**
* Returns the image capabilities of this
- * <code>GraphicsConfiguration</code>.
+ * {@code GraphicsConfiguration}.
* @return the image capabilities of this graphics
* configuration object
* @since 1.4
*/
public ImageCapabilities getImageCapabilities() {
< prev index next >