public interface RenderableImage
A RenderedImage is returned from a RenderableImage via the createRendering() method, which takes a RenderContext. The RenderContext specifies how the RenderedImage should be constructed. Note that it is not possible to extract pixels directly from a RenderableImage.
The createDefaultRendering() and createScaledRendering() methods are convenience methods that construct an appropriate RenderContext internally. All of the rendering methods may return a reference to a previously produced rendering.
| Modifier and Type | Field and Description |
|---|---|
static String |
HINTS_OBSERVED
String constant that can be used to identify a property on
a RenderedImage obtained via the createRendering or
createScaledRendering methods.
|
| Modifier and Type | Method and Description |
|---|---|
RenderedImage |
createDefaultRendering()
Returnd a RenderedImage instance of this image with a default
width and height in pixels.
|
RenderedImage |
createRendering(RenderContext renderContext)
Creates a RenderedImage that represented a rendering of this image
using a given RenderContext.
|
RenderedImage |
createScaledRendering(int w,
int h,
RenderingHints hints)
Creates a RenderedImage instance of this image with width w, and
height h in pixels.
|
float |
getHeight()
Gets the height in user coordinate space.
|
float |
getMinX()
Gets the minimum X coordinate of the rendering-independent image data.
|
float |
getMinY()
Gets the minimum Y coordinate of the rendering-independent image data.
|
Object |
getProperty(String name)
Gets a property from the property set of this image.
|
String[] |
getPropertyNames()
Returns a list of names recognized by getProperty.
|
Vector<RenderableImage> |
getSources()
Returns a vector of RenderableImages that are the sources of
image data for this RenderableImage.
|
float |
getWidth()
Gets the width in user coordinate space.
|
boolean |
isDynamic()
Returns true if successive renderings (that is, calls to
createRendering() or createScaledRendering()) with the same arguments
may produce different results.
|
static final String HINTS_OBSERVED
Vector<RenderableImage> getSources()
Object getProperty(String name)
name - the name of the property to get, as a String.String[] getPropertyNames()
boolean isDynamic()
true if successive renderings with the
same arguments might produce different results;
false otherwise.float getWidth()
float getHeight()
float getMinX()
float getMinY()
RenderedImage createScaledRendering(int w, int h, RenderingHints hints)
If w == 0, it will be taken to equal Math.round(h*(getWidth()/getHeight())). Similarly, if h == 0, it will be taken to equal Math.round(w*(getHeight()/getWidth())). One of w or h must be non-zero or else an IllegalArgumentException will be thrown.
The created RenderedImage may have a property identified by the String HINTS_OBSERVED to indicate which RenderingHints were used to create the image. In addition any RenderedImages that are obtained via the getSources() method on the created RenderedImage may have such a property.
w - the width of rendered image in pixels, or 0.h - the height of rendered image in pixels, or 0.hints - a RenderingHints object containing hints.RenderedImage createDefaultRendering()
RenderedImage createRendering(RenderContext renderContext)
The created RenderedImage may have a property identified by the String HINTS_OBSERVED to indicate which RenderingHints (from the RenderContext) were used to create the image. In addition any RenderedImages that are obtained via the getSources() method on the created RenderedImage may have such a property.
renderContext - the RenderContext to use to produce the rendering. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.