GraphicsNode (org.apache.xmlgraphics:batik-gvt 1.12 API)

All Known Implementing Classes:

AbstractGraphicsNode, CanvasGraphicsNode, CompositeGraphicsNode, ImageNode, ProxyGraphicsNode, RasterImageNode, RootGraphicsNode, ShapeNode
```
public interface GraphicsNode
```
The base class for all graphics nodes. A GraphicsNode encapsulates graphical attributes and can perform atomic operations of a complex rendering.

Version:

$Id: GraphicsNode.java 1733416 2016-03-03 07:07:13Z gadams $

Author:

Thierry Kormann, Emmanuel Tissandier

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL` Indicates that this graphics node can be the target for events if any cases.
`static 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.
`static AffineTransform`	`IDENTITY` The identity affine transform matrix used to draw renderable images.
`static int`	`NONE` Indicates that this graphics node can not be the target for events.
`static 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.
`static 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.
`static 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.
`static 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.
`static 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.
`static 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 Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(Point2D p)` Returns true if the specified Point2D is inside the boundary of this node, false otherwise.
`Rectangle2D`	`getBounds()` Returns the bounds of this node in user space.
`ClipRable`	`getClip()` Returns the clipping filter of this node or null if any.
`Composite`	`getComposite()` Returns the composite of this node or null if any.
`Filter`	`getEnableBackgroundGraphicsNodeRable(boolean createIfNeeded)` Returns the GraphicsNodeRable for this node.
`Filter`	`getFilter()` Returns the filter of this node or null if any.
`Rectangle2D`	`getGeometryBounds()` Returns the bounds of the area covered by this node, without taking any of its rendering attribute into account.
`AffineTransform`	`getGlobalTransform()` Returns the concatenated transform of this node.
`Filter`	`getGraphicsNodeRable(boolean createIfNeeded)` Returns the GraphicsNodeRable for this node.
`AffineTransform`	`getInverseTransform()` Returns the inverse transform for this node.
`Mask`	`getMask()` Returns the mask of this node or null if any.
`Shape`	`getOutline()` Returns the outline of this node.
`CompositeGraphicsNode`	`getParent()` Returns the parent of this node or null if any.
`int`	`getPointerEventType()` Returns the type that describes how this graphics node reacts to events.
`Rectangle2D`	`getPrimitiveBounds()` Returns the bounds of the area covered by this node's primitive paint.
`RenderingHints`	`getRenderingHints()` Returns the rendering hints of this node or null if any.
`RootGraphicsNode`	`getRoot()` Returns the root of the GVT tree or null if the node is not part of a GVT tree.
`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.
`AffineTransform`	`getTransform()` Returns the transform of this node or null if any.
`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).
`Rectangle2D`	`getTransformedGeometryBounds(AffineTransform txf)` Returns the bounds of the area covered by this node, without taking any of its rendering attribute into accoun.
`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).
`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.
`WeakReference`	`getWeakReference()` Returns a canonical WeakReference to this GraphicsNode.
`boolean`	`intersects(Rectangle2D r)` Returns true if the interior of this node intersects the interior of a specified Rectangle2D, false otherwise.
`boolean`	`isVisible()` Returns true if this node is visible, false otherwise.
`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.
`void`	`paint(Graphics2D g2d)` Paints this node.
`void`	`primitivePaint(Graphics2D g2d)` Paints this node without applying Filter, Mask, Composite, and clip.
`void`	`setClip(ClipRable newClipper)` Sets the clipping filter of this node.
`void`	`setComposite(Composite newComposite)` Sets the composite of this node.
`void`	`setFilter(Filter newFilter)` Sets the filter of this node.
`void`	`setMask(Mask newMask)` Sets the mask of this node.
`void`	`setPointerEventType(int pointerEventType)` Sets the type that describes how this graphics node reacts to events.
`void`	`setRenderingHint(RenderingHints.Key key, Object value)` Maps the specified key to the specified value in the rendering hints of this node.
`void`	`setRenderingHints(Map hints)` Copies all of the mappings from the specified Map to the rendering hints of this node.
`void`	`setRenderingHints(RenderingHints newHints)` Sets the rendering hints of this node.
`void`	`setTransform(AffineTransform newTransform)` Sets the transform of this node.
`void`	`setVisible(boolean isVisible)` Sets if this node is visible or not depending on the specified value.

- Field Detail
  - VISIBLE_PAINTED
```
static final 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.
    
    See Also:
    Constant Field Values
  - VISIBLE_FILL
```
static final 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.
    
    See Also:
    Constant Field Values
  - VISIBLE_STROKE
```
static final 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.
    
    See Also:
    Constant Field Values
  - VISIBLE
```
static final 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.
    
    See Also:
    Constant Field Values
  - PAINTED
```
static final 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.
    
    See Also:
    Constant Field Values
  - FILL
```
static final 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.
    
    See Also:
    Constant Field Values
  - STROKE
