annotate dwt/layout/RowData.d @ 51:e300eb95bec4

RowData, RowLayout
author Frank Benoit <benoit@tionex.de>
date Fri, 11 Jan 2008 10:57:51 +0100
parents
children 8cec8f536af3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
51
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
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
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 module dwt.layout.RowData;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 import dwt.SWT;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14 import dwt.graphics.Point;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwt.widgets.Control;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import tango.text.Util;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import tango.util.Convert;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * Each control controlled by a <code>RowLayout</code> can have its initial
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * width and height specified by setting a <code>RowData</code> object
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * into the control.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * <p>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * The following code uses a <code>RowData</code> object to change the initial
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * size of a <code>Button</code> in a <code>Shell</code>:
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * <pre>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * Display display = new Display();
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * Shell shell = new Shell(display);
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * shell.setLayout(new RowLayout());
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * Button button1 = new Button(shell, SWT.PUSH);
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * button1.setText("Button 1");
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * button1.setLayoutData(new RowData(50, 40));
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * </pre>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * </p>
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @see RowLayout
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 public final class RowData {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * width specifies the desired width in pixels. This value
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * is the wHint passed into Control.computeSize(int, int, bool)
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * to determine the preferred size of the control.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * The default value is SWT.DEFAULT.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * @see dwt.widgets.Control#computeSize(int, int, bool)
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 public int width = SWT.DEFAULT;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * height specifies the preferred height in pixels. This value
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * is the hHint passed into Control.computeSize(int, int, bool)
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * to determine the preferred size of the control.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * The default value is SWT.DEFAULT.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * @see dwt.widgets.Control#computeSize(int, int, bool)
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 public int height = SWT.DEFAULT;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * exclude informs the layout to ignore this control when sizing
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * and positioning controls. If this value is <code>true</code>,
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * the size and position of the control will not be managed by the
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * layout. If this value is <code>false</code>, the size and
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * position of the control will be computed and assigned.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * The default value is <code>false</code>.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * @since 3.1
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 public bool exclude = false;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * Constructs a new instance of RowData using
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * default values.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 public this () {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * Constructs a new instance of RowData according to the parameters.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * A value of SWT.DEFAULT indicates that no minimum width or
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * no minimum height is specified.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * @param width a minimum width for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * @param height a minimum height for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 public this (int width, int height) {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 this.width = width;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 this.height = height;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * Constructs a new instance of RowData according to the parameter.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * A value of SWT.DEFAULT indicates that no minimum width or
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * no minimum height is specified.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * @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
100 * and y coordinate specifies a minimum height for the control
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 public this (Point point) {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 this (point.x, point.y);
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 char[] getName () {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 char[] string = this.classinfo.name;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 int index = locatePrior( string, '.');
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 if (index is string.length ) return string;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 return string[ index + 1 .. string.length ];
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 /**
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 * Returns a string containing a concise, human-readable
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * description of the receiver.
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 *
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 * @return a string representation of the RowData object
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 */
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 public char[] toString () {
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 char[] string = getName ()~" {";
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 if (width !is SWT.DEFAULT) string ~= "width="~to!(char[])(width)~" ";
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 if (height !is SWT.DEFAULT) string ~= "height="~to!(char[])(height)~" ";
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 if (exclude) string ~= "exclude="~to!(char[])(exclude)~" ";
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 string = trim( string );
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 string ~= "}";
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 return string;
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 }
e300eb95bec4 RowData, RowLayout
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 }