jdk-sandbox: comparison jdk/src/java.desktop/share/classes/javax/swing/plaf/basic/BasicSliderUI.java

equal deleted inserted replaced

-:e9b05e933ddd
+:508779ce6619
 }
 }
 /**
-* Gets the height of the tick area for horizontal sliders and the width of the
+* Gets the height of the tick area for horizontal sliders and the width of
-* tick area for vertical sliders.  BasicSliderUI uses the returned value to
+* the tick area for vertical sliders. BasicSliderUI uses the returned value
-* determine the tick area rectangle.  If you want to give your ticks some room,
+* to determine the tick area rectangle. If you want to give your ticks some
-* make this larger than you need and paint your ticks away from the sides in paintTicks().
+* room, make this larger than you need and paint your ticks away from the
+* sides in paintTicks().
+*
+* @return an integer representing the height of the tick area for
+* horizontal sliders, and the width of the tick area for the vertical
+* sliders
 */
 protected int getTickLength() {
 return 8;
 }
 /**
 * Returns the smallest value that has an entry in the label table.
 *
 * @return smallest value that has an entry in the label table, or
-*         null.
+* null.
 * @since 1.6
 */
 protected Integer getLowestValue() {
 Dictionary<Integer, JComponent> dictionary = slider.getLabelTable();
 return min;
 }
 /**
-* Returns the label that corresponds to the highest slider value in the label table.
+* Returns the label that corresponds to the highest slider value in the
+* label table.
+*
+* @return the label that corresponds to the highest slider value in the
+* label table
 * @see JSlider#setLabelTable
 */
 protected Component getLowestValueLabel() {
 Integer min = getLowestValue();
 if (min != null) {
 }
 return null;
 }
 /**
-* Returns the label that corresponds to the lowest slider value in the label table.
+* Returns the label that corresponds to the lowest slider value in the
+* label table.
+*
+* @return the label that corresponds to the lowest slider value in the
+* label table
 * @see JSlider#setLabelTable
 */
 protected Component getHighestValueLabel() {
 Integer max = getHighestValue();
 if (max != null) {
 }
 }
 /**
-* Called for every label in the label table.  Used to draw the labels for horizontal sliders.
+* Called for every label in the label table. Used to draw the labels for
-* The graphics have been translated to labelRect.y already.
+* horizontal sliders. The graphics have been translated to labelRect.y
+* already.
+*
+* @param g the graphics context in which to paint
+* @param value the value of the slider
+* @param label the component label in the label table that needs to be
+* painted
 * @see JSlider#setLabelTable
 */
 protected void paintHorizontalLabel( Graphics g, int value, Component label ) {
 int labelCenter = xPositionForValue( value );
 int labelLeft = labelCenter - (label.getPreferredSize().width / 2);
 label.paint( g );
 g.translate( -labelLeft, 0 );
 }
 /**
-* Called for every label in the label table.  Used to draw the labels for vertical sliders.
+* Called for every label in the label table. Used to draw the labels for
-* The graphics have been translated to labelRect.x already.
+* vertical sliders. The graphics have been translated to labelRect.x
+* already.
+*
+* @param g the graphics context in which to paint
+* @param value the value of the slider
+* @param label the component label in the label table that needs to be
+* painted
 * @see JSlider#setLabelTable
 */
 protected void paintVerticalLabel( Graphics g, int value, Component label ) {
 int labelCenter = yPositionForValue( value );
 int labelTop = labelCenter - (label.getPreferredSize().height / 2);
 slider.setValue(slider.getValue() + delta);
 }
 }
 /**
-* This function is called when a mousePressed was detected in the track, not
+* This function is called when a mousePressed was detected in the track,
-* in the thumb.  The default behavior is to scroll by block.  You can
+* not in the thumb. The default behavior is to scroll by block. You can
-*  override this method to stop it from scrolling or to add additional behavior.
+* override this method to stop it from scrolling or to add additional
+* behavior.
+*
+* @param dir the direction and number of blocks to scroll
 */
 protected void scrollDueToClickInTrack( int dir ) {
 scrollByBlock( dir );
 }
 * negative undefined results may occur.
 *
 * @param value the slider value to get the location for
 * @param trackY y-origin of the track
 * @param trackHeight the height of the track
+* @return the y location for the specified value of the slider
 * @since 1.6
 */
 protected int yPositionForValue(int value, int trackY, int trackHeight) {
 int min = slider.getMinimum();
 int max = slider.getMaximum();
 /**
 * Returns the value at the y position. If {@code yPos} is beyond the
 * track at the the bottom or the top, this method sets the value to either
 * the minimum or maximum value of the slider, depending on if the slider
 * is inverted or not.
+*
+* @param yPos the location of the slider along the y axis
+* @return the value at the y position
 */
 public int valueForYPosition( int yPos ) {
 int value;
 final int minValue = slider.getMinimum();
 final int maxValue = slider.getMaximum();
 /**
 * Returns the value at the x position.  If {@code xPos} is beyond the
 * track at the left or the right, this method sets the value to either the
 * minimum or maximum value of the slider, depending on if the slider is
 * inverted or not.
+*
+* @param xPos the location of the slider along the x axis
+* @return the value of the x position
 */
 public int valueForXPosition( int xPos ) {
 int value;
 final int minValue = slider.getMinimum();
 final int maxValue = slider.getMaximum();

changeset 26037	508779ce6619
parent 26012	36ecb579dbc8
parent 25859	3317bb8137f4
child 26353	b5e3b7fbf56d