edu.umd.cs.piccolo.nodes
Class PImage

java.lang.Object
  edu.umd.cs.piccolo.PNode
      edu.umd.cs.piccolo.nodes.PImage

All Implemented Interfaces:

java.lang.Cloneable, java.awt.print.Printable, java.io.Serializable

public class PImage

extends PNode

PImage is a wrapper around a java.awt.Image. If this node is copied or serialized that image will be converted into a BufferedImage if it is not already one.

Version:

1.0

Author:

Jesse Grosjean

See Also:

Serialized Form

Field Summary

static java.lang.String

PROPERTY_IMAGE The property name that identifies a change of this node's image (see getImage).

Fields inherited from class edu.umd.cs.piccolo.PNode

PROPERTY_BOUNDS, PROPERTY_CHILDREN, PROPERTY_CHILDREN_PICKABLE, PROPERTY_CLIENT_PROPERTIES, PROPERTY_FULL_BOUNDS, PROPERTY_PAINT, PROPERTY_PARENT, PROPERTY_PICKABLE, PROPERTY_TRANSFORM, PROPERTY_TRANSPARENCY, PROPERTY_VISIBLE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

PImage()

PImage(java.awt.Image newImage)
Construct a new PImage wrapping the given java.awt.Image.

PImage(java.lang.String fileName)
Construct a new PImage by loading the given fileName and wrapping the resulting java.awt.Image.

PImage(java.net.URL url)
Construct a new PImage by loading the given url and wrapping the resulting java.awt.Image.

Method Summary

java.awt.Image	getImage() Returns the image that is shown by this node.
protected void	paint(PPaintContext paintContext) Paint this node behind any of its children nodes.
protected java.lang.String	paramString() Returns a string representing the state of this node.
void	setImage(java.awt.Image newImage) Set the image that is wrapped by this PImage node.
void	setImage(java.lang.String fileName) Set the image that is wrapped by this PImage node.
static java.awt.image.BufferedImage	toBufferedImage(java.awt.Image image, boolean alwaysCreateCopy) If alwaysCreateCopy is false then if the image is already a buffered image it will not be copied and instead the original image will just be returned.

Methods inherited from class edu.umd.cs.piccolo.PNode

addActivity, addChild, addChild, addChildren, addClientProperty, addInputEventListener, addPropertyChangeListener, addPropertyChangeListener, animateToBounds, animateToColor, animateToPositionScaleRotation, animateToTransform, animateToTransparency, centerBoundsOnPoint, centerFullBoundsOnPoint, clone, computeFullBounds, endResizeBounds, findIntersectingNodes, firePropertyChange, fullIntersects, fullPaint, fullPick, getAllNodes, getAllNodes, getBounds, getBoundsChanged, getBoundsReference, getBoundsVolatile, getChild, getChildBoundsInvalid, getChildBoundsVolatile, getChildPaintInvalid, getChildrenCount, getChildrenIterator, getChildrenPickable, getChildrenReference, getClientProperty, getClientPropertyKeysIterator, getFullBounds, getFullBoundsInvalid, getFullBoundsReference, getGlobalBounds, getGlobalFullBounds, getGlobalRotation, getGlobalScale, getGlobalToLocalTransform, getGlobalTranslation, getHeight, getInverseTransform, getListenerList, getLocalToGlobalTransform, getOccluded, getOffset, getPaint, getPaintInvalid, getParent, getPickable, getRoot, getRotation, getScale, getTransform, getTransformReference, getTransparency, getUnionOfChildrenBounds, getVisible, getWidth, getX, getXOffset, getY, getYOffset, globalToLocal, globalToLocal, globalToLocal, indexOfChild, internalUpdateBounds, intersects, invalidateFullBounds, invalidateLayout, invalidatePaint, isAncestorOf, isDescendentOf, isDescendentOfRoot, isOpaque, layoutChildren, lerp, localToGlobal, localToGlobal, localToGlobal, localToParent, localToParent, localToParent, moveInBackOf, moveInFrontOf, moveToBack, moveToFront, offset, paintAfterChildren, parentBoundsChanged, parentToLocal, parentToLocal, parentToLocal, pick, pickAfterChildren, position, print, print, removeAllChildren, removeChild, removeChild, removeChildren, removeFromParent, removeInputEventListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaintFrom, reparent, replaceWith, resetBounds, rotate, rotateAboutPoint, rotateAboutPoint, rotateInPlace, scale, scaleAboutPoint, scaleAboutPoint, setBounds, setBounds, setBoundsChanged, setChildBoundsInvalid, setChildBoundsVolatile, setChildPaintInvalid, setChildrenPickable, setFullBoundsInvalid, setGlobalRotation, setGlobalScale, setGlobalTranslation, setHeight, setOccluded, setOffset, setOffset, setPaint, setPaintInvalid, setParent, setPickable, setRotation, setScale, setTransform, setTransparency, setVisible, setWidth, setX, setY, signalBoundsChanged, startResizeBounds, toImage, toImage, toString, transformBy, translate, validateFullBounds, validateFullPaint

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_IMAGE

public static final java.lang.String PROPERTY_IMAGE

The property name that identifies a change of this node's image (see getImage). Both old and new value will be set correctly to Image objects in any property change event.

See Also:

Constant Field Values

Constructor Detail

PImage

public PImage()

PImage

public PImage(java.awt.Image newImage)

Construct a new PImage wrapping the given java.awt.Image.

PImage

public PImage(java.lang.String fileName)

Construct a new PImage by loading the given fileName and wrapping the resulting java.awt.Image.

PImage

public PImage(java.net.URL url)

Construct a new PImage by loading the given url and wrapping the resulting java.awt.Image. If the url is null, create an empty PImage; this behaviour is useful when fetching resources that may be missing.

Method Detail

getImage

public java.awt.Image getImage()

Returns the image that is shown by this node.

Returns:

the image that is shown by this node

setImage

public void setImage(java.lang.String fileName)

Set the image that is wrapped by this PImage node. This method will also load the image using a MediaTracker before returning.

setImage

public void setImage(java.awt.Image newImage)

Set the image that is wrapped by this PImage node. This method will also load the image using a MediaTracker before returning.

paint

protected void paint(PPaintContext paintContext)

Description copied from class: PNode

Paint this node behind any of its children nodes. Subclasses that define a different appearance should override this method and paint themselves there.

Overrides:

paint in class PNode

Parameters:

paintContext - the paint context to use for painting the node

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(java.awt.Image image,
                                                           boolean alwaysCreateCopy)

If alwaysCreateCopy is false then if the image is already a buffered image it will not be copied and instead the original image will just be returned.

paramString

protected java.lang.String paramString()

Returns a string representing the state of this node. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class PNode

Returns:

a string representation of this node's state