org.apache.batik.gvt

Interface GraphicsNode

public interface GraphicsNode

The base class for all graphics nodes. A GraphicsNode encapsulates graphical attributes and can perform atomic operations of a complex rendering.
Field Summary
intALL
Indicates that this graphics node can be the target for events if any cases.
intFILL
Indicates that this graphics node can be the target for events when the mouse is over the filled area whatever or not it is the visible.
AffineTransformIDENTITY
The identity affine transform matrix used to draw renderable images.
intNONE
Indicates that this graphics node can not be the target for events.
intPAINTED
Indicates that this graphics node can be the target for events when the mouse is over the painted area whatever or not it is the visible.
intSTROKE
Indicates that this graphics node can be the target for events when the mouse is over the stroked area whatever or not it is the visible.
intVISIBLE
Indicates that this graphics node can be the target for events when it is visible and whatever is the filled and stroked area.
intVISIBLE_FILL
Indicates that this graphics node can be the target for events when it is visible and when the mouse is over the filled area if any.
intVISIBLE_PAINTED
Indicates that this graphics node can be the target for events when it is visible and when the mouse is over the "painted" area.
intVISIBLE_STROKE
Indicates that this graphics node can be the target for events when it is visible and when the mouse is over the stroked area if any.
Method Summary
booleancontains(Point2D p)
Returns true if the specified Point2D is inside the boundary of this node, false otherwise.
Rectangle2DgetBounds()
Returns the bounds of this node in user space.
ClipRablegetClip()
Returns the clipping filter of this node or null if any.
CompositegetComposite()
Returns the composite of this node or null if any.
FiltergetEnableBackgroundGraphicsNodeRable(boolean createIfNeeded)
Returns the GraphicsNodeRable for this node.
FiltergetFilter()
Returns the filter of this node or null if any.
Rectangle2DgetGeometryBounds()
Returns the bounds of the area covered by this node, without taking any of its rendering attribute into account.
AffineTransformgetGlobalTransform()
Returns the concatenated transform of this node.
FiltergetGraphicsNodeRable(boolean createIfNeeded)
Returns the GraphicsNodeRable for this node.
AffineTransformgetInverseTransform()
Returns the inverse transform for this node.
MaskgetMask()
Returns the mask of this node or null if any.
ShapegetOutline()
Returns the outline of this node.
CompositeGraphicsNodegetParent()
Returns the parent of this node or null if any.
intgetPointerEventType()
Returns the type that describes how this graphics node reacts to events.
Rectangle2DgetPrimitiveBounds()
Returns the bounds of the area covered by this node's primitive paint.
RenderingHintsgetRenderingHints()
Returns the rendering hints of this node or null if any.
RootGraphicsNodegetRoot()
Returns the root of the GVT tree or null if the node is not part of a GVT tree.
Rectangle2DgetSensitiveBounds()
Returns the bounds of the sensitive area covered by this node, This includes the stroked area but does not include the effects of clipping, masking or filtering.
AffineTransformgetTransform()
Returns the transform of this node or null if any.
Rectangle2DgetTransformedBounds(AffineTransform txf)
Returns the bounds of this node after applying the input transform (if any), concatenated with this node's transform (if any).
Rectangle2DgetTransformedGeometryBounds(AffineTransform txf)
Returns the bounds of the area covered by this node, without taking any of its rendering attribute into accoun.
Rectangle2DgetTransformedPrimitiveBounds(AffineTransform txf)
Returns the bounds of this node's primitivePaint after applying the input transform (if any), concatenated with this node's transform (if any).
Rectangle2DgetTransformedSensitiveBounds(AffineTransform txf)
Returns the bounds of the sensitive area covered by this node, This includes the stroked area but does not include the effects of clipping, masking or filtering.
WeakReferencegetWeakReference()
Returns a canonical WeakReference to this GraphicsNode.
booleanintersects(Rectangle2D r)
Returns true if the interior of this node intersects the interior of a specified Rectangle2D, false otherwise.
booleanisVisible()
Returns true if this node is visible, false otherwise.
GraphicsNodenodeHitAt(Point2D p)
Returns the GraphicsNode containing point p if this node or one of its children is sensitive to mouse events at p.
voidpaint(Graphics2D g2d)
Paints this node.
voidprimitivePaint(Graphics2D g2d)
Paints this node without applying Filter, Mask, Composite, and clip.
voidsetClip(ClipRable newClipper)
Sets the clipping filter of this node.
voidsetComposite(Composite newComposite)
Sets the composite of this node.
voidsetFilter(Filter newFilter)
Sets the filter of this node.
voidsetMask(Mask newMask)
Sets the mask of this node.
voidsetPointerEventType(int pointerEventType)
Sets the type that describes how this graphics node reacts to events.
voidsetRenderingHint(Key key, Object value)
Maps the specified key to the specified value in the rendering hints of this node.
voidsetRenderingHints(Map hints)
Copies all of the mappings from the specified Map to the rendering hints of this node.
voidsetRenderingHints(RenderingHints newHints)
Sets the rendering hints of this node.
voidsetTransform(AffineTransform newTransform)
Sets the transform of this node.
voidsetVisible(boolean isVisible)
Sets if this node is visible or not depending on the specified value.

