diff --git a/core/src/main/java/edu/umd/cs/piccolo/PCamera.java b/core/src/main/java/edu/umd/cs/piccolo/PCamera.java index 43f454a..d9f3f4d 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/PCamera.java +++ b/core/src/main/java/edu/umd/cs/piccolo/PCamera.java @@ -196,6 +196,7 @@ * in Piccolo2D this one must not modify the viewBounds * parameter. * + * @since 1.3 * @param viewBounds bounds that require repainting, in view coordinates * @param repaintedLayer layer dispatching the repaint notification */ diff --git a/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java b/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java index 0b3215b..87cbc56 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java +++ b/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java @@ -86,12 +86,15 @@ /** * The property name that identifies a change in the interacting state. * + * @since 1.3 * @deprecated in favor of PROPERTY_INTERACTING */ public static final String INTERACTING_CHANGED_NOTIFICATION = "INTERACTING_CHANGED_NOTIFICATION"; /** * The property name that identifies a change in the interacting state. + * + * @since 1.3 */ public static final String PROPERTY_INTERACTING = "INTERACTING_CHANGED_NOTIFICATION"; @@ -648,6 +651,7 @@ /** * Returns the quality to use when not animating or interacting. * + * @since 1.3 * @deprecated in favor or getNormalRenderQuality * @return the render quality to use when not animating or interacting */ @@ -658,6 +662,7 @@ /** * Returns the quality to use when not animating or interacting. * + * @since 1.3 * @return the render quality to use when not animating or interacting */ public int getNormalRenderQuality() { @@ -667,6 +672,7 @@ /** * Returns the quality to use when animating. * + * @since 1.3 * @return Returns the quality to use when animating */ public int getAnimatingRenderQuality() { @@ -676,6 +682,7 @@ /** * Returns the quality to use when interacting. * + * @since 1.3 * @return Returns the quality to use when interacting */ public int getInteractingRenderQuality() { @@ -685,6 +692,7 @@ /** * Returns the input event listeners registered to receive input events. * + * @since 1.3 * @return array or input event listeners */ public PInputEventListener[] getInputEventListeners() { diff --git a/core/src/main/java/edu/umd/cs/piccolo/PNode.java b/core/src/main/java/edu/umd/cs/piccolo/PNode.java index c0e7fea..e16761b 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/PNode.java +++ b/core/src/main/java/edu/umd/cs/piccolo/PNode.java @@ -363,12 +363,16 @@ /** * toImage fill strategy that stretches the node be as large as possible * while still retaining its aspect ratio. + * + * @since 1.3 */ public static final int FILL_STRATEGY_ASPECT_FIT = 1; /** * toImage fill strategy that stretches the node be large enough to cover * the image, and centers it. + * + * @since 1.3 */ public static final int FILL_STRATEGY_ASPECT_COVER = 2; @@ -376,12 +380,15 @@ * toImage fill strategy that stretches the node to be exactly the * dimensions of the image. Will result in distortion if the aspect ratios * are different. + * + * @since 1.3 */ public static final int FILL_STRATEGY_EXACT_FIT = 4; /** * Creates a new PNode with the given name. * + * @since 1.3 * @param newName name to assign to node */ public PNode(final String newName) { @@ -2356,6 +2363,7 @@ * same place as the upper-left corner of B, and the transition will be * smoothly animated over a period of 750 milliseconds. * + * @since 1.3 * @param srcPt The anchor point on this transform's node (normalized to a * unit square) * @param destPt The anchor point on destination bounds (normalized to a @@ -2890,6 +2898,7 @@ * background, paint is null, then the image will not be filled with a color * prior to rendering * + * @since 1.3 * @param image Image onto which this node will be painted * @param backGroundPaint will fill background of image with this. May be * null. @@ -3511,6 +3520,7 @@ /** * Sets the name of this null, may be null. * + * @since 1.3 * @param name new name for this node */ public void setName(final String name) { @@ -3520,6 +3530,7 @@ /** * Returns the name given to this node. * + * @since 1.3 * @return name given to this node, may be null */ public String getName() { @@ -3684,6 +3695,7 @@ /** * Returns an array of input event listeners that are attached to this node. * + * @since 1.3 * @return event listeners attached to this node */ public PInputEventListener[] getInputEventListeners() { diff --git a/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java b/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java index c4d0a51..b1995a0 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java +++ b/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java @@ -37,6 +37,8 @@ /** * Offscreen canvas. + * + * @since 1.3 */ public final class POffscreenCanvas implements PComponent { diff --git a/core/src/main/java/edu/umd/cs/piccolo/PRoot.java b/core/src/main/java/edu/umd/cs/piccolo/PRoot.java index 4893e8c..c3df2ac 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/PRoot.java +++ b/core/src/main/java/edu/umd/cs/piccolo/PRoot.java @@ -77,12 +77,16 @@ /** * The property name that identifies a change in this node's interacting * state. + * + * @since 1.3 */ public static final String PROPERTY_INTERACTING_CHANGED = "INTERACTING_CHANGED_NOTIFICATION"; /** * The property code that identifies a change in this node's interacting * state. + * + * @since 1.3 */ public static final int PROPERTY_CODE_INTERACTING_CHANGED = 1 << 13; @@ -205,7 +209,8 @@ * Return true if this root has been marked as interacting. If so the root * will normally render at a lower quality that is faster. * - * @return True if this root has user interaction taking place + * @since 1.3 + * @return true if this root has user interaction taking place */ public boolean getInteracting() { return interacting > 0; @@ -220,6 +225,7 @@ * but this is the appropriate place to mark interactions that may occur in * multiple canvases if this Root is shared. * + * @since 1.3 * @param isInteracting True if this root has user interaction taking place * @see PCanvas#setInteracting(boolean) */ diff --git a/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java b/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java index 37ac66a..9e0fe15 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java +++ b/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java @@ -74,6 +74,7 @@ /** * Constructs an interpolating activity that will last the duration given. * + * @since 1.3 * @param duration duration in milliseconds of the entire activity */ public PInterpolatingActivity(final long duration) { diff --git a/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java b/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java index 0e0caf1..d792a48 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java +++ b/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java @@ -134,6 +134,7 @@ /** * Returns the minAutoPan speed in pixels per second. * + * @since 1.3 * @return minimum distance the autopan feature can pan the view */ public double getMinAutoPanSpeed() { @@ -143,6 +144,7 @@ /** * Returns the maxAutoPan speed in pixels per second. * + * @since 1.3 * @return max distance the autopan feature can pan the view by */ public double getMaxAutoPanSpeed() { diff --git a/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java b/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java index 0ba76e2..393c855 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java +++ b/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java @@ -48,6 +48,7 @@ * the hood so you have the same restrictions regarding HTML as you have when * using standard Swing components (HTML 3.2 + subset of CSS 1.0). * + * @since 1.3 * @author Chris Malley (cmal...@pixelzoom.com) * @author Sam Reid * @author Allain Lalonde diff --git a/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java b/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java index 17ce92f..1e4622c 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java +++ b/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java @@ -90,6 +90,8 @@ * The property name that identifies a change of this node's text paint (see * {@link #getTextPaint getTextPaint}). Both old and new value will be set * in any property change event. + * + * @since 1.3 */ public static final String PROPERTY_TEXT_PAINT = "text paint"; @@ -97,6 +99,8 @@ * The property code that identifies a change of this node's text paint (see * {@link #getTextPaint getTextPaint}). Both old and new value will be set * in any property change event. + * + * @since 1.3 */ public static final int PROPERTY_CODE_TEXT_PAINT = 1 << 21; @@ -114,13 +118,25 @@ */ public static double DEFAULT_GREEK_THRESHOLD = 5.5d; - /** Default horizontal alignment, Component.LEFT_ALIGNMENT. */ + /** + * Default horizontal alignment, Component.LEFT_ALIGNMENT. + * + * @since 1.3 + */ public static final float DEFAULT_HORIZONTAL_ALIGNMENT = Component.LEFT_ALIGNMENT; - /** Default text, "". */ + /** + * Default text, "". + * + * @since 1.3 + */ public static final String DEFAULT_TEXT = ""; - /** Default text paint, Color.BLACK. */ + /** + * Default text paint, Color.BLACK. + * + * @since 1.3 + */ public static final Paint DEFAULT_TEXT_PAINT = Color.BLACK; /** Empty text layout array. */ @@ -202,6 +218,7 @@ * Component.RIGHT_ALIGNMENT. Defaults to * {@link #DEFAULT_HORIZONTAL_ALIGNMENT}. * + * @since 1.3 * @return the horizontal alignment for this text node */ public float getHorizontalAlignment() { @@ -212,6 +229,7 @@ * Set the horizontal alignment for this text node to * horizontalAlignment. * + * @since 1.3 * @param horizontalAlignment horizontal alignment, must be one of * Component.LEFT_ALIGNMENT, * Component.CENTER_ALIGNMENT, or @@ -505,6 +523,7 @@ /** * Paint greek with the specified paint context. * + * @since 1.3 * @param paintContext paint context */ protected void paintGreek(final PPaintContext paintContext) { @@ -514,6 +533,7 @@ /** * Paint text with the specified paint context. * + * @since 1.3 * @param paintContext paint context */ protected void paintText(final PPaintContext paintContext) { diff --git a/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java b/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java index 115a75d..14a4279 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java +++ b/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java @@ -262,6 +262,7 @@ /** * Applies the inverse of this transform to the source point if possible. * + * @since 1.3 * @param ptSrc point to be transformed * @param ptDst result of transform will be placed in this point * diff --git a/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java b/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java index cc676a8..59e82a3 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java +++ b/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java @@ -2,6 +2,8 @@ /** * This class is used to encapsulate exceptions that may occur while performing transform operations. + * + * @since 1.3 */ public class PAffineTransformException extends RuntimeException { /** diff --git a/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java b/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java index 5b7f3a4..1a31e76 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java +++ b/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java @@ -173,6 +173,8 @@ /** * Removes the camera at the top of the camera stack. + * + * @since 1.3 */ public void popCamera() { cameraStack.pop();