ca.sqlpower.wabit.swingui.report
Class GuideNode

java.lang.Object
  edu.umd.cs.piccolo.PNode
      ca.sqlpower.wabit.swingui.report.GuideNode

All Implemented Interfaces:

ca.sqlpower.swingui.querypen.CleanupPNode, WabitNode, java.awt.print.Printable, java.io.Serializable, java.lang.Cloneable

public class GuideNode
extends edu.umd.cs.piccolo.PNode
implements WabitNode

A guide is an object visible only at design time which has a particular (movable) position that other nodes can snap to and be positioned relative to.

See Also:

Serialized Form

Nested Class Summary

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

edu.umd.cs.piccolo.PNode.PSceneGraphDelegate

Field Summary

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

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

GuideNode(Guide.Axis axis, int offset)
Creates a new guide node oriented as specified.

GuideNode(Guide model)

Method Summary

void	cleanup()
double	getGuideOffset()
Guide	getModel() Returns the WabitObject that this WabitNode visually represents.
protected void	paint(edu.umd.cs.piccolo.util.PPaintContext paintContext)
void	setGuideOffset(int guideOffset)
void	setParent(edu.umd.cs.piccolo.PNode newParent)
boolean	snap(edu.umd.cs.piccolo.PNode node, double threshold) Attempts to snap the given node's bounds so one of its edges sits on this guide.

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

addActivity, addAttribute, addChild, addChild, addChildren, addClientProperty, addInputEventListener, addPropertyChangeListener, addPropertyChangeListener, animateToBounds, animateToColor, animateToPositionScaleRotation, 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, getIntegerAttribute, getInverseTransform, getListenerList, getLocalToGlobalTransform, 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, setOccluded, setOffset, setOffset, setPaint, setPaintInvalid, setPickable, setPropertyChangeParentMask, setRotation, setScale, setTransform, setTransparency, setVisible, setWidth, setX, setY, signalBoundsChanged, startResizeBounds, toImage, toImage, toImage, toString, transformBy, translate, validateFullBounds, validateFullPaint

Methods inherited from class java.lang.Object

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

Constructor Detail

GuideNode

public GuideNode(Guide.Axis axis,
                 int offset)

Creates a new guide node oriented as specified. The orientation of a guide node can't be changed, although its position can.

Parameters:

axis - Whether this new guide is oriented vertically or horizontally

GuideNode

public GuideNode(Guide model)

Method Detail

paint

protected void paint(edu.umd.cs.piccolo.util.PPaintContext paintContext)

Overrides:

paint in class edu.umd.cs.piccolo.PNode

setGuideOffset

public void setGuideOffset(int guideOffset)

getGuideOffset

public double getGuideOffset()

setParent

public void setParent(edu.umd.cs.piccolo.PNode newParent)

Overrides:

setParent in class edu.umd.cs.piccolo.PNode

snap

public boolean snap(edu.umd.cs.piccolo.PNode node,
                    double threshold)

Attempts to snap the given node's bounds so one of its edges sits on this guide. The given node is assumed to have the same coordinate space as this guide, which should be true if this guide and the given node share a parent, and the given node doesn't define its own transform.

Parameters:

node - The node whose bounds to tweak

Returns:

True if the node's bounds were snapped to this guide; false if the node was not modified.

cleanup

public void cleanup()

Specified by:

cleanup in interface ca.sqlpower.swingui.querypen.CleanupPNode

getModel

public Guide getModel()

Description copied from interface: WabitNode

Returns the WabitObject that this WabitNode visually represents.

Specified by:

getModel in interface WabitNode