archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-20 19:14:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8206343: There is a typo in the java documentation of javax.swing.JScrollBar

Browse source 
Reviewed-by: prr, mhalder
This commit is contained in:
Krishna Addepalli 2018-07-19 13:49:44 +05:30
parent a6bd52da93
commit 2d2dd74c80
1 changed files with 21 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

40
src/java.desktop/share/classes/javax/swing/JScrollBar.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -340,17 +340,17 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* given a unit up/down request. A ScrollBarUI implementation * given a unit up/down request. A ScrollBarUI implementation
* typically calls this method when the user clicks on a scrollbar * typically calls this method when the user clicks on a scrollbar
* up/down arrow and uses the result to update the scrollbar's * up/down arrow and uses the result to update the scrollbar's
* value. Subclasses my override this method to compute * value. Subclasses may override this method to compute
* a value, e.g. the change required to scroll up or down one * a value, e.g. the change required to scroll one
* (variable height) line text or one row in a table. * (variable height) line of text or one row in a table.
* <p> * <p>
* The JScrollPane component creates scrollbars (by default) * The JScrollPane component creates scrollbars (by default)
* that override this method and delegate to the viewports * that override this method and delegate to the viewports
* Scrollable view, if it has one. The Scrollable interface * Scrollable view, if it has one. The Scrollable interface
* provides a more specialized version of this method. * provides a more specialized version of this method.
* <p> * <p>
* Some look and feels implement custom scrolling behavior * Some look and feel implementations that provide custom scrolling
* and ignore this property. * behavior ignore this property.
* *
* @param direction is -1 or 1 for up/down respectively * @param direction is -1 or 1 for up/down respectively
* @return the value of the unitIncrement property * @return the value of the unitIncrement property
@ -367,10 +367,11 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* Sets the unitIncrement property. * Sets the unitIncrement property.
* <p> * <p>
* Note, that if the argument is equal to the value of Integer.MIN_VALUE, * Note, that if the argument is equal to the value of Integer.MIN_VALUE,
* the most look and feels will not provide the scrolling to the right/down. * then most look and feel implementations will not provide scrolling
* to the right/down.
* <p> * <p>
* Some look and feels implement custom scrolling behavior * Some look and feel implementations that provide custom scrolling
* and ignore this property. * behavior ignore this property.
* *
* @see #getUnitIncrement * @see #getUnitIncrement
*/ */
@ -387,18 +388,18 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* Returns the amount to change the scrollbar's value by, * Returns the amount to change the scrollbar's value by,
* given a block (usually "page") up/down request. A ScrollBarUI * given a block (usually "page") up/down request. A ScrollBarUI
* implementation typically calls this method when the user clicks * implementation typically calls this method when the user clicks
* above or below the scrollbar "knob" to change the value * outside the scrollbar "knob" to scroll up or down by a large amount.
* up or down by large amount. Subclasses my override this * Subclasses may override this method to compute a
* method to compute a value, e.g. the change required to scroll * value, e.g. the change required to scroll one paragraph
* up or down one paragraph in a text document. * in a text document.
* <p> * <p>
* The JScrollPane component creates scrollbars (by default) * The JScrollPane component creates scrollbars (by default)
* that override this method and delegate to the viewports * that override this method and delegate to the viewports
* Scrollable view, if it has one. The Scrollable interface * Scrollable view, if it has one. The Scrollable interface
* provides a more specialized version of this method. * provides a more specialized version of this method.
* <p> * <p>
* Some look and feels implement custom scrolling behavior * Some look and feel implementations that provide custom scrolling
* and ignore this property. * behavior ignore this property.
* *
* @param direction is -1 or 1 for up/down respectively * @param direction is -1 or 1 for up/down respectively
* @return the value of the blockIncrement property * @return the value of the blockIncrement property
@ -415,10 +416,11 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* Sets the blockIncrement property. * Sets the blockIncrement property.
* <p> * <p>
* Note, that if the argument is equal to the value of Integer.MIN_VALUE, * Note, that if the argument is equal to the value of Integer.MIN_VALUE,
* the most look and feels will not provide the scrolling to the right/down. * then most look and feel implementations will not provide scrolling
* to the right/down.
* <p> * <p>
* Some look and feels implement custom scrolling behavior * Some look and feel implementations that provide custom scrolling
* and ignore this property. * behavior ignore this property.
* *
* @see #getBlockIncrement() * @see #getBlockIncrement()
*/ */
@ -642,7 +644,7 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* to a BoundedRangeModels value are considered equivalent. To change * to a BoundedRangeModels value are considered equivalent. To change
* the value of a BoundedRangeModel one just sets its value property, * the value of a BoundedRangeModel one just sets its value property,
* i.e. model.setValue(123). No information about the origin of the * i.e. model.setValue(123). No information about the origin of the
* change, e.g. it's a block decrement, is provided. We don't try * change, e.g. it's a block decrement, is provided. We don't try to
* fabricate the origin of the change here. * fabricate the origin of the change here.
* *
* @param l the AdjustmentLister to add * @param l the AdjustmentLister to add