Field Detail

ALL

public int ALL
Indicates that this graphics node can be the target for events if any cases.

FILL

public int FILL
Indicates that this graphics node can be the target for events when the mouse is over the filled area whatever or not it is the visible.

IDENTITY

public AffineTransform IDENTITY
The identity affine transform matrix used to draw renderable images.

NONE

public int NONE
Indicates that this graphics node can not be the target for events.

PAINTED

public int PAINTED
Indicates that this graphics node can be the target for events when the mouse is over the painted area whatever or not it is the visible.

STROKE

public int STROKE
Indicates that this graphics node can be the target for events when the mouse is over the stroked area whatever or not it is the visible.

VISIBLE

public int VISIBLE
Indicates that this graphics node can be the target for events when it is visible and whatever is the filled and stroked area.

VISIBLE_FILL

public int VISIBLE_FILL
Indicates that this graphics node can be the target for events when it is visible and when the mouse is over the filled area if any.

VISIBLE_PAINTED

public int VISIBLE_PAINTED
Indicates that this graphics node can be the target for events when it is visible and when the mouse is over the "painted" area.

VISIBLE_STROKE

public int VISIBLE_STROKE
Indicates that this graphics node can be the target for events when it is visible and when the mouse is over the stroked area if any.

Method Detail

contains

public boolean contains(Point2D p)
Returns true if the specified Point2D is inside the boundary of this node, false otherwise.

Parameters: p the specified Point2D in the user space

getBounds

public Rectangle2D getBounds()
Returns the bounds of this node in user space. This includes primitive paint, filtering, clipping and masking.

getClip

public ClipRable getClip()
Returns the clipping filter of this node or null if any.

getComposite

public Composite getComposite()
Returns the composite of this node or null if any.

getEnableBackgroundGraphicsNodeRable

public Filter getEnableBackgroundGraphicsNodeRable(boolean createIfNeeded)
Returns the GraphicsNodeRable for this node. This GraphicsNodeRable is the Renderable (Filter) after all of the filter operations have been applied.

getFilter

public Filter getFilter()
Returns the filter of this node or null if any.

getGeometryBounds

public Rectangle2D getGeometryBounds()
Returns the bounds of the area covered by this node, without taking any of its rendering attribute into account. That is, exclusive of any clipping, masking, filtering or stroking, for example.

getGlobalTransform

public AffineTransform getGlobalTransform()
Returns the concatenated transform of this node. That is, this node's transform preconcatenated with it's parent's transforms.

getGraphicsNodeRable

public Filter getGraphicsNodeRable(boolean createIfNeeded)
Returns the GraphicsNodeRable for this node. This GraphicsNodeRable is the Renderable (Filter) before any of the filter operations have been applied.

getInverseTransform

public AffineTransform getInverseTransform()
Returns the inverse transform for this node.

getMask

public Mask getMask()
Returns the mask of this node or null if any.

getOutline

public Shape getOutline()
Returns the outline of this node.

getParent

public CompositeGraphicsNode getParent()
Returns the parent of this node or null if any.

getPointerEventType

public int getPointerEventType()
Returns the type that describes how this graphics node reacts to events.

Returns: VISIBLE_PAINTED | VISIBLE_FILL | VISIBLE_STROKE | VISIBLE | PAINTED | FILL | STROKE | ALL | NONE

getPrimitiveBounds

public Rectangle2D getPrimitiveBounds()
Returns the bounds of the area covered by this node's primitive paint. This is the painted region of fill and stroke but does not account for clipping, masking or filtering.

getRenderingHints

public RenderingHints getRenderingHints()
Returns the rendering hints of this node or null if any.

