United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4682598 : Adjustable.setValue() docs should suggest respecting the visible amount

Details
Type:
Bug
Submit Date:
2002-05-09
Status:
Resolved
Updated Date:
2003-10-23
Project Name:
JDK
Resolved Date:
2003-10-23
Component:
docs
OS:
generic
Sub-Component:
guides
CPU:
generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.1
Fixed Versions:
5.0 (b26)

Related Reports
Relates:

Sub Tasks

Description
This bug was inspired by bug 4681561 : Adjustable.setValue() does not set value.

Adjustables have properties for the current value, minimum and maximum values, as well as a visibleAmount, which represents how much of a document is visible.  

Adjustable.setValue() specifies only that the new value be between the minimum and maximum values.

The setValue() method in Scrollbar, which implements Adjustable, further specifies that the new value should not be greater than maximum - visibleAmount.

The revered tomb, "The Java Class Libraries Second Edition, Volume 2", in its section on the Adjustable interface, discusses the visible amount, and suggests following the rules implemented by Scrollbar.  Pulling some of this material into the JavaDoc could be helpful to many.

Keeping the suggestive tone would be appropriate, as something stronger might get into API-change territory.

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
tiger
tiger-beta

FIXED IN:
tiger
tiger-beta

INTEGRATED IN:
tiger-b26
tiger-beta


                                     
2004-06-14
PUBLIC COMMENTS

.
                                     
2004-06-10
EVALUATION

Will fix for tiger.
###@###.### 2002-08-02

Reviewed by Brent.  CCC approved.  Fixed for tiger.
###@###.### 2003-09-12
                                     
2002-08-02



Hardware and Software, Engineered to Work Together