1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/* ************************************************************************
qooxdoo - the new era of web development
http://qooxdoo.org
Copyright:
2006 by Derrell Lipman
License:
LGPL 2.1: http://www.gnu.org/licenses/lgpl.html
Authors:
* Derrell Lipman (derrell)
************************************************************************ */
/* ************************************************************************
#module(ui_treefullcontrol)
************************************************************************ */
/**
* The structure of a tree row.
*
* This is a singleton class. The constructor is not accessed by users;
* instead, to obtain the one and only TreeRowStructure object, call either
*
* qx.ui.treefullcontrol.TreeRowStructure.newRow()
*
* or
*
* qx.ui.treefullcontrol.TreeRowStructure.standard().
*
* The structure of a tree row is provided by a
* qx.ui.treefullcontrol.TreeRowStructure. The order of elements added to
* this object is the order in which they will be presented in a tree row.
*
* The three standard parts of a tree: the indentation (and its associated
* tree-lines, if enabled), the icon (selected or unselected), and the label
* are added to the structure in the desired order by calling, respectively,
* the methods addIndent(), addIcon() and addLabel().
*
* By default, indentation will appear at the beginning of the tree row. This
* can be changed by calling the addIndent() method after having calling other
* add*() methods on this object. If indentation is to be at the beginning of
* the tree row, simply do not call addIndent().
*
* Any other object which is valid within a qx.ui.layout.HorizontalBoxLayout
* may be added to the structure using addObject(). If the object has no
* special treatment, it may be made anonymous with obj.SetAnonymous(true).
* Otherwise, all handling for the object should be done by the application.
*
* A "standard" (traditional) tree row would be generated like this:
*
* treeRowStructure = qx.ui.treefullcontrol.TreeRowStructure.standard("Trash");
*
* which equates to issuing these commands:
*
* treeRowStructure = qx.ui.treefullcontrol.TreeRowStructure.newRow();
*
* //treeRowStructure.addIndent() // defaults to here; no need to call
* treeRowStructure.addIcon();
* treeRowStructure.addLabel("Trash");
*
* The former method is typically preferred.
*
* An example of a more sophisticated structure:
*
* treeRowStructure = qx.ui.treefullcontrol.TreeRowStructure.newRow();
*
* // A left-justified icon
* obj = new qx.ui.basic.Image("icon/16/alarm.png");
* treeRowStructure.addObject(obj, true);
*
* // Here's our indentation and tree-lines
* treeRowStructure.addIndent();
*
* // The standard tree icon follows
* treeRowStructure.addIcon("icon/16/desktop.png","icon/16/dictionary.png");
*
* // Right after the tree icon is a checkbox
* obj = new qx.ui.form.CheckBox(null, 23, null, false);
* obj.setPadding(0, 0);
* treeRowStructure.addObject(obj, true);
*
* // The label
* treeRowStructure.addLabel("Trash");
*
* // All else should be right justified
* obj = new qx.ui.basic.HorizontalSpacer;
* treeRowStructure.addObject(obj, true);
*
* // Add a file size, date and mode
* obj = new qx.ui.basic.Label("23kb");
* obj.setWidth(50);
* treeRowStructure.addObject(obj, true);
* obj = new qx.ui.basic.Label("11 Sept 1959");
* obj.setWidth(150);
* treeRowStructure.addObject(obj, true);
* obj = new qx.ui.basic.Label("-rw-r--r--");
* obj.setWidth(80);
* treeRowStructure.addObject(obj, true);
*/
qx.OO.defineClass("qx.ui.treefullcontrol.TreeRowStructure", qx.core.Object,
function()
{
qx.core.Object.call(this);
});
/**
* Prepare to define a new row.
*
* This reinitializes the singleton TreeRowStructure so that it is ready to
* define a new tree row.
*
* @return The singleton itself, purely for convenience.
*/
qx.Proto.newRow = function()
{
/* Create the indent, icon, and label objects */
this._indentObject = new qx.ui.embed.HtmlEmbed;
this._iconObject = new qx.ui.basic.Image;
this._labelObject = new qx.ui.basic.Label;
/* Create an object to hold the ordering of row objects */
this._fields = new Array;
/* Create an object to hold the icon names */
this._icons = new Object;
/* Initially assume that indentation goes at the beginning of the row */
this._fields.push(this._indentObject);
/* Set initial flags */
this._indentAdded = false;
this._iconAdded = false;
this._labelAdded = false;
/* Return the singleton (from which we were called) */
return this;
}
/**
* Define a new row with the 'standard' structure.
*
* This reinitializes the singleton TreeRowStructure to the state of a
* standard'or traditional tree row:
* - indentation
* - icon
* - label
*
* The icon parameters may be omitted in which case the defaults will be
* used. If the label parameter is omitted, no label will appear.
*
* @param vLabel {string} The label text
* @param vIcon {string} Relative path to the 'non-selected' icon
* @param vIconSelected {string} Relative path to the 'selected' icon
*
* @return The singleton itself, purely for convenience.
*/
qx.Proto.standard = function(vLabel, vIcon, vIconSelected)
{
this.newRow();
this.addIcon(vIcon, vIconSelected);
this.addLabel(vLabel);
return this;
}
qx.Proto.addIndent = function()
{
/* If the assumed indent object is in use... */
if (! this._indentAdded)
{
/* ... then remove it. */
this._fields.shift();
this._indentAdded = true;
}
else
{
throw new Error("Indent object added more than once.");
}
/* Add the indentation to the structure */
this._fields.push(this._indentObject);
}
qx.Proto.addIcon = function(vIcon, vIconSelected)
{
/* Ensure only one standard icon is added */
if (! this._iconAdded)
{
this._iconAdded = true;
}
else
{
throw new Error("Icon object added more than once.");
}
/* Track the two icon names */
this._icons.unselected = vIcon;
this._icons.selected = vIconSelected;
/* Add the icon to the structure */
this._fields.push(this._iconObject);
}
qx.Proto.addLabel = function(vLabel)
{
/* Ensure only one standard label is added */
if (! this._labelAdded)
{
this._labelAdded = true;
}
else
{
throw new Error("Label added more than once.");
}
/* Track the label text */
this._label = vLabel;
/* Add the label to the structure */
this._fields.push(this._labelObject);
}
/*
* Add an object to the tree row structure. For convenience, vAnonymous can
* be provided, and if a boolean value is provided, vObj.setAnonymous() is
* called with the provided value. If the object has already been
* setAnonymous or if there is no need to do so, then provide no value for
* vAnonymous or pass 'null'.
*/
qx.Proto.addObject = function(vObj, vAnonymous)
{
/* Is requested, set this object's anonymous state */
if (typeof vAnonymous == "boolean")
{
vObj.setAnonymous(vAnonymous);
}
/* Add this user-specified object to the structure */
this._fields.push(vObj);
}
/*
---------------------------------------------------------------------------
DEFER SINGLETON INSTANCE
---------------------------------------------------------------------------
*/
/**
* Singleton Instance Getter
*/
qx.Class.getInstance = qx.util.Return.returnInstance;
|
