edu.umd.cs.piccolox.swt
Class PSWTImage

java.lang.Object
  edu.umd.cs.piccolo.PNode
      edu.umd.cs.piccolox.swt.PSWTImage

All Implemented Interfaces:

Printable, Serializable, Cloneable

public class PSWTImage
extends PNode

PSWTImage is a wrapper around a org.eclipse.swt.graphics.Image.

Version:

1.0

Author:

Jesse Grosjean

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.umd.cs.piccolo.PNode

PNode.PSceneGraphDelegate

Field Summary

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

FILL_STRATEGY_ASPECT_COVER, FILL_STRATEGY_ASPECT_FIT, FILL_STRATEGY_EXACT_FIT, PROPERTY_BOUNDS, PROPERTY_CHILDREN, PROPERTY_CHILDREN_PICKABLE, PROPERTY_CLIENT_PROPERTIES, PROPERTY_CODE_BOUNDS, PROPERTY_CODE_CHILDREN, PROPERTY_CODE_CHILDREN_PICKABLE, PROPERTY_CODE_CLIENT_PROPERTIES, PROPERTY_CODE_FULL_BOUNDS, PROPERTY_CODE_PAINT, PROPERTY_CODE_PARENT, PROPERTY_CODE_PICKABLE, PROPERTY_CODE_TRANSFORM, PROPERTY_CODE_TRANSPARENCY, PROPERTY_CODE_VISIBLE, PROPERTY_FULL_BOUNDS, PROPERTY_PAINT, PROPERTY_PARENT, PROPERTY_PICKABLE, PROPERTY_TRANSFORM, PROPERTY_TRANSPARENCY, PROPERTY_VISIBLE, SCENE_GRAPH_DELEGATE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

PSWTImage(PSWTCanvas canvas)
Constructs a PSWTImage attached to the provided canvas and with a null image.

PSWTImage(PSWTCanvas canvas, org.eclipse.swt.graphics.Image image)
Constructs a PSWTImage wrapping the provided image.

PSWTImage(PSWTCanvas canvas, String fileName)
Constructs a PSWTImage wrapping the provided image after loading it from the file.

Method Summary

protected void	disposeImage() Subclasses may override this method to provide different image dispose behavior.
org.eclipse.swt.graphics.Image	getImage() Returns the image that is shown by this node, may be null.
protected void	paint(PPaintContext paintContext) Paint this node behind any of its children nodes.
void	setImage(org.eclipse.swt.graphics.Image newImage) Set the image that is wrapped by this PImage node.
void	setImage(String filePath) Set the image that is wrapped by this PImage node.

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

addActivity, addAttribute, addChild, addChild, addChildren, addClientProperty, addInputEventListener, addPropertyChangeListener, addPropertyChangeListener, animateToBounds, animateToColor, animateToPositionScaleRotation, animateToRelativePosition, animateToTransform, animateToTransparency, animateTransformToBounds, centerBoundsOnPoint, centerFullBoundsOnPoint, clone, computeFullBounds, endResizeBounds, findIntersectingNodes, fireChildPropertyChange, firePropertyChange, fullIntersects, fullPaint, fullPick, getAllNodes, getAllNodes, getAttribute, getAttribute, getBooleanAttribute, getBounds, getBoundsChanged, getBoundsReference, getBoundsVolatile, getChild, getChildBoundsInvalid, getChildBoundsVolatile, getChildPaintInvalid, getChildrenCount, getChildrenIterator, getChildrenPickable, getChildrenReference, getClientProperties, getClientProperty, getClientPropertyKeysEnumeration, getClientPropertyKeysIterator, getDoubleAttribute, getFullBounds, getFullBoundsInvalid, getFullBoundsReference, getGlobalBounds, getGlobalFullBounds, getGlobalRotation, getGlobalScale, getGlobalToLocalTransform, getGlobalTranslation, getHeight, getInputEventListeners, getIntegerAttribute, getInverseTransform, getListenerList, getLocalToGlobalTransform, getName, getOccluded, getOffset, getPaint, getPaintInvalid, getParent, getPickable, getPropertyChangeParentMask, 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, paramString, 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, setName, setOccluded, setOffset, setOffset, setPaint, setPaintInvalid, setParent, setPickable, setPropertyChangeParentMask, setRotation, setScale, setTransform, setTransparency, setVisible, setWidth, setX, setY, signalBoundsChanged, startResizeBounds, toImage, toImage, toImage, toImage, transformBy, translate, validateFullBounds, validateFullPaint

Methods inherited from class java.lang.Object

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

Constructor Detail

PSWTImage

public PSWTImage(PSWTCanvas canvas)

Constructs a PSWTImage attached to the provided canvas and with a null image. The developer will need to call setImage for this node to be useful. TODO: determine if canvas is actually necessary

Parameters:

canvas - canvas to associate with the image node

PSWTImage

public PSWTImage(PSWTCanvas canvas,
                 org.eclipse.swt.graphics.Image image)

Constructs a PSWTImage wrapping the provided image.

Parameters:

canvas - canvas to associate with the image node

image - image to be wrapped by this PSWTImage

PSWTImage

public PSWTImage(PSWTCanvas canvas,
                 String fileName)

Constructs a PSWTImage wrapping the provided image after loading it from the file.

Parameters:

canvas - canvas to associate with the image node

fileName - path to the image, will be loaded and converted to an Image internally

Method Detail

getImage

public org.eclipse.swt.graphics.Image getImage()

Returns the image that is shown by this node, may be null.

Returns:

the image that is shown by this node

setImage

public void setImage(String filePath)

Set the image that is wrapped by this PImage node. This method will also load the image using a MediaTracker before returning. And if the this PImage is accelerated that image will be copied into an accelerated image if needed. Note that this may cause undesired results with images that have transparent regions, for those cases you may want to set the PImage to be not accelerated.

Parameters:

filePath - path to the file to load as an image

setImage

public void setImage(org.eclipse.swt.graphics.Image newImage)

Set the image that is wrapped by this PImage node. This method will also load the image using a MediaTracker before returning. And if the this PImage is accelerated that I'm will be copied into an accelerated image if needed. Note that this may cause undesired results with images that have transparent regions, for those cases you may want to set the PImage to be not accelerated.

Parameters:

newImage - the image that should replace the current one

disposeImage

protected void disposeImage()

Subclasses may override this method to provide different image dispose behavior.

paint

protected void paint(PPaintContext paintContext)

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