summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2008-06-04 20:45:22 +0000
committerCarolyn MacLeod <carolyn>2008-06-04 20:45:22 +0000
commit45b394fe10eb1852268eed201cf431c4774b5428 (patch)
tree00ccb791c8930d127177c0034c8ee92863d9cedc /bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java
parent5ccbc836d63be99bd6e1cf9e6c2cc8027488f31c (diff)
downloadeclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.tar.gz
eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.tar.xz
eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.zip
After Javadoc Bash for 3.4RC4
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java13
1 files changed, 11 insertions, 2 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java
index dd2f67119c..b45f72cc32 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/TextLayout.java
@@ -28,7 +28,11 @@ import org.eclipse.swt.*;
* when those instances are no longer required.
* </p>
*
- * @since 3.0
+ * @see <a href="http://www.eclipse.org/swt/snippets/#textlayout">TextLayout, TextStyle snippets</a>
+ * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: CustomControlExample, StyledText tab</a>
+ * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
+ *
+ * @since 3.0
*/
public final class TextLayout extends Resource {
@@ -857,13 +861,18 @@ public int getAscent () {
}
/**
- * Returns the bounds of the receiver.
+ * Returns the bounds of the receiver. The width returned is either the
+ * width of the longest line or the width set using {@link TextLayout#setWidth(int)}.
+ * To obtain the text bounds of a line use {@link TextLayout#getLineBounds(int)}.
*
* @return the bounds of the receiver
*
* @exception SWTException <ul>
* <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
* </ul>
+ *
+ * @see #setWidth(int)
+ * @see #getLineBounds(int)
*/
public Rectangle getBounds() {
checkLayout();