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/emulated/treetable/org | |
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/emulated/treetable/org')
6 files changed, 36 insertions, 8 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Table.java index b831282e33..c31b15f665 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Table.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Table.java @@ -63,6 +63,7 @@ import org.eclipse.swt.internal.*; * @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 { Canvas header; @@ -1104,7 +1105,8 @@ int getItemY (TableItem item) { } /** * 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 @@ -3514,7 +3516,8 @@ boolean setItemHeight (int value) { } /** * 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/emulated/treetable/org/eclipse/swt/widgets/TableColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TableColumn.java index bb683ce253..ad0fb228c3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TableColumn.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TableColumn.java @@ -30,6 +30,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 TableColumn extends Item { Table parent; @@ -696,8 +697,17 @@ public void setText (String value) { } /** * 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/emulated/treetable/org/eclipse/swt/widgets/TableItem.java b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TableItem.java index 73d725dd1c..3d794aebc8 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TableItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TableItem.java @@ -28,6 +28,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/emulated/treetable/org/eclipse/swt/widgets/Tree.java b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Tree.java index 2219ed1a60..cd16804925 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Tree.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/Tree.java @@ -70,6 +70,7 @@ import org.eclipse.swt.internal.*; * @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 { Canvas header; @@ -1165,7 +1166,8 @@ int getItemY (TreeItem item) { } /** * 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 @@ -3756,7 +3758,8 @@ boolean setItemHeight (int value) { } /** * 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/emulated/treetable/org/eclipse/swt/widgets/TreeColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TreeColumn.java index fba9087202..db1493e945 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TreeColumn.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TreeColumn.java @@ -32,6 +32,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 TreeColumn extends Item { Tree parent; @@ -672,8 +673,17 @@ public void setText (String value) { } /** * 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/emulated/treetable/org/eclipse/swt/widgets/TreeItem.java b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TreeItem.java index 82960d2faf..8969a6d5e3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TreeItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/emulated/treetable/org/eclipse/swt/widgets/TreeItem.java @@ -30,6 +30,7 @@ import org.eclipse.swt.internal.Compatibility; * * @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; |