diff options
author | Carolyn MacLeod <carolyn> | 2005-06-21 21:01:14 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2005-06-21 21:01:14 +0000 |
commit | fb124d2ba5ec40e564190dc83884d6e6c7990509 (patch) | |
tree | 9513dbbd028b33c539d7fff1cd075df2f2b2d3ca | |
parent | b8ad7149e04c64ffb49003decdf4f7e372a82e3f (diff) | |
download | eclipse.platform.swt-fb124d2ba5ec40e564190dc83884d6e6c7990509.tar.gz eclipse.platform.swt-fb124d2ba5ec40e564190dc83884d6e6c7990509.tar.xz eclipse.platform.swt-fb124d2ba5ec40e564190dc83884d6e6c7990509.zip |
doc: bug 84906
8 files changed, 59 insertions, 42 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/MenuListener.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/MenuListener.java index 3f4f8a6fb3..cb46cf8802 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/MenuListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/MenuListener.java @@ -18,9 +18,9 @@ import org.eclipse.swt.internal.SWTEventListener; * that deal with the hiding and showing of menus. * <p> * After creating an instance of a class that implements - * this interface it can be added to a control using the + * this interface it can be added to a menu using the * <code>addMenuListener</code> method and removed using - * the <code>removeMenuListener</code> method. When a + * the <code>removeMenuListener</code> method. When the * menu is hidden or shown, the appropriate method will * be invoked. * </p> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/ShellListener.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/ShellListener.java index dbf9412888..c4a656420d 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/ShellListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/ShellListener.java @@ -18,10 +18,10 @@ import org.eclipse.swt.internal.SWTEventListener; * that deal with changes in state of <code>Shell</code>s. * <p> * After creating an instance of a class that implements - * this interface it can be added to a control using the + * this interface it can be added to a shell using the * <code>addShellListener</code> method and removed using * the <code>removeShellListener</code> method. When the - * state of a shell changes, the appropriate method will + * state of the shell changes, the appropriate method will * be invoked. * </p> * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/TreeListener.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/TreeListener.java index eaf85f180c..28629b92d2 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/TreeListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/TreeListener.java @@ -19,10 +19,10 @@ import org.eclipse.swt.internal.SWTEventListener; * branches. * <p> * After creating an instance of a class that implements - * this interface it can be added to a control using the + * this interface it can be added to a tree control using the * <code>addTreeListener</code> method and removed using * the <code>removeTreeListener</code> method. When a branch - * of a tree is expanded or collapsed, the appropriate method + * of the tree is expanded or collapsed, the appropriate method * will be invoked. * </p> * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/VerifyListener.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/VerifyListener.java index ae542ff402..fdcc2e09d8 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/VerifyListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/VerifyListener.java @@ -19,7 +19,7 @@ import org.eclipse.swt.internal.SWTEventListener; * is about to be modified. * <p> * After creating an instance of a class that implements - * this interface it can be added to a text widget using the + * this interface it can be added to a text control using the * <code>addVerifyListener</code> method and removed using * the <code>removeVerifyListener</code> method. When the * text is about to be modified, the verifyText method diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java index 49cd593128..2a7a32e7b5 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java @@ -47,10 +47,10 @@ public final class FillLayout extends Layout { * * The default value is HORIZONTAL. * - * Possible values are: - * - * HORIZONTAL: Position the controls horizontally from left to right - * VERTICAL: Position the controls vertically from top to bottom + * Possible values are: <ul> + * <li>HORIZONTAL: Position the controls horizontally from left to right</li> + * <li>VERTICAL: Position the controls vertically from top to bottom</li> + * </ul> */ public int type = SWT.HORIZONTAL; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java index db1b247622..00b3012b40 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java @@ -17,7 +17,7 @@ import org.eclipse.swt.widgets.*; /** * <code>GridData</code> is the layout data object associated with * <code>GridLayout</code>. To set a <code>GridData</code> object into a - * control, you use the <code>Control#setLayoutData(Object)</code> method. + * control, you use the <code>Control.setLayoutData(Object)</code> method. * <p> * There are two ways to create a <code>GridData</code> object with certain * fields set. The first is to set the fields directly, like this: @@ -42,6 +42,7 @@ import org.eclipse.swt.widgets.*; * </p> * * @see GridLayout + * @see Control#setLayoutData */ public final class GridData { /** @@ -50,12 +51,12 @@ public final class GridData { * * The default value is CENTER. * - * Possible values are: - * - * SWT.BEGINNING (or SWT.TOP): Position the control at the top of the cell - * SWT.CENTER: Position the control in the vertical center of the cell - * SWT.END (or SWT.BOTTOM): Position the control at the bottom of the cell - * SWT.FILL: Resize the control to fill the cell vertically + * Possible values are: <ul> + * <li>SWT.BEGINNING (or SWT.TOP): Position the control at the top of the cell</li> + * <li>SWT.CENTER: Position the control in the vertical center of the cell</li> + * <li>SWT.END (or SWT.BOTTOM): Position the control at the bottom of the cell</li> + * <li>SWT.FILL: Resize the control to fill the cell vertically</li> + * </ul> */ public int verticalAlignment = CENTER; @@ -65,30 +66,34 @@ public final class GridData { * * The default value is BEGINNING. * - * Possible values are: - * - * SWT.BEGINNING (or SWT.LEFT): Position the control at the left of the cell - * SWT.CENTER: Position the control in the horizontal center of the cell - * SWT.END (or SWT.RIGHT): Position the control at the right of the cell - * SWT.FILL: Resize the control to fill the cell horizontally + * Possible values are: <ul> + * <li>SWT.BEGINNING (or SWT.LEFT): Position the control at the left of the cell</li> + * <li>SWT.CENTER: Position the control in the horizontal center of the cell</li> + * <li>SWT.END (or SWT.RIGHT): Position the control at the right of the cell</li> + * <li>SWT.FILL: Resize the control to fill the cell horizontally</li> + * </ul> */ public int horizontalAlignment = BEGINNING; /** * widthHint specifies the preferred width in pixels. This value - * is the wHint passed into Control#computeSize(int, int, boolean) + * is the wHint passed into Control.computeSize(int, int, boolean) * to determine the preferred size of the control. * * The default value is SWT.DEFAULT. + * + * @see Control#computeSize */ public int widthHint = SWT.DEFAULT; /** * heightHint specifies the preferred height in pixels. This value - * is the hHint passed into Control#computeSize(int, int, boolean) + * is the hHint passed into Control.computeSize(int, int, boolean) * to determine the preferred size of the control. * * The default value is SWT.DEFAULT. + * + * @see Control#computeSize */ public int heightHint = SWT.DEFAULT; @@ -138,11 +143,11 @@ public final class GridData { * horizontal space divided by the number of grabbing columns.</li> * <li>If there is not enough horizontal space available in the parent, the * cell will shrink until it reaches its minimum width as specified by - * GridData#minimumWidth. The new width will be the maximum of + * GridData.minimumWidth. The new width will be the maximum of * "minimumWidth" and "preferred width - delta", where delta is * the amount of space missing divided by the number of grabbing columns.</li> * <li>If the parent is packed, the cell will be its preferred width - * as specified by GridData#widthHint.</li> + * as specified by GridData.widthHint.</li> * <li>If the control spans multiple columns and there are no other grabbing * controls in any of the spanned columns, the last column in the span will * grab the extra space. If there is at least one other grabbing control @@ -151,6 +156,9 @@ public final class GridData { * </ul> * * <p>The default value is false.</p> + * + * @see GridData#minimumWidth + * @see GridData#widthHint */ public boolean grabExcessHorizontalSpace = false; @@ -166,11 +174,11 @@ public final class GridData { * vertical space divided by the number of grabbing rows.</li> * <li>If there is not enough vertical space available in the parent, the * cell will shrink until it reaches its minimum height as specified by - * GridData#minimumHeight. The new height will be the maximum of + * GridData.minimumHeight. The new height will be the maximum of * "minimumHeight" and "preferred height - delta", where delta is * the amount of space missing divided by the number of grabbing rows.</li> * <li>If the parent is packed, the cell will be its preferred height - * as specified by GridData#heightHint.</li> + * as specified by GridData.heightHint.</li> * <li>If the control spans multiple rows and there are no other grabbing * controls in any of the spanned rows, the last row in the span will * grab the extra space. If there is at least one other grabbing control @@ -179,32 +187,39 @@ public final class GridData { * </ul> * * <p>The default value is false.</p> + * + * @see GridData#minimumHeight + * @see GridData#heightHint */ public boolean grabExcessVerticalSpace = false; /** * minimumWidth specifies the minimum width in pixels. This value * applies only if grabExcessHorizontalSpace is true. A value of - * SWT#DEFAULT means that the minimum width will be the result - * of Control#computeSize(int, int, boolean) where wHint is - * determined by GridData#widthHint. + * SWT.DEFAULT means that the minimum width will be the result + * of Control.computeSize(int, int, boolean) where wHint is + * determined by GridData.widthHint. * * The default value is 0. * * @since 3.1 + * @see Control#computeSize + * @see GridData#widthHint */ public int minimumWidth = 0; /** * minimumHeight specifies the minimum height in pixels. This value * applies only if grabExcessVerticalSpace is true. A value of - * SWT#DEFAULT means that the minimum height will be the result - * of Control#computeSize(int, int, boolean) where hHint is - * determined by GridData#heightHint. + * SWT.DEFAULT means that the minimum height will be the result + * of Control.computeSize(int, int, boolean) where hHint is + * determined by GridData.heightHint. * * The default value is 0. * * @since 3.1 + * @see Control#computeSize + * @see GridData#heightHint */ public int minimumHeight = 0; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java index 8af04cacfc..4442dd0f8f 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java @@ -35,20 +35,22 @@ import org.eclipse.swt.graphics.*; public final class RowData { /** * width specifies the desired width in pixels. This value - * is the wHint passed into Control#computeSize(int, int, boolean) + * is the wHint passed into Control.computeSize(int, int, boolean) * to determine the preferred size of the control. * * The default value is SWT.DEFAULT. * + * @see Control#computeSize */ public int width = SWT.DEFAULT; /** * height specifies the preferred height in pixels. This value - * is the hHint passed into Control#computeSize(int, int, boolean) + * is the hHint passed into Control.computeSize(int, int, boolean) * to determine the preferred size of the control. * * The default value is SWT.DEFAULT. * + * @see Control#computeSize */ public int height = SWT.DEFAULT; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java index 469f2f4ea7..fb82262f5f 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java @@ -60,10 +60,10 @@ public final class RowLayout extends Layout { * * The default value is HORIZONTAL. * - * Possible values are: - * - * HORIZONTAL: Position the controls horizontally from left to right - * VERTICAL: Position the controls vertically from top to bottom + * Possible values are: <ul> + * <li>HORIZONTAL: Position the controls horizontally from left to right</li> + * <li>VERTICAL: Position the controls vertically from top to bottom</li> + * </ul> * * @since 2.0 */ |