From: David G. <mu...@us...> - 2006-10-23 15:25:51
|
Update of /cvsroot/jfreechart/jfreechart/source/org/jfree/chart/plot In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv3650/source/org/jfree/chart/plot Modified Files: Tag: STABLE_1-0-0 XYPlot.java Log Message: 2006-10-23 David Gilbert <dav...@ob...> * source/org/jfree/chart/plot/XYPlot.java: (setDomainCrosshairStroke): Check null argument, (setDomainCrosshairPaint): Likewise, plus various API doc updates. Index: XYPlot.java =================================================================== RCS file: /cvsroot/jfreechart/jfreechart/source/org/jfree/chart/plot/XYPlot.java,v retrieving revision 1.44.2.10 retrieving revision 1.44.2.11 diff -C2 -d -r1.44.2.10 -r1.44.2.11 *** XYPlot.java 13 Oct 2006 15:16:18 -0000 1.44.2.10 --- XYPlot.java 23 Oct 2006 15:25:45 -0000 1.44.2.11 *************** *** 738,742 **** /** * Returns the edge for the primary domain axis (taking into account the ! * plot's orientation. * * @return The edge. --- 738,742 ---- /** * Returns the edge for the primary domain axis (taking into account the ! * plot's orientation). * * @return The edge. *************** *** 3239,3242 **** --- 3239,3244 ---- * * @return The flag. + * + * @see #setDomainCrosshairVisible(boolean) */ public boolean isDomainCrosshairVisible() { *************** *** 3245,3259 **** /** ! * Sets the flag indicating whether or not the domain crosshair is visible. * * @param flag the new value of the flag. */ public void setDomainCrosshairVisible(boolean flag) { - if (this.domainCrosshairVisible != flag) { this.domainCrosshairVisible = flag; notifyListeners(new PlotChangeEvent(this)); } - } --- 3247,3263 ---- /** ! * Sets the flag indicating whether or not the domain crosshair is visible ! * and, if the flag changes, sends a {@link PlotChangeEvent} to all ! * registered listeners. * * @param flag the new value of the flag. + * + * @see #isDomainCrosshairVisible() */ public void setDomainCrosshairVisible(boolean flag) { if (this.domainCrosshairVisible != flag) { this.domainCrosshairVisible = flag; notifyListeners(new PlotChangeEvent(this)); } } *************** *** 3263,3266 **** --- 3267,3272 ---- * * @return The flag. + * + * @see #setDomainCrosshairLockedOnData(boolean) */ public boolean isDomainCrosshairLockedOnData() { *************** *** 3270,3276 **** /** * Sets the flag indicating whether or not the domain crosshair should ! * "lock-on" to actual data values. * * @param flag the flag. */ public void setDomainCrosshairLockedOnData(boolean flag) { --- 3276,3285 ---- /** * Sets the flag indicating whether or not the domain crosshair should ! * "lock-on" to actual data values. If the flag value changes, this ! * method sends a {@link PlotChangeEvent} to all registered listeners. * * @param flag the flag. + * + * @see #isDomainCrosshairLockedOnData() */ public void setDomainCrosshairLockedOnData(boolean flag) { *************** *** 3285,3288 **** --- 3294,3299 ---- * * @return The value. + * + * @see #setDomainCrosshairValue(double) */ public double getDomainCrosshairValue() { *************** *** 3295,3298 **** --- 3306,3311 ---- * * @param value the value. + * + * @see #getDomainCrosshairValue() */ public void setDomainCrosshairValue(double value) { *************** *** 3307,3310 **** --- 3320,3325 ---- * @param value the new value. * @param notify notify listeners? + * + * @see #getDomainCrosshairValue() */ public void setDomainCrosshairValue(double value, boolean notify) { *************** *** 3318,3322 **** * Returns the {@link Stroke} used to draw the crosshair (if visible). * ! * @return The crosshair stroke. */ public Stroke getDomainCrosshairStroke() { --- 3333,3339 ---- * Returns the {@link Stroke} used to draw the crosshair (if visible). * ! * @return The crosshair stroke (never <code>null</code>). ! * ! * @see #setDomainCrosshairStroke(Stroke) */ public Stroke getDomainCrosshairStroke() { *************** *** 3328,3334 **** * registered listeners that the axis has been modified. * ! * @param stroke the new crosshair stroke. */ public void setDomainCrosshairStroke(Stroke stroke) { this.domainCrosshairStroke = stroke; notifyListeners(new PlotChangeEvent(this)); --- 3345,3357 ---- * registered listeners that the axis has been modified. * ! * @param stroke the new crosshair stroke (<code>null</code> not ! * permitted). ! * ! * @see #getDomainCrosshairStroke() */ public void setDomainCrosshairStroke(Stroke stroke) { + if (stroke == null) { + throw new IllegalArgumentException("Null 'stroke' argument."); + } this.domainCrosshairStroke = stroke; notifyListeners(new PlotChangeEvent(this)); *************** *** 3336,3342 **** /** ! * Returns the domain crosshair color. * ! * @return The crosshair color. */ public Paint getDomainCrosshairPaint() { --- 3359,3367 ---- /** ! * Returns the domain crosshair paint. * ! * @return The crosshair paint (never <code>null</code>). ! * ! * @see #setDomainCrosshairPaint(Paint) */ public Paint getDomainCrosshairPaint() { *************** *** 3345,3354 **** /** ! * Sets the Paint used to color the crosshairs (if visible) and notifies ! * registered listeners that the axis has been modified. * ! * @param paint the new crosshair paint. */ public void setDomainCrosshairPaint(Paint paint) { this.domainCrosshairPaint = paint; notifyListeners(new PlotChangeEvent(this)); --- 3370,3384 ---- /** ! * Sets the paint used to draw the crosshairs (if visible) and sends a ! * {@link PlotChangeEvent} to all registered listeners. * ! * @param paint the new crosshair paint (<code>null</code> not permitted). ! * ! * @see #getDomainCrosshairPaint() */ public void setDomainCrosshairPaint(Paint paint) { + if (paint == null) { + throw new IllegalArgumentException("Null 'paint' argument."); + } this.domainCrosshairPaint = paint; notifyListeners(new PlotChangeEvent(this)); *************** *** 3359,3362 **** --- 3389,3394 ---- * * @return The flag. + * + * @see #setRangeCrosshairVisible(boolean) */ public boolean isRangeCrosshairVisible() { *************** *** 3366,3371 **** --- 3398,3407 ---- /** * Sets the flag indicating whether or not the range crosshair is visible. + * If the flag value changes, this method sends a {@link PlotChangeEvent} + * to all registered listeners. * * @param flag the new value of the flag. + * + * @see #isRangeCrosshairVisible() */ public void setRangeCrosshairVisible(boolean flag) { *************** *** 3381,3384 **** --- 3417,3422 ---- * * @return The flag. + * + * @see #setRangeCrosshairLockedOnData(boolean) */ public boolean isRangeCrosshairLockedOnData() { *************** *** 3388,3394 **** /** * Sets the flag indicating whether or not the range crosshair should ! * "lock-on" to actual data values. * * @param flag the flag. */ public void setRangeCrosshairLockedOnData(boolean flag) { --- 3426,3435 ---- /** * Sets the flag indicating whether or not the range crosshair should ! * "lock-on" to actual data values. If the flag value changes, this method ! * sends a {@link PlotChangeEvent} to all registered listeners. * * @param flag the flag. + * + * @see #isRangeCrosshairLockedOnData() */ public void setRangeCrosshairLockedOnData(boolean flag) { *************** *** 3403,3406 **** --- 3444,3449 ---- * * @return The value. + * + * @see #setRangeCrosshairValue(double) */ public double getRangeCrosshairValue() { *************** *** 3409,3413 **** /** ! * Sets the domain crosshair value. * <P> * Registered listeners are notified that the plot has been modified, but --- 3452,3456 ---- /** ! * Sets the range crosshair value. * <P> * Registered listeners are notified that the plot has been modified, but *************** *** 3415,3418 **** --- 3458,3463 ---- * * @param value the new value. + * + * @see #getRangeCrosshairValue() */ public void setRangeCrosshairValue(double value) { *************** *** 3421,3432 **** /** ! * Sets the range crosshair value. ! * <P> ! * Registered listeners are notified that the axis has been modified, but ! * only if the crosshair is visible. * * @param value the new value. * @param notify a flag that controls whether or not listeners are * notified. */ public void setRangeCrosshairValue(double value, boolean notify) { --- 3466,3477 ---- /** ! * Sets the range crosshair value and sends a {@link PlotChangeEvent} to ! * all registered listeners, but only if the crosshair is visible. * * @param value the new value. * @param notify a flag that controls whether or not listeners are * notified. + * + * @see #getRangeCrosshairValue() */ public void setRangeCrosshairValue(double value, boolean notify) { *************** *** 3438,3444 **** /** ! * Returns the Stroke used to draw the crosshair (if visible). * * @return The crosshair stroke. */ public Stroke getRangeCrosshairStroke() { --- 3483,3491 ---- /** ! * Returns the stroke used to draw the crosshair (if visible). * * @return The crosshair stroke. + * + * @see #setRangeCrosshairStroke(Stroke) */ public Stroke getRangeCrosshairStroke() { *************** *** 3447,3454 **** /** ! * Sets the Stroke used to draw the crosshairs (if visible) and notifies ! * registered listeners that the axis has been modified. * * @param stroke the new crosshair stroke. */ public void setRangeCrosshairStroke(Stroke stroke) { --- 3494,3503 ---- /** ! * Sets the stroke used to draw the crosshairs (if visible) and sends a ! * {@link PlotChangeEvent} to all registered listeners. * * @param stroke the new crosshair stroke. + * + * @see #getRangeCrosshairStroke() */ public void setRangeCrosshairStroke(Stroke stroke) { *************** *** 3458,3464 **** /** ! * Returns the range crosshair color. * ! * @return The crosshair color. */ public Paint getRangeCrosshairPaint() { --- 3507,3515 ---- /** ! * Returns the range crosshair paint. * ! * @return The crosshair paint. ! * ! * @see #setRangeCrosshairPaint(Paint) */ public Paint getRangeCrosshairPaint() { *************** *** 3467,3474 **** /** ! * Sets the Paint used to color the crosshairs (if visible) and notifies ! * registered listeners that the axis has been modified. * * @param paint the new crosshair paint. */ public void setRangeCrosshairPaint(Paint paint) { --- 3518,3527 ---- /** ! * Sets the paint used to color the crosshairs (if visible) and sends a ! * {@link PlotChangeEvent} to all registered listeners. * * @param paint the new crosshair paint. + * + * @see #getRangeCrosshairPaint() */ public void setRangeCrosshairPaint(Paint paint) { |