I went through the JSlider class and updated the API docs. This patch is
committed:
2006-03-27 David Gilbert <[EMAIL PROTECTED]>
* javax/swing/JSlider.java: Updated API docs all over.
Regards,
Dave
Index: javax/swing/JSlider.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/JSlider.java,v
retrieving revision 1.23
diff -u -r1.23 JSlider.java
--- javax/swing/JSlider.java 27 Mar 2006 10:17:43 -0000 1.23
+++ javax/swing/JSlider.java 27 Mar 2006 14:18:39 -0000
@@ -1,5 +1,5 @@
/* JSlider.java --
- Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -38,8 +38,6 @@
package javax.swing;
-import gnu.classpath.NotImplementedException;
-
import java.awt.Dimension;
import java.awt.MenuContainer;
import java.awt.image.ImageObserver;
@@ -60,13 +58,12 @@
import javax.swing.plaf.SliderUI;
/**
- * The JSlider is a Swing component that allows selection of a value within a
+ * A visual component that allows selection of a value within a
* range by adjusting a thumb in a track. The values for the minimum,
* maximum, extent and value are stored in a [EMAIL PROTECTED]
* DefaultBoundedRangeModel}.
- *
* <p>
- * JSliders have the following properties:
+ * A <code>JSlider</code> component has the following properties:
* </p>
*
* <table>
@@ -75,38 +72,38 @@
* <tr><td> inverted </td><td> slider </td><td> yes </td></tr>
* <tr><td> labelTable </td><td> slider </td><td> yes </td></tr>
* <tr><td> majorTickSpacing </td><td> slider </td><td> yes </td></tr>
- * <tr><td> maximum </td><td> model </td><td> no </td></tr>
- * <tr><td> minimum </td><td> model </td><td> no </td></tr>
+ * <tr><td> maximum </td><td> model </td><td> yes </td></tr>
+ * <tr><td> minimum </td><td> model </td><td> yes </td></tr>
* <tr><td> minorTickSpacing </td><td> slider </td><td> yes </td></tr>
* <tr><td> model </td><td> slider </td><td> yes </td></tr>
* <tr><td> orientation </td><td> slider </td><td> yes </td></tr>
* <tr><td> paintLabels </td><td> slider </td><td> yes </td></tr>
* <tr><td> paintTicks </td><td> slider </td><td> yes </td></tr>
- * <tr><td> snapToTicks </td><td> slider </td><td> no </td></tr>
+ * <tr><td> snapToTicks </td><td> slider </td><td> yes </td></tr>
* <tr><td> value </td><td> model </td><td> no </td></tr>
* <tr><td> valueIsAdjusting </td><td> model </td><td> no </td></tr>
* </table>
*
* <p>
- * The various behavioral aspects of these properties follows:
+ * The various behavioural aspects of these properties follows:
* </p>
*
* <ul>
* <li>
- * When non-bound properties stored in the slider change, the slider fires
- * ChangeEvents to its ChangeListeners.
+ * When a non-bound property stored in the slider changes, the slider fires
+ * a [EMAIL PROTECTED] ChangeEvent} to its change listeners.
* </li>
* <li>
- * When bound properties stored in the slider change, the slider fires
- * PropertyChangeEvents to its PropertyChangeListeners
+ * When a bound property stored in the slider changes, the slider fires a
+ * [EMAIL PROTECTED] PropertyChangeEvent} to its property change listeners.
* </li>
* <li>
- * If any of the model's properties change, it fires a ChangeEvent to its
- * ChangeListeners, which include the slider.
+ * If any of the model's properties change, it fires a [EMAIL PROTECTED]
ChangeEvent} to
+ * its listeners, which include the slider.
* </li>
* <li>
- * If the slider receives a ChangeEvent from its model, it will propagate the
- * ChangeEvent to its ChangeListeners, with the ChangeEvent's "source"
+ * If the slider receives a [EMAIL PROTECTED] ChangeEvent} from its model, it
will
+ * propagate the event to its own change listeners, with the event's "source"
* property set to refer to the slider, rather than the model.
* </li>
* </ul>
@@ -115,7 +112,6 @@
ImageObserver,
MenuContainer, Serializable
{
- /** DOCUMENT ME! */
private static final long serialVersionUID = -1441275936141218479L;
/**
@@ -245,33 +241,36 @@
*/
private transient Dictionary labelTable;
- /** The model used to describe the slider. */
+ /** The model used to store the slider's range and current value. */
protected BoundedRangeModel sliderModel;
- /** The space between major ticks. */
+ /** The space/distance between major ticks. */
protected int majorTickSpacing;
- /** The space between minor ticks. */
+ /** The space/distance between minor ticks. */
protected int minorTickSpacing;
/** Whether the slider snaps its values to ticks. */
protected boolean snapToTicks = false;
- /** The orientation of the slider. */
+ /** The orientation (horizontal or vertical) of the slider. */
protected int orientation = HORIZONTAL;
/** Whether the slider is inverted. */
private transient boolean isInverted;
- /** The ChangeListener that listens to the model. */
+ /**
+ * The listener that monitors the slider's model and forwards events to the
+ * slider's listeners (see <code>createChangeListener()</code>).
+ */
protected ChangeListener changeListener;
- /** The ChangeEvent that is passed to all listeners of this slider. */
+ /** The change event that is passed to all listeners of this slider. */
protected transient ChangeEvent changeEvent;
/**
- * Creates a new horizontal JSlider object with a minimum of 0, a maximum of
- * 100, and a value of 50.
+ * Creates a new horizontal <code>JSlider</code> instance with a minimum of
+ * 0, a maximum of 100, and a value of 50.
*/
public JSlider()
{
@@ -279,8 +278,8 @@
}
/**
- * Creates a new JSlider object with the given orientation and a minimum of
- * 0, a maximum of 100, and a value of 50.
+ * Creates a new <code>JSlider</code> instance with the given orientation
+ * and a minimum of 0, a maximum of 100, and a value of 50.
*
* @param orientation The orientation of the slider ([EMAIL PROTECTED]
#HORIZONTAL} or
* [EMAIL PROTECTED] #VERTICAL}).
@@ -294,12 +293,15 @@
}
/**
- * Creates a new horizontal JSlider object with the given maximum and
- * minimum and a value that is halfway between the minimum and the
+ * Creates a new horizontal <code>JSlider</code> instance with the given
+ * maximum and minimum and a value that is halfway between the minimum and
the
* maximum.
*
- * @param minimum The minimum value of the JSlider.
- * @param maximum The maximum value of the JSlider.
+ * @param minimum The minimum value.
+ * @param maximum The maximum value.
+ *
+ * @throws IllegalArgumentException if <code>minimum</code> is greater than
+ * <code>maximum</code>.
*/
public JSlider(int minimum, int maximum)
{
@@ -307,12 +309,17 @@
}
/**
- * Creates a new horizontal JSlider object with the given minimum, maximum,
- * and value.
+ * Creates a new horizontal <code>JSlider</code> instance with the given
+ * minimum, maximum, and value.
*
- * @param minimum The minimum value of the JSlider.
- * @param maximum The maximum value of the JSlider.
- * @param value The initial value of the JSlider.
+ * @param minimum The minimum value.
+ * @param maximum The maximum value.
+ * @param value The initial value.
+ *
+ * @throws IllegalArgumentException if <code>value</code> is not in the
+ * specified range.
+ * @throws IllegalArgumentException if <code>minimum</code> is greater than
+ * <code>maximum</code>.
*/
public JSlider(int minimum, int maximum, int value)
{
@@ -320,8 +327,8 @@
}
/**
- * Creates a new JSlider object with the given orientation, minimum,
- * maximum, and value.
+ * Creates a new <code>JSlider</code> instance with the given orientation,
+ * minimum, maximum, and value.
*
* @param orientation The orientation of the slider ([EMAIL PROTECTED]
#HORIZONTAL} or
* [EMAIL PROTECTED] #VERTICAL}).
@@ -330,7 +337,11 @@
* @param value The initial value of the JSlider.
*
* @throws IllegalArgumentException if <code>orientation</code> is not one of
- * the specified values.
+ * the specified values.
+ * @throws IllegalArgumentException if <code>value</code> is not in the
+ * specified range.
+ * @throws IllegalArgumentException if <code>minimum</code> is greater than
+ * <code>maximum</code>.
*/
public JSlider(int orientation, int minimum, int maximum, int value)
{
@@ -344,7 +355,8 @@
}
/**
- * Creates a new horizontal JSlider object with the given model.
+ * Creates a new horizontal <code>JSlider</code> instance with the given
+ * model.
*
* @param model The model (<code>null</code> not permitted).
*
@@ -359,9 +371,11 @@
}
/**
- * This method returns the current value of the slider.
+ * Returns the slider's value (from the slider's model).
*
- * @return The value of the slider stored in the model.
+ * @return The value of the slider.
+ *
+ * @see #setValue(int)
*/
public int getValue()
{
@@ -369,9 +383,15 @@
}
/**
- * This method sets the value of the slider.
+ * Sets the slider's value and sends a [EMAIL PROTECTED] ChangeEvent} to all
+ * registered listeners. Note that the model will fire a change event to all
+ * of its registered listeners first (with the model as the event source) and
+ * then the slider will fire another change event to all of its registered
+ * listeners (this time with the slider as the event source).
*
- * @param value The slider's new value.
+ * @param value the new value.
+ *
+ * @see #getValue()
*/
public void setValue(int value)
{
@@ -379,7 +399,7 @@
}
/**
- * This method returns the slider's UI delegate.
+ * Returns the slider's UI delegate.
*
* @return The slider's UI delegate.
*/
@@ -389,9 +409,9 @@
}
/**
- * This method sets the slider's UI delegate.
+ * Sets the slider's UI delegate.
*
- * @param ui A SliderUI object to use with this slider.
+ * @param ui the UI delegate.
*/
public void setUI(SliderUI ui)
{
@@ -399,8 +419,8 @@
}
/**
- * This method sets this slider's UI to the UIManager's default for the
- * current look and feel.
+ * Sets this slider's UI delegate to the default (obtained from the
+ * [EMAIL PROTECTED] UIManager}) for the current look and feel.
*/
public void updateUI()
{
@@ -408,10 +428,11 @@
}
/**
- * This method returns a name to identify which look and feel class will be
- * the UI delegate for the slider.
+ * Returns the suffix (<code>"SliderUI"</code> in this case) used to
+ * determine the class name for a UI delegate that can provide the look and
+ * feel for a <code>JSlider</code>.
*
- * @return The Look and Feel classID. "SliderUI"
+ * @return <code>"SliderUI"</code>.
*/
public String getUIClassID()
{
@@ -419,9 +440,12 @@
}
/**
- * Creates a ChangeListener for this Slider.
+ * Creates a [EMAIL PROTECTED] ChangeListener} that is added to the slider's
model and
+ * forwards change events generated by the model to the listeners that are
+ * registered with the <code>JSlider</code> (by calling the
+ * [EMAIL PROTECTED] #fireStateChanged} method).
*
- * @return A new ChangeListener.
+ * @return A new listener.
*/
protected ChangeListener createChangeListener()
{
@@ -438,10 +462,14 @@
}
/**
- * This method registers a listener to this slider. The listener will be
- * informed of new ChangeEvents.
+ * Registers a listener with the slider so that it will receive
+ * [EMAIL PROTECTED] ChangeEvent} notifications. Note that change events
generated
+ * by the slider's model will be forwarded automatically to the slider's
+ * listeners.
*
- * @param listener The listener to register.
+ * @param listener the listener to register.
+ *
+ * @see #removeChangeListener(ChangeListener)
*/
public void addChangeListener(ChangeListener listener)
{
@@ -449,9 +477,12 @@
}
/**
- * This method removes a listener from this slider.
+ * Removes a listener from this slider so that it will no longer receive
+ * [EMAIL PROTECTED] ChangeEvent} notifications from the slider.
*
* @param listener The listener to remove.
+ *
+ * @see #addChangeListener(ChangeListener)
*/
public void removeChangeListener(ChangeListener listener)
{
@@ -459,9 +490,8 @@
}
/**
- * This method is called whenever the model fires a ChangeEvent. It should
- * propagate the ChangeEvent to its listeners with a new ChangeEvent that
- * identifies the slider as the source.
+ * Sends a [EMAIL PROTECTED] ChangeEvent} to all registered listeners, with
this slider
+ * as the source.
*/
protected void fireStateChanged()
{
@@ -476,10 +506,13 @@
}
/**
- * This method returns an array of all ChangeListeners listening to this
- * slider.
- *
- * @return An array of ChangeListeners listening to this slider.
+ * Returns an array containing all the [EMAIL PROTECTED] ChangeListener}
instances
+ * registered with this slider. If no listeners are registered, this method
+ * returns an empty array.
+ *
+ * @return An array array containing all the [EMAIL PROTECTED]
ChangeListener} instances
+ * registered with this slider (possibly empty, but never
+ * <code>null</code>).
*/
public ChangeListener[] getChangeListeners()
{
@@ -487,9 +520,12 @@
}
/**
- * This method returns the model of the slider.
+ * Returns the slider's model, which stores the minimum, maximum and current
+ * values.
*
* @return The slider's model.
+ *
+ * @see #setModel(BoundedRangeModel)
*/
public BoundedRangeModel getModel()
{
@@ -497,11 +533,16 @@
}
/**
- * This method changes the "model" property. It also needs to unregister
- * any listeners to the old model and register any listeners to the new
- * model.
+ * Sets the slider's model and sends a [EMAIL PROTECTED]
PropertyChangeEvent} (with the
+ * property name "model") to all registered listeners. The change listener
+ * that the slider registered with the original model is removed and added
+ * to the new model (this ensures that [EMAIL PROTECTED] ChangeEvent}
notifications
+ * generated by the model are automatically forwarded to listeners that are
+ * registered with the slider).
*
* @param model The model to use with the slider.
+ *
+ * @see #getModel()
*/
public void setModel(BoundedRangeModel model)
{
@@ -519,9 +560,11 @@
}
/**
- * This method returns the minimum value of the slider.
+ * Returns the minimum value of the slider (from the slider's model).
*
* @return The minimum value of the slider.
+ *
+ * @see #setMinimum(int)
*/
public int getMinimum()
{
@@ -529,9 +572,20 @@
}
/**
- * This method sets the minimum value of the slider.
- *
+ * Sets the minimum value of the slider and fires a
+ * [EMAIL PROTECTED] PropertyChangeEvent} (with the property name "minimum")
to all
+ * registered listeners. Note that:
+ * <p>
+ * <ul>
+ * <li>the minimum value is stored in the slider's model (see
+ * [EMAIL PROTECTED] #getModel()});</li>
+ * <li>in addition to the property change event, the slider also fires a
+ * [EMAIL PROTECTED] ChangeEvent}.</li>
+ * </ul>
+ *
* @param minimum The minimum value of the slider.
+ *
+ * @see #getMinimum()
*/
public void setMinimum(int minimum)
{
@@ -542,9 +596,11 @@
}
/**
- * This method returns the maximum value of the slider.
+ * Returns the slider's maximum value (obtained from the slider's model).
*
* @return The maximum value of the slider.
+ *
+ * @see #setMaximum(int)
*/
public int getMaximum()
{
@@ -552,9 +608,20 @@
}
/**
- * This method sets the maximum value of the slider.
+ * Sets the maximum value of the slider and fires a
+ * [EMAIL PROTECTED] PropertyChangeEvent} (with the property name "maximum")
to all
+ * registered listeners. Note that:
+ * <p>
+ * <ul>
+ * <li>the maximum value is stored in the slider's model (see
+ * [EMAIL PROTECTED] #getModel()});</li>
+ * <li>in addition to the property change event, the slider also fires a
+ * [EMAIL PROTECTED] ChangeEvent}.</li>
+ * </ul>
*
* @param maximum The maximum value of the slider.
+ *
+ * @see #getMaximum()
*/
public void setMaximum(int maximum)
{
@@ -565,10 +632,11 @@
}
/**
- * This method returns this slider's isAdjusting value which is true if the
- * thumb is being dragged.
+ * Returns the <code>valueIsAdjusting</code> flag from the slider's model.
*
- * @return The slider's isAdjusting value.
+ * @return The <code>valueIsAdjusting</code> flag from the slider's model.
+ *
+ * @see #setValueIsAdjusting(boolean)
*/
public boolean getValueIsAdjusting()
{
@@ -576,9 +644,12 @@
}
/**
- * This method sets the isAdjusting value for the slider.
+ * Sets the <code>valueIsAdjusting</code> flag in the slider's model, and
+ * sends a [EMAIL PROTECTED] ChangeEvent} to all registered listeners.
*
- * @param adjusting The slider's isAdjusting value.
+ * @param adjusting the new flag value.
+ *
+ * @see #getValueIsAdjusting()
*/
public void setValueIsAdjusting(boolean adjusting)
{
@@ -586,9 +657,11 @@
}
/**
- * This method returns the extent value for this slider.
+ * Returns the slider's extent value, obtained from the slider's model.
*
- * @return The extent value for this slider.
+ * @return The extent value.
+ *
+ * @see #setExtent(int)
*/
public int getExtent()
{
@@ -596,9 +669,15 @@
}
/**
- * This method sets the extent value for this slider.
+ * Sets the slider's extent value and sends a [EMAIL PROTECTED] ChangeEvent}
to all
+ * registered listeners. Note that the model will fire a change event to all
+ * of its registered listeners first (with the model as the event source) and
+ * then the slider will fire another change event to all of its registered
+ * listeners (this time with the slider as the event source).
*
* @param extent The extent value for this slider.
+ *
+ * @see #getExtent()
*/
public void setExtent(int extent)
{
@@ -606,9 +685,12 @@
}
/**
- * This method returns the slider orientation.
+ * Returns the orientation of the slider, either [EMAIL PROTECTED]
JSlider#HORIZONTAL}
+ * or [EMAIL PROTECTED] JSlider#VERTICAL}.
*
* @return The orientation of the slider.
+ *
+ * @see #setOrientation(int)
*/
public int getOrientation()
{
@@ -616,10 +698,17 @@
}
/**
- * This method changes the "orientation" property of this slider. If the
- * orientation is not VERTICAL or HORIZONTAL, this method does nothing.
+ * Sets the orientation for the slider and sends a
+ * [EMAIL PROTECTED] PropertyChangeEvent} (with the property name
"orientation") to all
+ * registered listeners.
*
- * @param orientation The orientation of this slider.
+ * @param orientation the orientation (one of [EMAIL PROTECTED]
JSlider#HORIZONTAL} or
+ * [EMAIL PROTECTED] JSlider#VERTICAL}).
+ *
+ * @throws IllegalArgumentException if <code>orientation</code> is not one of
+ * the permitted values.
+ *
+ * @see #getOrientation()
*/
public void setOrientation(int orientation)
{
@@ -635,9 +724,11 @@
}
/**
- * This method returns the label table for this slider.
+ * Returns the label table for the slider.
*
- * @return The label table for this slider.
+ * @return The label table for the slider (possibly <code>null</code>).
+ *
+ * @see #setLabelTable(Dictionary)
*/
public Dictionary getLabelTable()
{
@@ -645,9 +736,13 @@
}
/**
- * This method changes the "labelTable" property of this slider.
+ * Sets the table of labels for the slider and sends a
+ * [EMAIL PROTECTED] PropertyChangeEvent} (with the property name
"labelTable") to all
+ * registered listeners.
*
- * @param table The label table for this slider.
+ * @param table the table of labels (<code>null</code> permitted).
+ *
+ * @see #getLabelTable()
*/
public void setLabelTable(Dictionary table)
{
@@ -660,8 +755,8 @@
}
/**
- * This method is called to reset UI delegates for the labels in the
- * labelTable to a default for the current look and feel.
+ * Resets the UI delegates for the labels in the <code>labelTable</code> to
+ * the default for the current look and feel.
*/
protected void updateLabelUIs()
{
@@ -675,14 +770,14 @@
}
/**
- * Creates a hashtable of (Integer, JLabel) pairs that can be used as a
- * label table for this slider. The labels will start from the sliders
- * minimum and increase by the increment. Each label will have a text
- * string indicating their integer value.
+ * Creates a hashtable of <code>(Integer, JLabel)</code> pairs that can be
+ * used as a label table for this slider. The labels will start from the
+ * slider's minimum and increase by the increment. Each label will have a
text
+ * string indicating its integer value.
*
* @param increment The increment between labels (must be > 0).
*
- * @return A hashtable with the labels and their keys.
+ * @return A hashtable containing the labels.
*
* @throws IllegalArgumentException if <code>increment</code> is not greater
* than zero.
@@ -693,10 +788,10 @@
}
/**
- * Creates a hashtable of (Integer, JLabel) pairs that can be used as a
- * label table for this slider. The labels will start from the given start
- * value and increase by the increment. Each label will have a text string
- * indicating its integer value.
+ * Creates a hashtable of <code>(Integer, JLabel)</code> pairs that can be
+ * used as a label table for this slider. The labels will start from the
+ * given start value and increase by the increment. Each label will have a
+ * text string indicating its integer value.
*
* @param increment The increment between labels (must be > 0).
* @param start The value to start from.
@@ -737,13 +832,13 @@
}
/**
- * This method returns whether the slider is inverted. Horizontal sliders
- * that are not inverted will have the minimums on the left. If they are
- * inverted, the minimums will be on the right. Vertical sliders that are
- * not inverted will have the minimums at the bottom. If they are inverted,
- * the minimums will be at the top.
+ * Returns the flag that controls whether or not the value scale for the
+ * slider is inverted (the default value is <code>false</code>).
*
- * @return Whether this slider is inverted.
+ * @return The flag that controls whether or not the value scale for the
+ * slider is inverted.
+ *
+ * @see #setInverted(boolean)
*/
public boolean getInverted()
{
@@ -751,15 +846,18 @@
}
/**
- * This method changes the "inverted" property for this slider.Horizontal
- * sliders that are not inverted will have the minimums on the left. If
- * they are inverted, the minimums will be on the right. Vertical sliders
- * that are not inverted will have the minimums at the bottom. If they are
- * inverted, the minimums will be at the top. However, if the slider's
- * componentOrientation is set to RIGHT_TO_LEFT, then everything gets
- * reversed again.
+ * Sets the flag that controls whether or not the value scale for the
+ * slider is inverted and, if the new flag value is different to the old flag
+ * value, sends a [EMAIL PROTECTED] PropertyChangeEvent} to all registered
listeners.
+ * Typically, a horizontal slider will display a scale that increases from
+ * left to right, but this is reversed if the 'inverted' flag is set to
+ * <code>true</code>. Similarly, a vertical slider will display a scale that
+ * increases from bottom to top, and this is reversed if the 'inverted' flag
+ * is set to <code>true</code>.
*
- * @param inverted Whether the slider should be inverted.
+ * @param inverted the new flag value.
+ *
+ * @see #getInverted()
*/
public void setInverted(boolean inverted)
{
@@ -772,9 +870,12 @@
}
/**
- * This method returns the amount of units between each major tick mark.
+ * Returns the distance between major tick marks along the slider's value
+ * scale.
*
* @return The amount of units between each major tick mark.
+ *
+ * @see #setMajorTickSpacing(int)
*/
public int getMajorTickSpacing()
{
@@ -782,10 +883,13 @@
}
/**
- * This method changes the "majorTickSpacing" property for this slider. The
- * major tick spacing is the amount of units between each major tick mark.
+ * Sets the distance between major tick marks along the slider's value
scale,
+ * and sends a [EMAIL PROTECTED] PropertyChangeEvent} (with the property
name
+ * "majorTickSpacing") to all registered listeners.
*
- * @param spacing The amount of units between each major tick mark.
+ * @param spacing the distance between major tick marks.
+ *
+ * @see #getMajorTickSpacing()
*/
public void setMajorTickSpacing(int spacing)
{
@@ -799,9 +903,13 @@
}
/**
- * This method returns the amount of units between each minor tick mark.
+ * Returns the distance between minor tick marks along the slider's value
+ * scale.
*
- * @return The amount of units between each minor tick mark.
+ * @return The distance between minor tick marks along the slider's value
+ * scale.
+ *
+ * @see #setMinorTickSpacing(int)
*/
public int getMinorTickSpacing()
{
@@ -809,10 +917,13 @@
}
/**
- * This method changes the "minorTickSpacing" property for this slider. The
- * minor tick spacing is the amount of units between each minor tick mark.
+ * Sets the distance between minor tick marks along the slider's value
scale,
+ * and sends a [EMAIL PROTECTED] PropertyChangeEvent} (with the property
name
+ * "minorTickSpacing") to all registered listeners.
*
- * @param spacing The amount of units between each minor tick mark.
+ * @param spacing the distance between minor tick marks.
+ *
+ * @see #getMinorTickSpacing()
*/
public void setMinorTickSpacing(int spacing)
{
@@ -826,11 +937,13 @@
}
/**
- * This method returns whether this slider is snapping to ticks. Sliders
- * that snap to ticks will automatically move the thumb to the nearest tick
- * mark.
+ * Returns the flag that controls whether the slider thumb will snap to
ticks.
+ * Sliders that snap to ticks will automatically move the thumb to the
+ * nearest tick mark.
*
- * @return Whether this slider snaps to ticks.
+ * @return <code>true</code> if the slider thumb automatically.
+ *
+ * @see #setSnapToTicks(boolean)
*/
public boolean getSnapToTicks()
{
@@ -838,11 +951,14 @@
}
/**
- * This method sets whether this slider will snap to ticks. Sliders that
- * snap to ticks will automatically move the thumb to the nearest tick
- * mark.
+ * Sets the flag that controls whether the slider thumb will snap to ticks
+ * and sends a [EMAIL PROTECTED] PropertyChangeEvent} (with the property
name
+ * 'snapToTicks') to all registered listeners. Sliders that snap to ticks
+ * will automatically move the thumb to the nearest tick mark.
*
- * @param snap Whether this slider snaps to ticks.
+ * @param snap the new flag value.
+ *
+ * @see #getSnapToTicks()
*/
public void setSnapToTicks(boolean snap)
{
@@ -854,12 +970,13 @@
}
/**
- * This method returns whether the slider will paint its tick marks. In
- * addition to setting this property to true, one of minor tick spacing or
- * major tick spacing must be set to a value greater than 0 in order for
- * ticks to be painted.
+ * Returns the flag that controls whether or not tick marks are painted along
+ * the slider's value scale.
*
- * @return Whether ticks will be painted.
+ * @return <code>true</code> if tick marks should be painted, and
+ * <code>false</code> if tick marks should not be painted.
+ *
+ * @see #setPaintTicks(boolean)
*/
public boolean getPaintTicks()
{
@@ -867,12 +984,16 @@
}
/**
- * This method changes the "paintTicks" property for this slider. In
- * addition to setting this property to true, one of minor tick spacing or
- * major tick spacing must be set to a value greater than 0 in order for
- * ticks to be painted.
+ * Sets the flag that controls whether or not tick marks are painted along
+ * the slider's value scale, and sends a [EMAIL PROTECTED]
PropertyChangeEvent} (with
+ * the property name "paintTicks") to all registered listeners. In
+ * addition to setting this property to <code>true</code>, one or both of the
+ * minor tick spacing and major tick spacing attributes must be set to a
+ * value greater than 0 in order for ticks to be painted.
*
* @param paint Whether ticks will be painted.
+ *
+ * @see #getPaintTicks()
*/
public void setPaintTicks(boolean paint)
{
@@ -885,9 +1006,11 @@
}
/**
- * This method returns whether the track will be painted.
+ * Returns the flag that controls whether or not the track is painted.
*
* @return Whether the track will be painted.
+ *
+ * @see #setPaintTrack(boolean)
*/
public boolean getPaintTrack()
{
@@ -900,6 +1023,8 @@
* registered listeners.
*
* @param paint Whether the track will be painted.
+ *
+ * @see #getPaintTrack()
*/
public void setPaintTrack(boolean paint)
{
@@ -911,9 +1036,12 @@
}
/**
- * This method returns whether labels will be painted.
+ * Returns the flag that controls whether or not labels are painted for the
+ * tick marks along the slider.
*
* @return Whether labels will be painted.
+ *
+ * @see #setPaintLabels(boolean)
*/
public boolean getPaintLabels()
{
@@ -921,9 +1049,13 @@
}
/**
- * This method changes the "paintLabels" property.
+ * Sets the flag that controls whether or not labels are painted for the
+ * tick marks along the slider and sends a [EMAIL PROTECTED]
PropertyChangeEvent} (with
+ * the property name "paintLabels") to all registered listeners.
*
* @param paint Whether labels will be painted.
+ *
+ * @see #getPaintLabels()
*/
public void setPaintLabels(boolean paint)
{
@@ -937,10 +1069,11 @@
}
/**
- * This method is used primarily for debugging purposes and returns a string
- * that can be used to represent this slider.
+ * Returns a string describing the attributes of this slider, for debugging
+ * purposes. According to the specification, this method is implementation
+ * specific, we just return "JSlider" at present.
*
- * @return A string representing this slider.
+ * @return Returns a string describing the attributes of this slider.
*/
protected String paramString()
{