```
static final 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.
    
    See Also:
    Constant Field Values
  - ALL
```
static final int ALL
```
    Indicates that this graphics node can be the target for events if any cases.
    
    See Also:
    Constant Field Values
  - NONE
```
static final int NONE
```
    Indicates that this graphics node can not be the target for events.
    
    See Also:
    Constant Field Values
  - IDENTITY
```
static final AffineTransform IDENTITY
```
    The identity affine transform matrix used to draw renderable images.
- Method Detail
  - getWeakReference
```
WeakReference getWeakReference()
```
    Returns a canonical WeakReference to this GraphicsNode. This is suitable for use as a key value in a hash map
  - getPointerEventType
```
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
  - setPointerEventType
```
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
  - setTransform
```
void setTransform(AffineTransform newTransform)
```
    Sets the transform of this node.
    
    Parameters:
    newTransform - the new transform of this node
  - getTransform
```
AffineTransform getTransform()
```
    Returns the transform of this node or null if any.
  - getInverseTransform
```
AffineTransform getInverseTransform()
```
    Returns the inverse transform for this node.
  - getGlobalTransform
```
AffineTransform getGlobalTransform()
```
    Returns the concatenated transform of this node. That is, this node's transform preconcatenated with it's parent's transforms.
  - setComposite
```
void setComposite(Composite newComposite)
```
    Sets the composite of this node.
    
    Parameters:
    newComposite - the composite of this node
  - getComposite
```
Composite getComposite()
```
    Returns the composite of this node or null if any.
  - setVisible
```
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
  - isVisible
```
boolean isVisible()
```
    Returns true if this node is visible, false otherwise.
  - setClip
```
void setClip(ClipRable newClipper)
```
    Sets the clipping filter of this node.
    
    Parameters:
    newClipper - the new clipping filter of this node
  - getClip
```
ClipRable getClip()
```
    Returns the clipping filter of this node or null if any.
  - setRenderingHint
```
void setRenderingHint(RenderingHints.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
```
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
```
void setRenderingHints(RenderingHints newHints)
```
    Sets the rendering hints of this node.
    
    Parameters:
    newHints - the new rendering hints of this node
  - getRenderingHints
```
RenderingHints getRenderingHints()
```
    Returns the rendering hints of this node or null if any.
  - setMask
```
void setMask(Mask newMask)
```
    Sets the mask of this node.
    
    Parameters:
    newMask - the new mask of this node
  - getMask
```
Mask getMask()
```
    Returns the mask of this node or null if any.
  - setFilter
```
void setFilter(Filter newFilter)
```
    Sets the filter of this node.
    
    Parameters:
    newFilter - the new filter of this node
  - getFilter
```
Filter getFilter()
```
    Returns the filter of this node or null if any.
  - getGraphicsNodeRable
```
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.
  - getEnableBackgroundGraphicsNodeRable
```
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.
  - paint
```
void paint(Graphics2D g2d)
```
    Paints this node.
    
    Parameters:
    g2d - the Graphics2D to use
  - primitivePaint
```
void primitivePaint(Graphics2D g2d)
```
    Paints this node without applying Filter, Mask, Composite, and clip.
    
    Parameters:
    g2d - the Graphics2D to use
  - getParent
```
CompositeGraphicsNode getParent()
```
    Returns the parent of this node or null if any.
  - getRoot
```
RootGraphicsNode getRoot()
```
    Returns the root of the GVT tree or null if the node is not part of a GVT tree.
  - getBounds
```
Rectangle2D getBounds()
```
    Returns the bounds of this node in user space. This includes primitive paint, filtering, clipping and masking.
  - getTransformedBounds
```
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.
  - getPrimitiveBounds
```
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.
  - getTransformedPrimitiveBounds
```
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.
  - getGeometryBounds
```
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.
  - getTransformedGeometryBounds
```
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.
  - getSensitiveBounds
```
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.
  - getTransformedSensitiveBounds
```
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.
  - contains
```
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
  - intersects
```
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
  - nodeHitAt
```
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
  - getOutline
```
Shape getOutline()
```
    Returns the outline of this node.

Interface GraphicsNode

Field Summary

Method Summary

Field Detail

VISIBLE_PAINTED

VISIBLE_FILL

VISIBLE_STROKE

VISIBLE

PAINTED

FILL

STROKE

ALL

NONE

IDENTITY

Method Detail

getWeakReference

getPointerEventType

setPointerEventType

setTransform

getTransform

getInverseTransform

getGlobalTransform

setComposite

getComposite

setVisible

isVisible

setClip

getClip

setRenderingHint

setRenderingHints

setRenderingHints

getRenderingHints

setMask

getMask

setFilter

getFilter

getGraphicsNodeRable

getEnableBackgroundGraphicsNodeRable

paint

primitivePaint

getParent

getRoot

getBounds

getTransformedBounds

getPrimitiveBounds

getTransformedPrimitiveBounds

getGeometryBounds

getTransformedGeometryBounds

getSensitiveBounds

getTransformedSensitiveBounds

contains

intersects

nodeHitAt

getOutline