summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGrant Gayed <ggayed>2008-06-02 17:54:19 +0000
committerGrant Gayed <ggayed>2008-06-02 17:54:19 +0000
commit41a483c2f550e6221404d76424f661b5ac010f43 (patch)
tree6fa13567098a4a4c7208c1d6ac16acc2ad6d55c3
parent3818f3ab39f47885072e0a95dd373efcbcbabb8c (diff)
downloadeclipse.platform.swt-41a483c2f550e6221404d76424f661b5ac010f43.tar.gz
eclipse.platform.swt-41a483c2f550e6221404d76424f661b5ac010f43.tar.xz
eclipse.platform.swt-41a483c2f550e6221404d76424f661b5ac010f43.zip
doc
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/Bullet.java25
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashForm.java3
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/ScrolledComposite.java2
3 files changed, 28 insertions, 2 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/Bullet.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/Bullet.java
index 28e54fc128..b5a7a48de6 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/Bullet.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/Bullet.java
@@ -31,14 +31,34 @@ import org.eclipse.swt.*;
* @since 3.2
*/
public class Bullet {
+ /**
+ * The bullet type. Possible values are:
+ * <ul>
+ * <li><code>ST.BULLET_DOT</code></li>
+ * <li><code>ST.BULLET_NUMBER</code></li>
+ * <li><code>ST.BULLET_LETTER_LOWER</code></li>
+ * <li><code>ST.BULLET_LETTER_UPPER</code></li>
+ * <li><code>ST.BULLET_TEXT</code></li>
+ * <li><code>ST.BULLET_CUSTOM</code></li>
+ * </ul>
+ */
public int type;
+
+ /**
+ * The bullet style.
+ */
public StyleRange style;
- public String text;
+
+ /**
+ * The bullet text.
+ */
+ public String text;
+
int[] linesIndices;
int count;
/**
- * Create a new bullet the specified style, the type is set to ST.BULLET_DOT.
+ * Create a new bullet with the specified style, and type <code>ST.BULLET_DOT</code>.
* The style must have a glyph metrics set.
*
* @param style the style
@@ -54,6 +74,7 @@ public Bullet(StyleRange style) {
* Create a new bullet the specified style and type.
* The style must have a glyph metrics set.
*
+ * @param type the bullet type
* @param style the style
*
* @exception IllegalArgumentException <ul>
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashForm.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashForm.java
index 8217993e49..3c04f080ee 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashForm.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashForm.java
@@ -30,6 +30,9 @@ import org.eclipse.swt.graphics.*;
*/
public class SashForm extends Composite {
+ /**
+ * The width of all sashes in the form.
+ */
public int SASH_WIDTH = 3;
int sashStyle;
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/ScrolledComposite.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/ScrolledComposite.java
index a64ec3280f..50106f4836 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/ScrolledComposite.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/ScrolledComposite.java
@@ -298,6 +298,8 @@ public Control getContent() {
* Returns <code>true</code> if the receiver automatically scrolls to a focused child control
* to make it visible. Otherwise, returns <code>false</code>.
*
+ * @return a boolean indicating whether focused child controls are automatically scrolled into the viewport
+ *
* @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>