diff options
author | Carolyn MacLeod <carolyn> | 2009-05-27 19:05:21 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2009-05-27 19:05:21 +0000 |
commit | 252fa34277ec96231d89bbba1b2222a71f04f4b5 (patch) | |
tree | d1ab9d844a8f24e69ec7c33d43992143e4825371 /bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets | |
parent | 0e9de50affb69f2c41b7aaf179af3432f3658daf (diff) | |
download | eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.tar.gz eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.tar.xz eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.zip |
After javadoc bash for 3.5RC3v3549aBEFORE_COPYRIGHT_BASH_FOR_35RC3AFTER_JAVADOC_BASH_FOR_35RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets')
41 files changed, 222 insertions, 45 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Button.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Button.java index a86e73d755..24337928ec 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Button.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Button.java @@ -43,6 +43,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#button">Button snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Button extends Control { String text; @@ -83,6 +84,8 @@ public class Button extends Control { * @see SWT#RADIO * @see SWT#TOGGLE * @see SWT#FLAT + * @see SWT#UP + * @see SWT#DOWN * @see SWT#LEFT * @see SWT#RIGHT * @see SWT#CENTER diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Caret.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Caret.java index 2e549eddaf..780cb1df96 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Caret.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Caret.java @@ -33,6 +33,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#caret">Caret snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Canvas tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Caret extends Widget { Canvas parent; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ColorDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ColorDialog.java index b05fa226cf..46cac8b773 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ColorDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ColorDialog.java @@ -31,6 +31,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ColorDialog extends Dialog { RGB rgb; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Combo.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Combo.java index 7c68a56ab9..6b68de16fc 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Combo.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Combo.java @@ -53,6 +53,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#combo">Combo snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Combo extends Composite { int textLimit = LIMIT; @@ -1446,6 +1447,10 @@ public void setSelection (Point selection) { * Sets the contents of the receiver's text field to the * given string. * <p> + * This call is ignored when the receiver is read only and + * the given string is not in the receiver's list. + * </p> + * <p> * Note: The text field in a <code>Combo</code> is typically * only capable of displaying a single line of text. Thus, * setting the text to a string containing line breaks or diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Composite.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Composite.java index 0bb0a70777..86f49c4de7 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Composite.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Composite.java @@ -33,10 +33,9 @@ import org.eclipse.swt.internal.cocoa.*; * than <code>Canvas</code>. * </p><p> * Note: The <code>CENTER</code> style, although undefined for composites, has the - * same value as <code>EMBEDDED</code> (which is used to embed widgets from other - * widget toolkits into SWT). On some operating systems (GTK, Motif), this may cause - * the children of this composite to be obscured. The <code>EMBEDDED</code> style - * is for use by other widget toolkits and should normally never be used. + * same value as <code>EMBEDDED</code> which is used to embed widgets from other + * widget toolkits into SWT. On some operating systems (GTK, Motif), this may cause + * the children of this composite to be obscured. * </p><p> * This class may be subclassed by custom control implementors * who are building controls that are constructed from aggregates @@ -84,6 +83,8 @@ Composite () { * @see SWT#NO_MERGE_PAINTS * @see SWT#NO_REDRAW_RESIZE * @see SWT#NO_RADIO_GROUP + * @see SWT#EMBEDDED + * @see SWT#DOUBLE_BUFFERED * @see Widget#getStyle */ public Composite (Composite parent, int style) { diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Control.java index 99ca3a2359..e110a6188e 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Control.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Control.java @@ -38,6 +38,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#control">Control snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public abstract class Control extends Widget implements Drawable { /** @@ -102,6 +103,8 @@ Control () { * </ul> * * @see SWT#BORDER + * @see SWT#LEFT_TO_RIGHT + * @see SWT#RIGHT_TO_LEFT * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -1268,7 +1271,11 @@ public Accessible getAccessible () { /** * Returns the receiver's background color. - * + * <p> + * Note: This operation is a hint and may be overridden by the platform. + * For example, on some versions of Windows the background of a TabFolder, + * is a gradient rather than a solid color. + * </p> * @return the background color * * @exception SWTException <ul> @@ -3569,8 +3576,17 @@ boolean setTabItemFocus () { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DateTime.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DateTime.java index 02ebe6ae34..f78b47326a 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DateTime.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DateTime.java @@ -25,13 +25,14 @@ import org.eclipse.swt.internal.cocoa.*; * </p> * <dl> * <dt><b>Styles:</b></dt> - * <dd>DATE, TIME, CALENDAR, SHORT, MEDIUM, LONG</dd> + * <dd>DATE, TIME, CALENDAR, SHORT, MEDIUM, LONG, DROP_DOWN</dd> * <dt><b>Events:</b></dt> - * <dd>Selection</dd> + * <dd>DefaultSelection, Selection</dd> * </dl> * <p> * Note: Only one of the styles DATE, TIME, or CALENDAR may be specified, * and only one of the styles SHORT, MEDIUM, or LONG may be specified. + * The DROP_DOWN style is a <em>HINT</em>, and it is only valid with the DATE style. * </p><p> * IMPORTANT: This class is <em>not</em> intended to be subclassed. * </p> @@ -41,6 +42,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 + * @noextend This class is not intended to be subclassed by clients. */ public class DateTime extends Composite { static final int MIN_YEAR = 1752; // Gregorian switchover in North America: September 19, 1752 @@ -73,6 +75,10 @@ public class DateTime extends Composite { * @see SWT#DATE * @see SWT#TIME * @see SWT#CALENDAR + * @see SWT#SHORT + * @see SWT#MEDIUM + * @see SWT#LONG + * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -104,7 +110,7 @@ protected void checkSubclass () { * interface. * <p> * <code>widgetSelected</code> is called when the user changes the control's value. - * <code>widgetDefaultSelected</code> is not called. + * <code>widgetDefaultSelected</code> is typically called when ENTER is pressed. * </p> * * @param listener the listener which should be notified @@ -405,6 +411,7 @@ public void setDate (int year, int month, int day) { * Sets the receiver's date, or day of the month, to the specified day. * <p> * The first day of the month is 1, and the last day depends on the month and year. + * If the specified day is not valid for the receiver's month and year, then it is ignored. * </p> * * @param day a positive integer beginning with 1 @@ -413,6 +420,8 @@ public void setDate (int year, int month, int day) { * <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> + * + * @see #setDate */ public void setDay (int day) { checkWidget (); @@ -486,6 +495,7 @@ public void setMinutes (int minutes) { * Sets the receiver's month. * <p> * The first month of the year is 0, and the last month is 11. + * If the specified month is not valid for the receiver's day and year, then it is ignored. * </p> * * @param month an integer between 0 and 11 @@ -494,6 +504,8 @@ public void setMinutes (int minutes) { * <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> + * + * @see #setDate */ public void setMonth (int month) { checkWidget (); @@ -554,6 +566,7 @@ public void setTime (int hours, int minutes, int seconds) { * Sets the receiver's year. * <p> * The first year is 1752 and the last year is 9999. + * If the specified year is not valid for the receiver's day and month, then it is ignored. * </p> * * @param year an integer between 1752 and 9999 @@ -562,6 +575,8 @@ public void setTime (int hours, int minutes, int seconds) { * <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> + * + * @see #setDate */ public void setYear (int year) { checkWidget (); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Decorations.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Decorations.java index 2c6703a869..0924f1df48 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Decorations.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Decorations.java @@ -92,6 +92,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see Shell * @see SWT * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Decorations extends Canvas { Image image; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DirectoryDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DirectoryDialog.java index a65854ef1b..cb00fcf906 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DirectoryDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/DirectoryDialog.java @@ -32,6 +32,7 @@ import org.eclipse.swt.*; * @see <a href="http://www.eclipse.org/swt/snippets/#directorydialog">DirectoryDialog snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class DirectoryDialog extends Dialog { String message = "", filterPath = ""; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java index 4b986ad6d4..d61afda32b 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Display.java @@ -91,6 +91,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see Device#dispose * @see <a href="http://www.eclipse.org/swt/snippets/#display">Display snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Display extends Device { @@ -2615,6 +2616,13 @@ boolean isValidThread () { * <li>(in) x the x coordinate to move the mouse pointer to in screen coordinates * <li>(in) y the y coordinate to move the mouse pointer to in screen coordinates * </ul> + * <p>MouseWheel</p> + * <p>The following fields in the <code>Event</code> apply: + * <ul> + * <li>(in) type MouseWheel + * <li>(in) detail either SWT.SCROLL_LINE or SWT.SCROLL_PAGE + * <li>(in) count the number of lines or pages to scroll + * </ul> * </dl> * * @param event the event to be generated diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FileDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FileDialog.java index 6f7cc8bdae..c6e7c622a8 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FileDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FileDialog.java @@ -34,6 +34,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#filedialog">FileDialog snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class FileDialog extends Dialog { NSSavePanel panel; @@ -86,6 +87,10 @@ public FileDialog (Shell parent) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> * </ul> + * + * @see SWT#SAVE + * @see SWT#OPEN + * @see SWT#MULTI */ public FileDialog (Shell parent, int style) { super (parent, checkStyle (parent, style)); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FontDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FontDialog.java index 66a9c317fb..47039b5d88 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FontDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/FontDialog.java @@ -31,6 +31,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class FontDialog extends Dialog { FontData fontData; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Group.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Group.java index 298388f392..6e5c6c5099 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Group.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Group.java @@ -37,6 +37,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Group extends Composite { NSView contentView; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/IME.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/IME.java index aff466d1d8..32e9c338e4 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/IME.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/IME.java @@ -33,6 +33,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.4 + * @noextend This class is not intended to be subclassed by clients. */ public class IME extends Widget { Canvas parent; @@ -415,7 +416,7 @@ NSRange selectedRange (int /*long*/ id, int /*long*/ sel) { * above the IME, then the IME must be informed that the composition * offset has changed. * - * @return the offset of the composition + * @param offset the offset of the composition * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Label.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Label.java index 0f22a2c794..74345d6c14 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Label.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Label.java @@ -21,7 +21,7 @@ import org.eclipse.swt.internal.cocoa.*; * When SEPARATOR is specified, displays a single * vertical or horizontal line. * <p> - * Shadow styles are hints and may not be honoured + * Shadow styles are hints and may not be honored * by the platform. To create a separator label * with the default shadow style for the platform, * do not specify a shadow style. @@ -46,6 +46,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#label">Label snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Label extends Control { String text; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Link.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Link.java index 9ff36907f6..96c43d6ab0 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Link.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Link.java @@ -36,6 +36,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.1 + * @noextend This class is not intended to be subclassed by clients. */ public class Link extends Control { NSScrollView scrollView; @@ -456,8 +457,9 @@ void setForeground (float /*double*/ [] color) { * selected, the text field of the selection event contains either the * text of the hyperlink or the value of its HREF, if one was specified. * In the rare case of identical hyperlinks within the same string, the - * HREF tag can be used to distinguish between them. The string may - * include the mnemonic character and line delimiters. + * HREF attribute can be used to distinguish between them. The string may + * include the mnemonic character and line delimiters. The only delimiter + * the HREF attribute supports is the quotation mark ("). * </p> * * @param string the new text diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/List.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/List.java index 186c48ec3a..e016dc7752 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/List.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/List.java @@ -37,6 +37,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#list">List snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class List extends Scrollable { NSTableColumn column; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Menu.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Menu.java index 80b8637a52..be748a9e04 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Menu.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Menu.java @@ -37,6 +37,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#menu">Menu snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Menu extends Widget { /** @@ -115,6 +116,9 @@ public Menu (Control parent) { * @see SWT#BAR * @see SWT#DROP_DOWN * @see SWT#POP_UP + * @see SWT#NO_RADIO_GROUP + * @see SWT#LEFT_TO_RIGHT + * @see SWT#RIGHT_TO_LEFT * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MenuItem.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MenuItem.java index 7f045dae3f..e8b08d9d1f 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MenuItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MenuItem.java @@ -34,6 +34,7 @@ import org.eclipse.swt.events.*; * </p> * * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class MenuItem extends Item { NSMenuItem nsItem; @@ -592,6 +593,9 @@ public void setEnabled (boolean enabled) { * <p> * Note: This operation is a hint and is not supported on * platforms that do not have this concept (for example, Windows NT). + * Furthermore, some platforms (such as GTK), cannot display both + * a check box and an image at the same time. Instead, they hide + * the image and display the check box. * </p> * * @param image the image to display diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MessageBox.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MessageBox.java index 455827c2a7..a5c9715a84 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MessageBox.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/MessageBox.java @@ -36,6 +36,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class MessageBox extends Dialog { String message = ""; @@ -80,6 +81,19 @@ public MessageBox (Shell parent) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> * </ul> + * + * @see SWT#ICON_ERROR + * @see SWT#ICON_INFORMATION + * @see SWT#ICON_QUESTION + * @see SWT#ICON_WARNING + * @see SWT#ICON_WORKING + * @see SWT#OK + * @see SWT#CANCEL + * @see SWT#YES + * @see SWT#NO + * @see SWT#ABORT + * @see SWT#RETRY + * @see SWT#IGNORE */ public MessageBox (Shell parent, int style) { super (parent, checkStyle (parent, checkStyle (style))); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java index e3c385b97e..4f78952f5d 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ProgressBar.java @@ -36,6 +36,7 @@ import org.eclipse.swt.*; * @see <a href="http://www.eclipse.org/swt/snippets/#progressbar">ProgressBar snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ProgressBar extends Control { @@ -68,6 +69,7 @@ public class ProgressBar extends Control { * @see SWT#SMOOTH * @see SWT#HORIZONTAL * @see SWT#VERTICAL + * @see SWT#INDETERMINATE * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Sash.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Sash.java index 6ecab77196..6dc4d740df 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Sash.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Sash.java @@ -36,6 +36,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#sash">Sash snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Sash extends Control { Cursor sizeCursor; @@ -71,6 +72,7 @@ public class Sash extends Control { * * @see SWT#HORIZONTAL * @see SWT#VERTICAL + * @see SWT#SMOOTH * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scale.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scale.java index 7391479d97..4015637930 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scale.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scale.java @@ -38,6 +38,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#scale">Scale snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Scale extends Control { int increment = 1; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ScrollBar.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ScrollBar.java index 5149b230e9..790c1e6403 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ScrollBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ScrollBar.java @@ -81,6 +81,7 @@ import org.eclipse.swt.graphics.*; * @see Scrollable#getVerticalBar * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ScrollBar extends Widget { NSScroller view; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scrollable.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scrollable.java index 45af97d9f1..94981bcf71 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scrollable.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Scrollable.java @@ -31,6 +31,7 @@ import org.eclipse.swt.graphics.*; * </p> * * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public abstract class Scrollable extends Control { NSScrollView scrollView; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Shell.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Shell.java index f89811ca6d..8b11eee6b0 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Shell.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Shell.java @@ -79,7 +79,7 @@ import org.eclipse.swt.internal.cocoa.*; * downgraded to <code>APPLICATION_MODAL</code>. * <dl> * <dt><b>Styles:</b></dt> - * <dd>BORDER, CLOSE, MIN, MAX, NO_TRIM, RESIZE, TITLE, ON_TOP, TOOL</dd> + * <dd>BORDER, CLOSE, MIN, MAX, NO_TRIM, RESIZE, TITLE, ON_TOP, TOOL, SHEET</dd> * <dd>APPLICATION_MODAL, MODELESS, PRIMARY_MODAL, SYSTEM_MODAL</dd> * <dt><b>Events:</b></dt> * <dd>Activate, Close, Deactivate, Deiconify, Iconify</dd> @@ -168,13 +168,16 @@ public Shell () { * @see SWT#MAX * @see SWT#RESIZE * @see SWT#TITLE + * @see SWT#TOOL * @see SWT#NO_TRIM * @see SWT#SHELL_TRIM * @see SWT#DIALOG_TRIM + * @see SWT#ON_TOP * @see SWT#MODELESS * @see SWT#PRIMARY_MODAL * @see SWT#APPLICATION_MODAL * @see SWT#SYSTEM_MODAL + * @see SWT#SHEET */ public Shell (int style) { this ((Display) null, style); @@ -238,13 +241,16 @@ public Shell (Display display) { * @see SWT#MAX * @see SWT#RESIZE * @see SWT#TITLE + * @see SWT#TOOL * @see SWT#NO_TRIM * @see SWT#SHELL_TRIM * @see SWT#DIALOG_TRIM + * @see SWT#ON_TOP * @see SWT#MODELESS * @see SWT#PRIMARY_MODAL * @see SWT#APPLICATION_MODAL * @see SWT#SYSTEM_MODAL + * @see SWT#SHEET */ public Shell (Display display, int style) { this (display, null, style, 0, false); @@ -350,6 +356,7 @@ public Shell (Shell parent) { * @see SWT#PRIMARY_MODAL * @see SWT#APPLICATION_MODAL * @see SWT#SYSTEM_MODAL + * @see SWT#SHEET */ public Shell (Shell parent, int style) { this (parent != null ? parent.display : null, parent, style, 0, false); @@ -1317,7 +1324,7 @@ public void setEnabled (boolean enabled) { * to switch to the full screen state, and if the argument is * <code>false</code> and the receiver was previously switched * into full screen state, causes the receiver to switch back - * to either the maximmized or normal states. + * to either the maximized or normal states. * <p> * Note: The result of intermixing calls to <code>setFullScreen(true)</code>, * <code>setMaximized(true)</code> and <code>setMinimized(true)</code> will diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Slider.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Slider.java index 746ce991a3..e2bf23da44 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Slider.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Slider.java @@ -67,6 +67,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#slider">Slider snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Slider extends Control { boolean dragging; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Spinner.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Spinner.java index 27a14b0aa2..24be6c90f7 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Spinner.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Spinner.java @@ -38,6 +38,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.1 + * @noextend This class is not intended to be subclassed by clients. */ public class Spinner extends Composite { NSTextField textView; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabFolder.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabFolder.java index bd01f9c2d3..8c8d60f3e0 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabFolder.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabFolder.java @@ -45,6 +45,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#tabfolder">TabFolder, TabItem snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TabFolder extends Composite { TabItem [] items; @@ -76,6 +77,8 @@ public class TabFolder extends Composite { * </ul> * * @see SWT + * @see SWT#TOP + * @see SWT#BOTTOM * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabItem.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabItem.java index 0a0e28de8e..dfa75bfea0 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TabItem.java @@ -30,6 +30,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#tabfolder">TabFolder, TabItem snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TabItem extends Item { TabFolder parent; @@ -335,8 +336,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Table.java index 44fcf22c34..c021872b22 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Table.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Table.java @@ -64,6 +64,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Table extends Composite { TableItem [] items; @@ -1508,7 +1509,8 @@ public TableItem [] getItems () { /** * Returns <code>true</code> if the receiver's lines are visible, - * and <code>false</code> otherwise. + * and <code>false</code> otherwise. Note that some platforms draw + * grid lines while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, this method @@ -2429,7 +2431,8 @@ public void setRedraw (boolean redraw) { /** * Marks the receiver's lines as visible if the argument is <code>true</code>, - * and marks it invisible otherwise. + * and marks it invisible otherwise. Note that some platforms draw grid lines + * while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, marking diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableColumn.java index aadd41b88e..15bc94f809 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableColumn.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableColumn.java @@ -33,6 +33,7 @@ import org.eclipse.swt.events.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TableColumn extends Item { Table parent; @@ -625,8 +626,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableItem.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableItem.java index c24e593d48..43b61bb94d 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TableItem.java @@ -31,6 +31,7 @@ import org.eclipse.swt.graphics.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TableItem extends Item { Table parent; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Text.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Text.java index 45c489a387..ecc87b08f8 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Text.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Text.java @@ -29,20 +29,30 @@ import org.eclipse.swt.internal.cocoa.*; * <p> * <dl> * <dt><b>Styles:</b></dt> - * <dd>CANCEL, CENTER, LEFT, MULTI, PASSWORD, SEARCH, SINGLE, RIGHT, READ_ONLY, WRAP</dd> + * <dd>CENTER, ICON_CANCEL, ICON_SEARCH, LEFT, MULTI, PASSWORD, SEARCH, SINGLE, RIGHT, READ_ONLY, WRAP</dd> * <dt><b>Events:</b></dt> * <dd>DefaultSelection, Modify, Verify</dd> * </dl> * <p> * Note: Only one of the styles MULTI and SINGLE may be specified, * and only one of the styles LEFT, CENTER, and RIGHT may be specified. - * </p><p> + * </p> + * <p> + * Note: The styles ICON_CANCEL and ICON_SEARCH are hints used in combination with SEARCH. + * When the platform supports the hint, the text control shows these icons. When an icon + * is selected, a default selection event is sent with the detail field set to one of + * ICON_CANCEL or ICON_SEARCH. Normally, application code does not need to check the + * detail. In the case of ICON_CANCEL, the text is cleared before the default selection + * event is sent causing the application to search for an empty string. + * </p> + * <p> * IMPORTANT: This class is <em>not</em> intended to be subclassed. * </p> * * @see <a href="http://www.eclipse.org/swt/snippets/#text">Text snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Text extends Scrollable { int textLimit = LIMIT, tabs = 8; @@ -109,6 +119,13 @@ public class Text extends Scrollable { * @see SWT#MULTI * @see SWT#READ_ONLY * @see SWT#WRAP + * @see SWT#LEFT + * @see SWT#RIGHT + * @see SWT#CENTER + * @see SWT#PASSWORD + * @see SWT#SEARCH + * @see SWT#ICON_SEARCH + * @see SWT#ICON_CANCEL * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -880,13 +897,10 @@ public int getOrientation () { } /** - * Returns the widget message. When the widget is created - * with the style <code>SWT.SEARCH</code>, the message text - * is displayed as a hint for the user, indicating the - * purpose of the field. + * Returns the widget message. The message text is displayed + * as a hint for the user, indicating the purpose of the field. * <p> - * Note: This operation is a <em>HINT</em> and is not - * supported on platforms that do not have this concept. + * Typically this is used in conjunction with <code>SWT.SEARCH</code>. * </p> * * @return the widget message @@ -1577,13 +1591,10 @@ public void setOrientation (int orientation) { } /** - * Sets the widget message. When the widget is created - * with the style <code>SWT.SEARCH</code>, the message text - * is displayed as a hint for the user, indicating the - * purpose of the field. + * Sets the widget message. The message text is displayed + * as a hint for the user, indicating the purpose of the field. * <p> - * Note: This operation is a <em>HINT</em> and is not - * supported on platforms that do not have this concept. + * Typically this is used in conjunction with <code>SWT.SEARCH</code>. * </p> * * @param message the new message diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolBar.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolBar.java index e6c73174d2..a1ee606481 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolBar.java @@ -43,6 +43,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#toolbar">ToolBar, ToolItem snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ToolBar extends Composite { int itemCount; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolItem.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolItem.java index 56ff6a111b..a423877a41 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/ToolItem.java @@ -34,6 +34,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#toolbar">ToolBar, ToolItem snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ToolItem extends Item { NSView view; @@ -897,8 +898,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tracker.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tracker.java index f365f683cc..244ffd124c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tracker.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tracker.java @@ -37,6 +37,7 @@ import org.eclipse.swt.internal.cocoa.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#tracker">Tracker snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Tracker extends Widget { Control parent; @@ -125,6 +126,7 @@ public Tracker (Composite parent, int style) { * @see SWT#RIGHT * @see SWT#UP * @see SWT#DOWN + * @see SWT#RESIZE */ public Tracker (Display display, int style) { if (display == null) display = Display.getCurrent (); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TrayItem.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TrayItem.java index 12f5812db4..efb262b11d 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TrayItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TrayItem.java @@ -34,6 +34,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public class TrayItem extends Item { Tray parent; @@ -383,9 +384,18 @@ public void setToolTip (ToolTip toolTip) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * - * @param value the new tool tip text (or null) + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * + * @param string the new tool tip text (or null) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tree.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tree.java index 9fd748a979..0a5e923227 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tree.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Tree.java @@ -71,6 +71,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/snippets/#tree">Tree, TreeItem, TreeColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Tree extends Composite { NSTableColumn firstColumn, checkColumn; @@ -1574,7 +1575,8 @@ public TreeItem [] getItems () { /** * Returns <code>true</code> if the receiver's lines are visible, - * and <code>false</code> otherwise. + * and <code>false</code> otherwise. Note that some platforms draw + * grid lines while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, this method @@ -2642,7 +2644,8 @@ void setItemHeight (Image image, NSFont font, boolean set) { /** * Marks the receiver's lines as visible if the argument is <code>true</code>, - * and marks it invisible otherwise. + * and marks it invisible otherwise. Note that some platforms draw + * grid lines while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, marking diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeColumn.java index 15feb2e3f0..e1e2c22777 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeColumn.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeColumn.java @@ -35,6 +35,7 @@ import org.eclipse.swt.events.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.1 + * @noextend This class is not intended to be subclassed by clients. */ public class TreeColumn extends Item { NSTableColumn nsColumn; @@ -624,8 +625,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeItem.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeItem.java index a658090a5b..ad80eb00f5 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/TreeItem.java @@ -32,6 +32,7 @@ import org.eclipse.swt.graphics.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#tree">Tree, TreeItem, TreeColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TreeItem extends Item { Tree parent; |