diff options
author | Carolyn MacLeod <carolyn> | 2010-05-26 17:58:56 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2010-05-26 17:58:56 +0000 |
commit | 0f960e0b213854d19299aaa9b453b69c8d7ee794 (patch) | |
tree | 4ee2be0a3b8b821c15859cb8b9359d908978f4c3 /bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java | |
parent | 15bb116304bc8aeea45302e2a4ff1e9abf3dd426 (diff) | |
download | eclipse.platform.swt-0f960e0b213854d19299aaa9b453b69c8d7ee794.tar.gz eclipse.platform.swt-0f960e0b213854d19299aaa9b453b69c8d7ee794.tar.xz eclipse.platform.swt-0f960e0b213854d19299aaa9b453b69c8d7ee794.zip |
Bug 314492 - Do the annual copyright/javadoc bashAFTER_JAVADOC_BASH_FOR_36RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java')
-rw-r--r-- | bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java | 67 |
1 files changed, 64 insertions, 3 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java index c73b3ea2b2..2e427560e2 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/graphics/TextLayout.java @@ -1312,6 +1312,17 @@ public int[] getSegments() { return segments; } +/** + * Returns the segments characters of the receiver. + * + * @return the segments characters + * + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.6 + */ public char[] getSegmentsChars () { checkLayout(); return segmentsChars; @@ -1430,6 +1441,17 @@ public int getWidth () { return wrapWidth; } +/** +* Returns the receiver's wrap indent. +* +* @return the receiver's wrap indent +* +* @exception SWTException <ul> +* <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> +* </ul> +* +* @since 3.6 +*/ public int getWrapIndent () { checkLayout(); return wrapIndent; @@ -1441,7 +1463,7 @@ public int getWrapIndent () { * <p> * This method gets the dispose state for the text layout. * When a text layout has been disposed, it is an error to - * invoke any other method using the text layout. + * invoke any other method (except {@link #dispose()}) using the text layout. * </p> * * @return <code>true</code> when the text layout is disposed and <code>false</code> otherwise @@ -1659,7 +1681,7 @@ public void setFont (Font font) { } /** - * Sets the indent of the receiver. This indent it applied of the first line of + * Sets the indent of the receiver. This indent is applied to the first line of * each paragraph. * * @param indent new indent @@ -1668,6 +1690,8 @@ public void setFont (Font font) { * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * + * @see #setWrapIndent(int) + * * @since 3.2 */ public void setIndent (int indent) { @@ -1739,7 +1763,7 @@ public void setSpacing (int spacing) { /** * Sets the offsets of the receiver's text segments. Text segments are used to - * override the default behaviour of the bidirectional algorithm. + * override the default behavior of the bidirectional algorithm. * Bidirectional reordering can happen within a text segment but not * between two adjacent segments. * <p> @@ -1748,12 +1772,18 @@ public void setSpacing (int spacing) { * always be zero and the last one should always be equals to length of * the text. * </p> + * <p> + * When segments characters are set, the segments are the offsets where + * the characters are inserted in the text. + * <p> * * @param segments the text segments offset * * @exception SWTException <ul> * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> + * + * @see #setSegmentsChars(char[]) */ public void setSegments(int[] segments) { checkLayout(); @@ -1771,6 +1801,23 @@ public void setSegments(int[] segments) { this.segments = segments; } +/** + * Sets the characters to be used in the segments boundaries. The segments + * are set by calling <code>setSegments(int[])</code>. The application can + * use this API to insert Unicode Control Characters in the text to control + * the display of the text and bidi reordering. The characters are not + * accessible by any other API in <code>TextLayout</code>. + * + * @param segmentsChars the segments characters + * + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @see #setSegments(int[]) + * + * @since 3.6 + */ public void setSegmentsChars(char[] segmentsChars) { checkLayout(); if (this.segmentsChars == null && segmentsChars == null) return; @@ -1951,6 +1998,20 @@ public void setWidth (int width) { this.wrapWidth = width; } +/** + * Sets the wrap indent of the receiver. This indent is applied to all lines + * in the paragraph except the first line. + * + * @param wrapIndent new wrap indent + * + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @see #setIndent(int) + * + * @since 3.6 + */ public void setWrapIndent (int wrapIndent) { checkLayout(); if (wrapIndent < 0) return; |