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

Reviewed-by: prr, mhalder
This commit is contained in:
Krishna Addepalli 2018-07-19 13:49:44 +05:30
parent a6bd52da93
commit 2d2dd74c80

@ -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.
*
* 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
* typically calls this method when the user clicks on a scrollbar
* up/down arrow and uses the result to update the scrollbar's
* value. Subclasses my override this method to compute
* a value, e.g. the change required to scroll up or down one
* (variable height) line text or one row in a table.
* value. Subclasses may override this method to compute
* a value, e.g. the change required to scroll one
* (variable height) line of text or one row in a table.
* <p>
* The JScrollPane component creates scrollbars (by default)
* that override this method and delegate to the viewports
* Scrollable view, if it has one. The Scrollable interface
* provides a more specialized version of this method.
* <p>
* Some look and feels implement custom scrolling behavior
* and ignore this property.
* Some look and feel implementations that provide custom scrolling
* behavior ignore this property.
*
* @param direction is -1 or 1 for up/down respectively
* @return the value of the unitIncrement property
@ -367,10 +367,11 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* Sets the unitIncrement property.
* <p>
* 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>
* Some look and feels implement custom scrolling behavior
* and ignore this property.
* Some look and feel implementations that provide custom scrolling
* behavior ignore this property.
*
* @see #getUnitIncrement
*/
@ -387,18 +388,18 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* Returns the amount to change the scrollbar's value by,
* given a block (usually "page") up/down request. A ScrollBarUI
* implementation typically calls this method when the user clicks
* above or below the scrollbar "knob" to change the value
* up or down by large amount. Subclasses my override this
* method to compute a value, e.g. the change required to scroll
* up or down one paragraph in a text document.
* outside the scrollbar "knob" to scroll up or down by a large amount.
* Subclasses may override this method to compute a
* value, e.g. the change required to scroll one paragraph
* in a text document.
* <p>
* The JScrollPane component creates scrollbars (by default)
* that override this method and delegate to the viewports
* Scrollable view, if it has one. The Scrollable interface
* provides a more specialized version of this method.
* <p>
* Some look and feels implement custom scrolling behavior
* and ignore this property.
* Some look and feel implementations that provide custom scrolling
* behavior ignore this property.
*
* @param direction is -1 or 1 for up/down respectively
* @return the value of the blockIncrement property
@ -415,10 +416,11 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* Sets the blockIncrement property.
* <p>
* 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>
* Some look and feels implement custom scrolling behavior
* and ignore this property.
* Some look and feel implementations that provide custom scrolling
* behavior ignore this property.
*
* @see #getBlockIncrement()
*/
@ -642,7 +644,7 @@ public class JScrollBar extends JComponent implements Adjustable, Accessible
* to a BoundedRangeModels value are considered equivalent. To change
* the value of a BoundedRangeModel one just sets its value property,
* 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.
*
* @param l the AdjustmentLister to add