summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2010-05-26 17:58:56 +0000
committerCarolyn MacLeod <carolyn>2010-05-26 17:58:56 +0000
commit0f960e0b213854d19299aaa9b453b69c8d7ee794 (patch)
tree4ee2be0a3b8b821c15859cb8b9359d908978f4c3 /bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java
parent15bb116304bc8aeea45302e2a4ff1e9abf3dd426 (diff)
downloadeclipse.platform.swt-0f960e0b213854d19299aaa9b453b69c8d7ee794.tar.gz
eclipse.platform.swt-0f960e0b213854d19299aaa9b453b69c8d7ee794.tar.xz
eclipse.platform.swt-0f960e0b213854d19299aaa9b453b69c8d7ee794.zip
Bug 314492 - Do the annual copyright/javadoc bashAFTER_JAVADOC_BASH_FOR_36RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java39
1 files changed, 34 insertions, 5 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java
index 560c841dfa..07580ec938 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java
@@ -306,8 +306,7 @@ public Point getSize () {
}
/**
- * Returns the size of the receiver's thumb relative to the
- * difference between its maximum and minimum values.
+ * Returns the receiver's thumb value.
*
* @return the thumb value
*
@@ -325,6 +324,19 @@ public int getThumb () {
return (int) adjustment.page_size;
}
+/**
+ * Returns a rectangle describing the size and location of the
+ * receiver's thumb relative to its parent.
+ *
+ * @return the thumb bounds, relative to the {@link #getParent() parent}
+ *
+ * @exception SWTException <ul>
+ * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
+ * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
+ * </ul>
+ *
+ * @since 3.6
+ */
public Rectangle getThumbBounds () {
checkWidget();
int slider_start = OS.GTK_RANGE_SLIDER_START (handle);
@@ -354,6 +366,20 @@ public Rectangle getThumbBounds () {
return rect;
}
+/**
+ * Returns a rectangle describing the size and location of the
+ * receiver's thumb track relative to its parent. This rectangle
+ * comprises the areas 2, 3, and 4 as described in {@link ScrollBar}.
+ *
+ * @return the thumb track bounds, relative to the {@link #getParent() parent}
+ *
+ * @exception SWTException <ul>
+ * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
+ * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
+ * </ul>
+ *
+ * @since 3.6
+ */
public Rectangle getThumbTrackBounds () {
checkWidget();
int x = 0, y = 0, width, height;
@@ -746,10 +772,13 @@ public void setSelection (int value) {
}
/**
- * Sets the size of the receiver's thumb relative to the
- * difference between its maximum and minimum values. This new
- * value will be ignored if it is less than one, and will be
+ * Sets the thumb value. The thumb value should be used to represent
+ * the size of the visual portion of the current range. This value is
+ * usually the same as the page increment value.
+ * <p>
+ * This new value will be ignored if it is less than one, and will be
* clamped if it exceeds the receiver's current range.
+ * </p>
*
* @param value the new thumb value, which must be at least one and not
* larger than the size of the current range