getRoot

public RootGraphicsNode getRoot()
Returns the root of the GVT tree or null if the node is not part of a GVT tree.

getSensitiveBounds

public Rectangle2D getSensitiveBounds()
Returns the bounds of the sensitive area covered by this node, This includes the stroked area but does not include the effects of clipping, masking or filtering.

getTransform

public AffineTransform getTransform()
Returns the transform of this node or null if any.

getTransformedBounds

public Rectangle2D getTransformedBounds(AffineTransform txf)
Returns the bounds of this node after applying the input transform (if any), concatenated with this node's transform (if any).

Parameters: txf the affine transform with which this node's transform should be concatenated. Should not be null.

getTransformedGeometryBounds

public Rectangle2D getTransformedGeometryBounds(AffineTransform txf)
Returns the bounds of the area covered by this node, without taking any of its rendering attribute into accoun. That is, exclusive of any clipping, masking, filtering or stroking, for example. The returned value is transformed by the concatenation of the input transform and this node's transform.

Parameters: txf the affine transform with which this node's transform should be concatenated. Should not be null.

getTransformedPrimitiveBounds

public Rectangle2D getTransformedPrimitiveBounds(AffineTransform txf)
Returns the bounds of this node's primitivePaint after applying the input transform (if any), concatenated with this node's transform (if any).

Parameters: txf the affine transform with which this node's transform should be concatenated. Should not be null.

getTransformedSensitiveBounds

public Rectangle2D getTransformedSensitiveBounds(AffineTransform txf)
Returns the bounds of the sensitive area covered by this node, This includes the stroked area but does not include the effects of clipping, masking or filtering. The returned value is transformed by the concatenation of the input transform and this node's transform.

Parameters: txf the affine transform with which this node's transform should be concatenated. Should not be null.

getWeakReference

public WeakReference getWeakReference()
Returns a canonical WeakReference to this GraphicsNode. This is suitable for use as a key value in a hash map

intersects

public boolean intersects(Rectangle2D r)
Returns true if the interior of this node intersects the interior of a specified Rectangle2D, false otherwise.

Parameters: r the specified Rectangle2D in the user node space

isVisible

public boolean isVisible()
Returns true if this node is visible, false otherwise.

nodeHitAt

public GraphicsNode nodeHitAt(Point2D p)
Returns the GraphicsNode containing point p if this node or one of its children is sensitive to mouse events at p.

Parameters: p the specified Point2D in the user space

paint

public void paint(Graphics2D g2d)
Paints this node.

Parameters: g2d the Graphics2D to use

primitivePaint

public void primitivePaint(Graphics2D g2d)
Paints this node without applying Filter, Mask, Composite, and clip.

Parameters: g2d the Graphics2D to use

setClip

public void setClip(ClipRable newClipper)
Sets the clipping filter of this node.

Parameters: newClipper the new clipping filter of this node

setComposite

public void setComposite(Composite newComposite)
Sets the composite of this node.

Parameters: newComposite the composite of this node

setFilter

public void setFilter(Filter newFilter)
Sets the filter of this node.

Parameters: newFilter the new filter of this node

setMask

public void setMask(Mask newMask)
Sets the mask of this node.

Parameters: newMask the new mask of this node

setPointerEventType

public void setPointerEventType(int pointerEventType)
Sets the type that describes how this graphics node reacts to events.

Parameters: pointerEventType VISIBLE_PAINTED | VISIBLE_FILL | VISIBLE_STROKE | VISIBLE | PAINTED | FILL | STROKE | ALL | NONE

setRenderingHint

public void setRenderingHint(Key key, Object value)
Maps the specified key to the specified value in the rendering hints of this node.

Parameters: key the key of the hint to be set value the value indicating preferences for the specified hint category.

setRenderingHints

public void setRenderingHints(Map hints)
Copies all of the mappings from the specified Map to the rendering hints of this node.

Parameters: hints the rendering hints to be set

setRenderingHints

public void setRenderingHints(RenderingHints newHints)
Sets the rendering hints of this node.

Parameters: newHints the new rendering hints of this node

setTransform

public void setTransform(AffineTransform newTransform)
Sets the transform of this node.

Parameters: newTransform the new transform of this node

setVisible

public void setVisible(boolean isVisible)
Sets if this node is visible or not depending on the specified value.

Parameters: isVisible If true this node is visible

Copyright B) 2007 Apache Software Foundation. All Rights Reserved.