org.apache.batik.gvt.filter

Class GraphicsNodeRable8Bit

public class GraphicsNodeRable8Bit extends AbstractRable implements GraphicsNodeRable, PaintRable

This implementation of RenderableImage will render its input GraphicsNode into a BufferedImage upon invokation of one of its createRendering methods.
Constructor Summary
GraphicsNodeRable8Bit(GraphicsNode node)
GraphicsNodeRable8Bit(GraphicsNode node, Map props)
GraphicsNodeRable8Bit(GraphicsNode node, boolean usePrimitivePaint)
Method Summary
voidclearCache()
Clear any cached Red.
RenderedImagecreateRendering(RenderContext renderContext)
Creates a RenderedImage that represented a rendering of this image using a given RenderContext.
Rectangle2DgetBounds2D()
Returns the bounds of this Rable in the user coordinate system.
GraphicsNodegetGraphicsNode()
Returns the GraphicsNode rendered by this image
booleangetUsePrimitivePaint()
Returns true if this Rable get's it's contents by calling primitivePaint on the associated GraphicsNode or false if it uses paint.
booleanisDynamic()
Returns true if successive renderings (that is, calls to createRendering() or createScaledRendering()) with the same arguments may produce different results.
booleanpaintRable(Graphics2D g2d)
Should perform the equivilent action as createRendering followed by drawing the RenderedImage to Graphics2D, or return false.
voidsetGraphicsNode(GraphicsNode node)
Sets the GraphicsNode this image should render
voidsetUsePrimitivePaint(boolean usePrimitivePaint)
Set to true if this Rable should get it's contents by calling primitivePaint on the associated GraphicsNode or false if it should use paint.

Constructor Detail

GraphicsNodeRable8Bit

public GraphicsNodeRable8Bit(GraphicsNode node)

Parameters: node The GraphicsNode this image should represent

GraphicsNodeRable8Bit

public GraphicsNodeRable8Bit(GraphicsNode node, Map props)

Parameters: node The GraphicsNode this image should represent props The Properties for this image.

GraphicsNodeRable8Bit

public GraphicsNodeRable8Bit(GraphicsNode node, boolean usePrimitivePaint)

Parameters: node the GraphicsNode this image should represent usePrimitivePaint indicates if the image should include any filters or mask operations on node

Method Detail

clearCache

public void clearCache()
Clear any cached Red.

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.

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

getUsePrimitivePaint

public boolean getUsePrimitivePaint()
Returns true if this Rable get's it's contents by calling primitivePaint on the associated GraphicsNode or false if it uses paint.

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.

paintRable

public boolean paintRable(Graphics2D g2d)
Should perform the equivilent action as createRendering followed by drawing the RenderedImage to Graphics2D, or return false.

Parameters: g2d The Graphics2D to draw to.

Returns: true if the paint call succeeded, false if for some reason the paint failed (in which case a createRendering should be used).

setGraphicsNode

public void setGraphicsNode(GraphicsNode node)
Sets the GraphicsNode this image should render

setUsePrimitivePaint

public void setUsePrimitivePaint(boolean usePrimitivePaint)
Set to true if this Rable should get it's contents by calling primitivePaint on the associated GraphicsNode or false if it should use paint.
Copyright B) 2008 Apache Software Foundation. All Rights Reserved.