summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2006-05-03 20:02:09 +0000
committerCarolyn MacLeod <carolyn>2006-05-03 20:02:09 +0000
commite880a6e84e2c212aad35915a8e501a30b543c4fe (patch)
tree33caaa46660a67b93663d6f950933dbf725b03f3 /bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java
parentdd2daaefe7b01d6308af5987fb9008de6a622b64 (diff)
downloadeclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.tar.gz
eclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.tar.xz
eclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.zip
Javadoc basher output for 3.2RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java35
1 files changed, 31 insertions, 4 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java
index 49a32a7f63..fe4da51c67 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TreeColumn.java
@@ -19,13 +19,13 @@ import org.eclipse.swt.events.*;
/**
* Instances of this class represent a column in a tree widget.
- * <dl>
+ * <p><dl>
* <dt><b>Styles:</b></dt>
* <dd>LEFT, RIGHT, CENTER</dd>
* <dt><b>Events:</b></dt>
* <dd> Move, Resize, Selection</dd>
* </dl>
- * <p>
+ * </p><p>
* Note: Only one of the styles LEFT, RIGHT and CENTER may be specified.
* </p><p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
@@ -95,10 +95,11 @@ public TreeColumn (Tree parent, int style) {
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
- * @param index the index to store the receiver in its parent
+ * @param index the zero-relative index to store the receiver in its parent
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
+ * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
@@ -280,6 +281,19 @@ public boolean getResizable () {
return OS.gtk_tree_view_column_get_resizable (handle);
}
+/**
+ * Returns the receiver's tool tip text, or null if it has
+ * not been set.
+ *
+ * @return the receiver's tool tip text
+ *
+ * @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.2
+ */
public String getToolTipText () {
checkWidget();
return toolTipText;
@@ -526,7 +540,7 @@ public void setImage (Image image) {
*
* @see Tree#setColumnOrder(int[])
* @see Tree#getColumnOrder()
- * @see TreeeColumn#getMoveable()
+ * @see TreeColumn#getMoveable()
* @see SWT#Move
*
* @since 3.2
@@ -567,6 +581,19 @@ 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.
+ *
+ * @param string the new tool tip text (or null)
+ *
+ * @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.2
+ */
public void setToolTipText (String string) {
checkWidget();
Shell shell = parent._getShell ();