org.apache.batik.gvt.filter

Class BackgroundRable8Bit

public class BackgroundRable8Bit extends AbstractRable

This implementation of RenderableImage will render its input GraphicsNode into a BufferedImage upon invokation of one of its createRendering methods.
Constructor Summary
BackgroundRable8Bit(GraphicsNode node)
Method Summary
RenderedImagecreateRendering(RenderContext renderContext)
Creates a RenderedImage that represented a rendering of this image using a given RenderContext.
FiltergetBackground(GraphicsNode gn, GraphicsNode child, Rectangle2D aoi)
Returns a filter that represents the background image for child.
Rectangle2DgetBounds2D()
Returns the bounds of this Rable in the user coordinate system.
GraphicsNodegetGraphicsNode()
Returns the GraphicsNode rendered by this image
booleanisDynamic()
Returns true if successive renderings (that is, calls to createRendering() or createScaledRendering()) with the same arguments may produce different results.
voidsetGraphicsNode(GraphicsNode node)
Sets the GraphicsNode this image should render

Constructor Detail

BackgroundRable8Bit

public BackgroundRable8Bit(GraphicsNode node)

Parameters: node The GraphicsNode this image should represent

Method Detail

createRendering

public RenderedImage createRendering(RenderContext renderContext)
Creates a RenderedImage that represented a rendering of this image using a given RenderContext. This is the most general way to obtain a rendering of a RenderableImage.

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 the RenderContext to use to produce the rendering.

Returns: a RenderedImage containing the rendered data.

getBackground

public Filter getBackground(GraphicsNode gn, GraphicsNode child, Rectangle2D aoi)
Returns a filter that represents the background image for child.

Parameters: gn Node to get background image for. child Child to stop at when compositing children of gn into the background image. aoi The area of interest for rendering (used to cull nodes that don't intersect the region to render).

getBounds2D

public Rectangle2D getBounds2D()
Returns the bounds of this Rable in the user coordinate system.

getGraphicsNode

public GraphicsNode getGraphicsNode()
Returns the GraphicsNode rendered by this image

isDynamic

public boolean 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. It is always safe to return true.

setGraphicsNode

public void setGraphicsNode(GraphicsNode node)
Sets the GraphicsNode this image should render
Copyright B) 2008 Apache Software Foundation. All Rights Reserved.