CTabFolder javadoc

2 files changed, 37 insertions, 32 deletions

diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java
index 7d5bf31390..4b54764331 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java
@@ -745,8 +745,6 @@ public boolean getMRUVisible() {
 	return mru;
 }
 /**
- * WARNING: API UNDER CONSTRUCTION
- * 
  * Returns the receiver's renderer.
  *
  * @exception SWTException <ul>
@@ -1897,8 +1895,6 @@ public void setBackground (Color color) {
 	redraw();
 }
 /**
- * WARNING: API UNDER CONSTRUCTION
- * 
  * Specify a gradient of colours to be drawn in the background of the unselected tabs.
  * For example to draw a gradient that varies from dark blue to blue and then to
  * white, use the following call to setBackground:
@@ -1929,8 +1925,6 @@ public void setBackground(Color[] colors, int[] percents) {
 	setBackground(colors, percents, false);
 }
 /**
- * WARNING: API UNDER CONSTRUCTION
- * 
  * Specify a gradient of colours to be drawn in the background of the unselected tab.
  * For example to draw a vertical gradient that varies from dark blue to blue and then to
  * white, use the following call to setBackground:
@@ -2616,8 +2610,6 @@ public void setMRUVisible(boolean show) {
 	}
 }
 /**
- * WARNING: API UNDER CONSTRUCTION
- * 
  * Sets the renderer which is associated with the receiver to be
  * the argument which may be null. In the case of null, the default
  * renderer is used.
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java
index 68f2644851..c84d333a14 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java
@@ -15,7 +15,6 @@ import org.eclipse.swt.graphics.*;
 import org.eclipse.swt.widgets.*;
 
 /**
- * WARNING: API UNDER CONSTRUCTION
  * Instances of this class provide all of the measuring and drawing functionality 
  * required by <code>CTabFolder</code>. This class can be subclassed in order to
  * customize the look of a CTabFolder.
@@ -178,33 +177,42 @@ public class CTabFolderRenderer {
 	}
 
 	/**
-	 * Returns the preferred size of the receiver.
+	 * Returns the preferred size of a part.
 	 * <p>
-	 * The <em>preferred size</em> of a control is the size that it would
+	 * The <em>preferred size</em> of a part is the size that it would
 	 * best be displayed at. The width hint and height hint arguments
 	 * allow the caller to ask a control questions such as "Given a particular
-	 * width, how high does the control need to be to show all of the contents?"
+	 * width, how high does the part need to be to show all of the contents?"
 	 * To indicate that the caller does not wish to constrain a particular 
 	 * dimension, the constant <code>SWT.DEFAULT</code> is passed for the hint. 
 	 * </p><p>
 	 * The <code>part</code> value indicated what component the preferred size is 
 	 * to be calculated for. Valid values are any of the part constants:
 	 * <ul> 
-	 * <li>PART_BODY</li> <li>PART_HEADER</li> <li>PART_BORDER</li>
-	 * <li>PART_BACKGROUND</li> <li>PART_MAX_BUTTON</li> 
-	 * <li>PART_MIN_BUTTON</li> <li>PART_CHEVRON_BUTTON</li>
-	 * <li>PART_CLOSE_BUTTON</li> <li>an integer, greater than 0, which coincides
-	 * with the CTabItem index.</li>
+	 * <li>PART_BODY</li>
+	 * <li>PART_HEADER</li> 
+	 * <li>PART_BORDER</li>
+	 * <li>PART_BACKGROUND</li> 
+	 * <li>PART_MAX_BUTTON</li> 
+	 * <li>PART_MIN_BUTTON</li> 
+	 * <li>PART_CHEVRON_BUTTON</li>
+	 * <li>PART_CLOSE_BUTTON</li> 
+	 * <li>A positive integer which is the index of an item in the CTabFolder.</li>
+	 * </ul>
+	 * </p>
+	 * <p>
+	 * The state parameter may be one of the following: 
+	 * <ul>
+	 * <li>SWT.NONE</li>
+	 * <li>SWT.SELECTED - whether the part is selected</li>
 	 * </ul>
-	 *  
 	 * </p>
 	 * @param part a part constant 
-	 * @param state current state (can be <code>SWT.NONE</code> or <code>SWT.SELECTED</code> when
-	 * passing in a CTabItem index to indicate a selected CTabIten)
-	 * @param gc the gc of the receiver
+	 * @param state current state 
+	 * @param gc the gc to use for measuring
 	 * @param wHint the width hint (can be <code>SWT.DEFAULT</code>)
 	 * @param hHint the height hint (can be <code>SWT.DEFAULT</code>)
-	 * @return the preferred size of the control
+	 * @return the preferred size of the part
 	 * 
 	 * @since 3.6
 	 */
@@ -296,14 +304,14 @@ public class CTabFolderRenderer {
 	}
 
 	/**
-	 * Given a desired <em>client area</em> for the receiver
+	 * Given a desired <em>client area</em> for the part
 	 * (as described by the arguments), returns the bounding
 	 * rectangle which would be required to produce that client
 	 * area.
 	 * <p>
 	 * In other words, it returns a rectangle such that, if the
-	 * receiver's bounds were set to that rectangle, the area
-	 * of the receiver which is capable of displaying data
+	 * part's bounds were set to that rectangle, the area
+	 * of the part which is capable of displaying data
 	 * (that is, not covered by the "trimmings") would be the
 	 * rectangle described by the arguments (relative to the
 	 * receiver's parent).
@@ -317,7 +325,7 @@ public class CTabFolderRenderer {
 	 * @param height the desired height of the client area
 	 * @return the required bounds to produce the given client area
 	 *
-	 * @see CTabFolderRenderer#computeSize(int, int, GC, int, int) valid part values
+	 * @see CTabFolderRenderer#computeSize(int, int, GC, int, int) valid part and state values
 	 *  
 	 * @since 3.6
 	 */
@@ -449,7 +457,7 @@ public class CTabFolderRenderer {
 	/**
 	 * Dispose of any operating system resources associated with
 	 * the renderer. Called by the CTabFolder parent upon receiving
-	 * the dispose event.
+	 * the dispose event or when changing the renderer.
 	 * 
 	 * @since 3.6
 	 */
@@ -490,16 +498,21 @@ public class CTabFolderRenderer {
 	 * <li>PART_MIN_BUTTON</li>
 	 * <li>PART_CHEVRON_BUTTON</li>
 	 * <li>PART_CLOSE_BUTTON</li>
-	 * <li>Some integer, greater than 0, which coincides with the CTabItem index.</li>
+	 * <li>A positive integer which is the index of an item in the CTabFolder.</li>
 	 * </ul>
 	 * </p>
 	 * <p>
-	 * The state flag is used to indicate whether the foreground, background or both is to be drawn and, in 
-	 * the case of drawing a CTabItem, whether that item is selected.
+	 * The state parameter may be a combination of: 
+	 * <ul>
+	 * <li>SWT.BACKGROUND - whether the background should be drawn</li>
+	 * <li>SWT.FOREGROUND - whether the foreground should be drawn</li>
+	 * <li>SWT.SELECTED - whether the part is selected</li>
+	 * <li>SWT.HOT - whether the part is hot (i.e. mouse is over the part)</li>
+	 * </ul>
 	 * </p>
 	 * 
-	 * @param part part to draw (valid values listed above)
-	 * @param state state of the part (can be any combination of SWT.BACKGROUND, SWT.FOREGROUND and SWT.SELECTED)
+	 * @param part part to draw 
+	 * @param state state of the part 
 	 * @param bounds the bounds of the part
 	 * @param gc the gc to draw the part on
 	 *