annotate dwt/layout/RowData.d @ 259:c0d810de7093

Update SWT 3.4M7 to 3.4
author Frank Benoit <benoit@tionex.de>
date Sun, 29 Jun 2008 14:33:38 +0200
parents 380bad9f6852
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
11 * Frank Benoit <benoit@tionex.de>
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.layout.RowData;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
15 import dwt.DWT;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.graphics.Point;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.widgets.Control;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import tango.util.Convert;
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
20 import dwt.dwthelper.utils;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * Each control controlled by a <code>RowLayout</code> can have its initial
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * width and height specified by setting a <code>RowData</code> object
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * into the control.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * <p>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * The following code uses a <code>RowData</code> object to change the initial
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * size of a <code>Button</code> in a <code>Shell</code>:
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * <pre>
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
30 * Display display = new Display();
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
31 * Shell shell = new Shell(display);
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
32 * shell.setLayout(new RowLayout());
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
33 * Button button1 = new Button(shell, DWT.PUSH);
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
34 * button1.setText("Button 1");
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
35 * button1.setLayoutData(new RowData(50, 40));
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * </pre>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * </p>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * @see RowLayout
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
40 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 public final class RowData {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
43 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
44 * width specifies the desired width in pixels. This value
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
45 * is the wHint passed into Control.computeSize(int, int, bool)
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
46 * to determine the preferred size of the control.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
47 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
48 * The default value is DWT.DEFAULT.
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
49 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
50 * @see dwt.widgets.Control#computeSize(int, int, bool)
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
51 */
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
52 public int width = DWT.DEFAULT;
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
53 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
54 * height specifies the preferred height in pixels. This value
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
55 * is the hHint passed into Control.computeSize(int, int, bool)
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
56 * to determine the preferred size of the control.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
57 *
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
58 * The default value is DWT.DEFAULT.
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
59 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
60 * @see dwt.widgets.Control#computeSize(int, int, bool)
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
61 */
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
62 public int height = DWT.DEFAULT;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
64 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
65 * exclude informs the layout to ignore this control when sizing
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
66 * and positioning controls. If this value is <code>true</code>,
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
67 * the size and position of the control will not be managed by the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
68 * layout. If this value is <code>false</code>, the size and
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
69 * position of the control will be computed and assigned.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
70 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
71 * The default value is <code>false</code>.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
72 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
73 * @since 3.1
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
74 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
75 public bool exclude = false;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * Constructs a new instance of RowData using
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * default values.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 public this () {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * Constructs a new instance of RowData according to the parameters.
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
86 * A value of DWT.DEFAULT indicates that no minimum width or
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * no minimum height is specified.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * @param width a minimum width for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * @param height a minimum height for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 public this (int width, int height) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
93 this.width = width;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
94 this.height = height;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 * Constructs a new instance of RowData according to the parameter.
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
99 * A value of DWT.DEFAULT indicates that no minimum width or
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * no minimum height is specified.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * @param point a point whose x coordinate specifies a minimum width for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * and y coordinate specifies a minimum height for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 public this (Point point) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
106 this (point.x, point.y);
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
109 String getName () {
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
110 String string = this.classinfo.name;
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
111 int index = string.lastIndexOf('.');
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
112 if (index is -1 ) return string;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 return string[ index + 1 .. string.length ];
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 * Returns a string containing a concise, human-readable
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 * description of the receiver.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 * @return a string representation of the RowData object
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
122 override public String toString () {
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
123 String string = getName ()~" {";
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
124 if (width !is DWT.DEFAULT) string ~= "width="~to!(String)(width)~" ";
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
125 if (height !is DWT.DEFAULT) string ~= "height="~to!(String)(height)~" ";
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
126 if (exclude) string ~= "exclude="~to!(String)(exclude)~" ";
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 201
diff changeset
127 string = string.trim();
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
128 string ~= "}";
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 51
diff changeset
129 return string;
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 }