OpenJDK 27 · java.awt.image.renderable.RenderableImageOp

Modifier and Type	Field and Description
pack-priv Rectangle2D	boundingBox The bounding box of the results of this RenderableImageOp.
pack-priv ContextualRenderedImageFactory	myCRIF The associated ContextualRenderedImageFactory.
pack-priv ParameterBlock	paramBlock A ParameterBlock containing source and parameters.

Access	Constructor and Description
public	RenderableImageOp(ContextualRenderedImageFactory a ContextualRenderedImageFactory object CRIF, ParameterBlock a ParameterBlock containing this operation's source images and other parameters necessary for the operation to run. paramBlock) Constructs a `RenderableImageOp` given a ContextualRenderedImageFactory object, and a ParameterBlock containing RenderableImage sources and other parameters.

Method Summary

Modifier and Type	Method and Description
public RenderedImage	Returns: a RenderedImage containing the rendered data. createDefaultRendering() Implements java.awt.image.renderable.RenderableImage.createDefaultRendering. Gets a RenderedImage instance of this image with a default width and height in pixels.
public RenderedImage	Returns: a RenderedImage containing the desired output image. createRendering(RenderContext The RenderContext to use to perform the rendering. renderContext) Implements java.awt.image.renderable.RenderableImage.createRendering. Creates a RenderedImage which represents this RenderableImageOp (including its Renderable sources) rendered according to the given RenderContext.
public RenderedImage	Returns: a RenderedImage containing the rendered data. createScaledRendering(int the width of rendered image in pixels, or 0. w, int the height of rendered image in pixels, or 0. h, RenderingHints a RenderingHints object containing hints. hints) Implements java.awt.image.renderable.RenderableImage.createScaledRendering. Creates a RenderedImage instance of this image with width w, and height h in pixels.
public float	Returns: the height of the image in user coordinates. getHeight() Implements java.awt.image.renderable.RenderableImage.getHeight. Gets the height in user coordinate space.
public float	getMinX() Implements java.awt.image.renderable.RenderableImage.getMinX. Gets the minimum X coordinate of the rendering-independent image data.
public float	getMinY() Implements java.awt.image.renderable.RenderableImage.getMinY. Gets the minimum Y coordinate of the rendering-independent image data.
public ParameterBlock	Returns: the `ParameterBlock` of this `RenderableImageOp`. getParameterBlock() Returns a reference to the current parameter block.
public Object	Returns: a reference to the property Object, or the value java.awt.Image.UndefinedProperty. getProperty(String the name of the property to get, as a String. name) Implements java.awt.image.renderable.RenderableImage.getProperty. Gets a property from the property set of this image.
public String[]	Returns: a list of property names. getPropertyNames() Implements java.awt.image.renderable.RenderableImage.getPropertyNames. Return a list of names recognized by getProperty.
private Vector<RenderableImage>	getRenderableSources()
public Vector<RenderableImage>	Returns: a (possibly empty) Vector of RenderableImages, or null. getSources() Implements java.awt.image.renderable.RenderableImage.getSources. Returns a vector of RenderableImages that are the sources of image data for this RenderableImage.
public float	Returns: the width of the image in user coordinates. getWidth() Implements java.awt.image.renderable.RenderableImage.getWidth. Gets the width in user coordinate space.
public boolean	Returns: `true` if successive renderings with the same arguments might produce different results; `false` otherwise. isDynamic() Implements java.awt.image.renderable.RenderableImage.isDynamic. Returns true if successive renderings (that is, calls to createRendering() or createScaledRendering()) with the same arguments may produce different results.
public ParameterBlock	Returns: the old ParameterBlock. setParameterBlock(ParameterBlock the new ParameterBlock. paramBlock) Change the current ParameterBlock of the operation, allowing editing of image rendering chains.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

boundingBox	back to summary
pack-priv Rectangle2D boundingBox The bounding box of the results of this RenderableImageOp.

myCRIF	back to summary
pack-priv ContextualRenderedImageFactory myCRIF The associated ContextualRenderedImageFactory.

paramBlock	back to summary
pack-priv ParameterBlock paramBlock A ParameterBlock containing source and parameters.

RenderableImageOp	back to summary
public RenderableImageOp(ContextualRenderedImageFactory CRIF, ParameterBlock paramBlock) Constructs a `RenderableImageOp` given a ContextualRenderedImageFactory object, and a ParameterBlock containing RenderableImage sources and other parameters. Any RenderedImage sources referenced by the ParameterBlock will be ignored. Parameters CRIF:ContextualRenderedImageFactory a ContextualRenderedImageFactory object paramBlock:ParameterBlock a ParameterBlock containing this operation's source images and other parameters necessary for the operation to run.

Method Detail

createDefaultRendering	back to summary
public RenderedImage createDefaultRendering() Implements java.awt.image.renderable.RenderableImage.createDefaultRendering. Gets a RenderedImage instance of this image with a default width and height in pixels. The RenderContext is built automatically with an appropriate usr2dev transform and an area of interest of the full image. All the rendering hints come from hints passed in. Implementors of this interface must be sure that there is a defined default width and height. Returns:RenderedImage a RenderedImage containing the rendered data.

createDefaultRendering

back to summary

public RenderedImage createDefaultRendering()

Implements java.awt.image.renderable.RenderableImage.createDefaultRendering.

Gets a RenderedImage instance of this image with a default width and height in pixels. The RenderContext is built automatically with an appropriate usr2dev transform and an area of interest of the full image. All the rendering hints come from hints passed in. Implementors of this interface must be sure that there is a defined default width and height.

Returns:RenderedImage: a RenderedImage containing the rendered data.

createRendering	back to summary
public RenderedImage createRendering(RenderContext renderContext) Implements java.awt.image.renderable.RenderableImage.createRendering. Creates a RenderedImage which represents this RenderableImageOp (including its Renderable sources) rendered according to the given RenderContext. This method supports chaining of either Renderable or RenderedImage operations. If sources in the ParameterBlock used to construct the RenderableImageOp are RenderableImages, then a three step process is followed: mapRenderContext() is called on the associated CRIF for each RenderableImage source; createRendering() is called on each of the RenderableImage sources using the backwards-mapped RenderContexts obtained in step 1, resulting in a rendering of each source; ContextualRenderedImageFactory.create() is called with a new ParameterBlock containing the parameters of the RenderableImageOp and the RenderedImages that were created by the createRendering() calls. If the elements of the source Vector of the ParameterBlock used to construct the RenderableImageOp are instances of RenderedImage, then the CRIF.create() method is called immediately using the original ParameterBlock. This provides a basis case for the recursion. 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. Parameters renderContext:RenderContext The RenderContext to use to perform the rendering. Returns:RenderedImage a RenderedImage containing the desired output image.

createRendering

back to summary

public RenderedImage createRendering(RenderContext renderContext)

Implements java.awt.image.renderable.RenderableImage.createRendering.

Creates a RenderedImage which represents this RenderableImageOp (including its Renderable sources) rendered according to the given RenderContext.

This method supports chaining of either Renderable or RenderedImage operations. If sources in the ParameterBlock used to construct the RenderableImageOp are RenderableImages, then a three step process is followed:

mapRenderContext() is called on the associated CRIF for each RenderableImage source;
createRendering() is called on each of the RenderableImage sources using the backwards-mapped RenderContexts obtained in step 1, resulting in a rendering of each source;
ContextualRenderedImageFactory.create() is called with a new ParameterBlock containing the parameters of the RenderableImageOp and the RenderedImages that were created by the createRendering() calls.

If the elements of the source Vector of the ParameterBlock used to construct the RenderableImageOp are instances of RenderedImage, then the CRIF.create() method is called immediately using the original ParameterBlock. This provides a basis case for the recursion.

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.

Parameters

renderContext:RenderContext: The RenderContext to use to perform the rendering.

Returns:RenderedImage

a RenderedImage containing the desired output image.

createScaledRendering	back to summary
public RenderedImage createScaledRendering(int w, int h, RenderingHints hints) Implements java.awt.image.renderable.RenderableImage.createScaledRendering. Creates a RenderedImage instance of this image with width w, and height h in pixels. The RenderContext is built automatically with an appropriate usr2dev transform and an area of interest of the full image. All the rendering hints come from hints passed in. 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. Parameters w:int the width of rendered image in pixels, or 0. h:int the height of rendered image in pixels, or 0. hints:RenderingHints a RenderingHints object containing hints. Returns:RenderedImage a RenderedImage containing the rendered data.

createScaledRendering

back to summary

public RenderedImage createScaledRendering(int w, int h, RenderingHints hints)

Implements java.awt.image.renderable.RenderableImage.createScaledRendering.

Creates a RenderedImage instance of this image with width w, and height h in pixels. The RenderContext is built automatically with an appropriate usr2dev transform and an area of interest of the full image. All the rendering hints come from hints passed in.

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.

Parameters

w:int: the width of rendered image in pixels, or 0.
h:int: the height of rendered image in pixels, or 0.
hints:RenderingHints: a RenderingHints object containing hints.

Returns:RenderedImage

a RenderedImage containing the rendered data.

getHeight	back to summary
public float getHeight() Implements java.awt.image.renderable.RenderableImage.getHeight. Gets the height in user coordinate space. By convention, the usual height of a RenderedImage is equal to 1.0F. Returns:float the height of the image in user coordinates.

getHeight

back to summary

public float getHeight()

Implements java.awt.image.renderable.RenderableImage.getHeight.

Gets the height in user coordinate space. By convention, the usual height of a RenderedImage is equal to 1.0F.

Returns:float: the height of the image in user coordinates.

getMinX	back to summary
public float getMinX() Implements java.awt.image.renderable.RenderableImage.getMinX. Gets the minimum X coordinate of the rendering-independent image data.

getMinX

back to summary

public float getMinX()

Implements java.awt.image.renderable.RenderableImage.getMinX.

Gets the minimum X coordinate of the rendering-independent image data.

getMinY	back to summary
public float getMinY() Implements java.awt.image.renderable.RenderableImage.getMinY. Gets the minimum Y coordinate of the rendering-independent image data.

getMinY

back to summary

public float getMinY()

Implements java.awt.image.renderable.RenderableImage.getMinY.

Gets the minimum Y coordinate of the rendering-independent image data.

getParameterBlock back to summary

getParameterBlock	back to summary
public ParameterBlock getParameterBlock() Returns a reference to the current parameter block. Returns:ParameterBlock the `ParameterBlock` of this `RenderableImageOp`. See Also `setParameterBlock(ParameterBlock)`

public ParameterBlock getParameterBlock()

Returns a reference to the current parameter block.

Returns:ParameterBlock: the ParameterBlock of this RenderableImageOp.
See Also: setParameterBlock(ParameterBlock)

getProperty	back to summary
public Object getProperty(String name) Implements java.awt.image.renderable.RenderableImage.getProperty. Gets a property from the property set of this image. If the property name is not recognized, java.awt.Image.UndefinedProperty will be returned. Parameters name:String the name of the property to get, as a String. Returns:Object a reference to the property Object, or the value java.awt.Image.UndefinedProperty.

getProperty

back to summary

public Object getProperty(String name)

Implements java.awt.image.renderable.RenderableImage.getProperty.

Gets a property from the property set of this image. If the property name is not recognized, java.awt.Image.UndefinedProperty will be returned.

Parameters

name:String: the name of the property to get, as a String.

Returns:Object

a reference to the property Object, or the value java.awt.Image.UndefinedProperty.

getPropertyNames	back to summary
public String[] getPropertyNames() Implements java.awt.image.renderable.RenderableImage.getPropertyNames. Return a list of names recognized by getProperty. Returns:String[] a list of property names.

getPropertyNames

back to summary

public String[] getPropertyNames()

Implements java.awt.image.renderable.RenderableImage.getPropertyNames.

Return a list of names recognized by getProperty.

Returns:String[]: a list of property names.

getRenderableSources	back to summary
private Vector<RenderableImage> getRenderableSources()

getSources	back to summary
public Vector<RenderableImage> getSources() Implements java.awt.image.renderable.RenderableImage.getSources. Returns a vector of RenderableImages that are the sources of image data for this RenderableImage. Note that this method may return an empty vector, to indicate that the image has no sources, or null, to indicate that no information is available. Returns:Vector<RenderableImage> a (possibly empty) Vector of RenderableImages, or null.

getSources

back to summary

public Vector<RenderableImage> getSources()

Implements java.awt.image.renderable.RenderableImage.getSources.

Returns a vector of RenderableImages that are the sources of image data for this RenderableImage. Note that this method may return an empty vector, to indicate that the image has no sources, or null, to indicate that no information is available.

Returns:Vector<RenderableImage>: a (possibly empty) Vector of RenderableImages, or null.

getWidth	back to summary
public float getWidth() Implements java.awt.image.renderable.RenderableImage.getWidth. Gets the width in user coordinate space. By convention, the usual width of a RenderableImage is equal to the image's aspect ratio (width divided by height). Returns:float the width of the image in user coordinates.

getWidth

back to summary

public float getWidth()

Implements java.awt.image.renderable.RenderableImage.getWidth.

Gets the width in user coordinate space. By convention, the usual width of a RenderableImage is equal to the image's aspect ratio (width divided by height).

Returns:float: the width of the image in user coordinates.

isDynamic back to summary

isDynamic	back to summary
public boolean isDynamic() Implements java.awt.image.renderable.RenderableImage.isDynamic. Returns true if successive renderings (that is, calls to createRendering() or createScaledRendering()) with the same arguments may produce different results. This method may be used to determine whether an existing rendering may be cached and reused. The CRIF's isDynamic method will be called. Returns:boolean `true` if successive renderings with the same arguments might produce different results; `false` otherwise.

public boolean isDynamic()

Implements java.awt.image.renderable.RenderableImage.isDynamic.

Returns true if successive renderings (that is, calls to createRendering() or createScaledRendering()) with the same arguments may produce different results. This method may be used to determine whether an existing rendering may be cached and reused. The CRIF's isDynamic method will be called.

Returns:boolean: true if successive renderings with the same arguments might produce different results; false otherwise.

setParameterBlock back to summary

setParameterBlock	back to summary
public ParameterBlock setParameterBlock(ParameterBlock paramBlock) Change the current ParameterBlock of the operation, allowing editing of image rendering chains. The effects of such a change will be visible when a new rendering is created from this RenderableImageOp or any dependent RenderableImageOp. Parameters paramBlock:ParameterBlock the new ParameterBlock. Returns:ParameterBlock the old ParameterBlock. See Also `getParameterBlock`

public ParameterBlock setParameterBlock(ParameterBlock paramBlock)

Change the current ParameterBlock of the operation, allowing editing of image rendering chains. The effects of such a change will be visible when a new rendering is created from this RenderableImageOp or any dependent RenderableImageOp.

Parameters

paramBlock:ParameterBlock: the new ParameterBlock.

Returns:ParameterBlock

the old ParameterBlock.

See Also

getParameterBlock

public Class RenderableImageOp

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail