f2c45a0ec77124016f09d52c3eb19e364334822b
[org.ibex.core.git] / src / org / xwt / Box.java.pp
1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
2 package org.xwt;
3
4 //     **** This file must be preprocessed before compilation ****
5
6 // RULE: coordinates on non-static methods are ALWAYS relative to the
7 // upper-left hand corner of <tt>this</tt>
8
9 // FEATURE: reflow before allowing js to read from width/height 
10 // FEATURE: fastpath for rows=1/cols=1
11 // FEATURE: reflow starting with a certain child
12 // FEATURE: separate mark_for_reflow and mark_for_resize
13
14 import java.io.*;
15 import java.net.*;
16 import java.util.*;
17 import org.xwt.js.*;
18 import org.xwt.util.*;
19 import org.xwt.translators.*;
20
21 /**
22  *  <p>
23  *  Encapsulates the data for a single XWT box as well as all layout
24  *  rendering logic.
25  *  </p>
26  *
27  *  <p>
28  *  This is the real meat of XWT. Part of its monolithic design is for
29  *  performance reasons: deep inheritance heirarchies are slow, and
30  *  neither javago nor GCJ can inline across class boundaries.
31  *  </p>
32  *
33  *  <p>The rendering process consists of three phases; each requires
34  *     one DFS pass over the tree</p>
35  *
36  *  <ol><li> <b>repacking</b>: children of a box are packed into columns
37  *           and rows according to their colspan/rowspan attributes and
38  *           ordering.  Minimum and maximum sizes of columns are computed.
39  *
40  *      <li> <b>resizing</b>: width/height and x/y positions of children
41  *           are assigned.  If a PosChange or SizeChange is triggered,
42  *           <tt>Surface.abort</tt> will be set and the resizing process will
43  *           Surface.abort.
44  *
45  *      <li> <b>repainting</b>: children draw their content onto the
46  *           buffer.
47  *  </ol>
48  *
49  *  The first two passes together are called the <i>reflow</i> phase.
50  *
51  *  Reflowing is done in a seperate pass since PosChanges and
52  *  SizeChanges trigger an Surface.abort; if rendering were done in the same
53  *  pass, rendering work done prior to the Surface.abort would be wasted.
54  *
55  *  The two passes are repack and resize.  Together they are known as
56  *  reflow.  Repacking assigns boxes to the appropriate grid
57  *  coordinates within the parents and computes
58  *  contentwidth/contentheight.  Resize computes actual size and
59  *  position.
60  *
61  *  A note on coordinates: the Box class represents regions
62  *  internally as x,y,w,h tuples, even though the PixelBuffer class
63  *  uses x1,y1,x2,y2 tuples.
64  */
65 public final class Box extends JS.Scope {
66
67     public Box() { super(null); }
68
69
70     // Misc instance data ////////////////////////////////////////////////////////////////
71
72     static int sizePosChangesSinceLastRender = 0;
73
74
75     // Misc instance data ////////////////////////////////////////////////////////////////
76
77     boolean needs_reflow = true;         
78     //#define MARK_FOR_REFLOW_this for(Box b2 = this; b2 != null && !b2.needs_reflow; b2 = b2.parent) b2.needs_reflow = true;
79     //#define MARK_FOR_REFLOW_b for(Box b2 = b; b2 != null && !b2.needs_reflow; b2 = b2.parent) b2.needs_reflow = true;
80     //#define MARK_FOR_REFLOW_b_parent for(Box b2 = b.parent; b2 != null && !b2.needs_reflow; b2 = b2.parent) b2.needs_reflow = true;
81
82     Box redirect = this;
83     Surface surface = null;               // null on all non-root boxen
84
85     // Flags ///////////////////////////////////////////////////////////////////////////////
86     short flags = 0;
87     static int MOUSEINSIDE_FLAG  = 0x00000001;
88     static int INVISIBLE_FLAG    = 0x00000002;
89     static int ABSOLUTE_FLAG     = 0x00000004;
90     static int HSHRINK_FLAG      = 0x00000008;
91     static int VSHRINK_FLAG      = 0x00000010;
92     static int TILE_FLAG         = 0x00000020;
93     static int FONT_CHANGED_FLAG = 0x00000040;  // set when font changes, cleared during repack
94     static int ISROOT_FLAG       = 0x00000080;
95
96
97     // Geometry ////////////////////////////////////////////////////////////////////////////
98
99     // xwt can be compiled with 16-bit lengths to save memory on small devices
100     //#define LENGTH int
101     //#define MAX_LENGTH Integer.MAX_VALUE
102     //#define MIN_LENGTH Integer.MIN_VALUE
103
104     // always correct (set directly by user)
105     public LENGTH minwidth = 0;        
106     public LENGTH minheight = 0;        
107     public LENGTH maxwidth = MAX_LENGTH;
108     public LENGTH maxheight = MAX_LENGTH;
109     private LENGTH hpad = 0;
110     private LENGTH vpad = 0;
111     private String text = null;
112     private Res font = null;
113     private int fontsize = 10;
114     private LENGTH textwidth = 0;
115     private LENGTH textheight = 0;
116
117     // FEATURE: use shorts
118     private int rows = 1;
119     private int cols = 0;
120     private int rowspan = 1;
121     private int colspan = 1;
122
123     // computed during reflow
124     public LENGTH x = 0;
125     public LENGTH y = 0;
126     public LENGTH width = 0;
127     public LENGTH height = 0;
128     private int row = 0;  // FEATURE use a short
129     private int col = 0;  // FEATURE use a short
130     private LENGTH contentwidth = 0;             // == max(minwidth, textwidth+pad, sum(child.contentwidth) + pad)
131     private LENGTH contentheight = 0;
132
133
134     // Rendering Properties ///////////////////////////////////////////////////////////
135
136     //private SVG.VP path = null;
137     //private SVG.Paint fill = null;
138     //private SVG.Paint stroke = null;
139
140     public Picture image;                        // will disappear
141     private int fillcolor = 0x00000000;          // will become SVG.Paint
142     private int strokecolor = 0xFF000000;        // will become SVG.Paint
143
144     private String cursor = null;                // the cursor for this box
145
146
147     // Instance Methods /////////////////////////////////////////////////////////////////////
148
149     /** Adds the intersection of (x,y,w,h) and the node's current actual geometry to the Surface's dirty list */
150     public final void dirty() { dirty(0, 0, width, height); }
151     public final void dirty(int x, int y, int w, int h) {
152         for(Box cur = this; cur != null; cur = cur.parent) {
153             w = min(x + w, cur.width) - max(x, 0);
154             h = min(y + h, cur.height) - max(y, 0);
155             x = max(x, 0);
156             y = max(y, 0);
157             if (w <= 0 || h <= 0) return;
158             if (cur.parent == null && cur.surface != null) cur.surface.dirty(x, y, w, h);
159             x += cur.x;
160             y += cur.y;
161         }
162     }
163
164     /**
165      *  Given an old and new mouse position, this will update <tt>mouseinside</tt> and check
166      *  to see if this node requires any Enter, Leave, or Move notifications.
167      *
168      *  @param forceleave set to true by the box's parent if the mouse is inside an older
169      *                    sibling, which is covering up this box.
170      */
171     void Move(int oldmousex, int oldmousey, int mousex, int mousey) { Move(oldmousex, oldmousey, mousex, mousey, false); }
172     void Move(int oldmousex, int oldmousey, int mousex, int mousey, boolean forceleave) {
173
174         boolean wasinside = (flags & MOUSEINSIDE_FLAG) != 0;
175         boolean isinside = !((flags & INVISIBLE_FLAG) != 0) && inside(mousex, mousey) && !forceleave;
176         if (isinside) flags |= MOUSEINSIDE_FLAG; else flags &= ~MOUSEINSIDE_FLAG;
177
178         if (!wasinside && !isinside) return;
179
180         if (!wasinside && isinside && get("Enter", Trap.class) != null) put("Enter", Boolean.TRUE);
181         else if (wasinside && !isinside && get("Leave", Trap.class) != null) put("Leave", Boolean.TRUE);
182         else if (wasinside && isinside && (mousex != oldmousex || mousey != oldmousey) && get("Move", Trap.class) != null)
183             put("Move", Boolean.TRUE);
184
185         if (isinside && cursor != null) getRoot().cursor = cursor;
186
187         // if the mouse has moved into our padding region, it is considered 'outside' all our children
188         if (!(mousex >= hpad && mousey >= vpad && mousex < width - hpad && mousey < height + vpad)) forceleave = true;
189
190         for(Box b = getChild(numChildren() - 1); b != null; b = b.prevSibling()) {
191             b.Move(oldmousex - b.x, oldmousey - b.y, mousex - b.x, mousey - b.y, forceleave);
192             if (b.inside(mousex - b.x, mousey - b.y)) forceleave = true;
193         }
194     }
195
196
197     // Reflow ////////////////////////////////////////////////////////////////////////////////////////
198
199     void reflow() { reflow(width, height); }
200     void reflow(int new_width, int new_height) {
201         repack();
202         if (Surface.abort) return;
203         resize(x, y, new_width, new_height);
204     }
205
206     /** Checks if the Box's size has changed, dirties it if necessary, and makes sure childrens' sizes are up to date */
207     void repack() {
208         if (!needs_reflow) return;
209         if (numChildren() == 0) {
210             contentwidth = max(textwidth + 2 * hpad, minwidth);
211             contentheight = max(textheight + 2 * vpad, minheight);
212             return;
213         }
214
215         // --- Phase 0 ----------------------------------------------------------------------
216         // recurse
217         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
218             if (((flags & FONT_CHANGED_FLAG) != 0) && child.font == null) {
219                 child.flags |= FONT_CHANGED_FLAG;
220                 child.needs_reflow = true;
221             }
222             child.repack();
223             if (Surface.abort) { MARK_FOR_REFLOW_this; return; }
224         }
225         flags &= ~FONT_CHANGED_FLAG;
226
227         // --- Phase 1 ----------------------------------------------------------------------
228         // assign children to their row/column positions (assuming constrained columns)
229         if ((rows == 0 && cols == 0) || (rows != 0 && cols != 0)) throw new Error("rows == " + rows + "   cols == " + cols);
230         //#repeat x/y y/x width/height col/row row/col cols/rows rows/cols colspan/rowspan rowspan/colspan colWidth/rowHeight numRowsInCol/numColsInRow INNER/INNER2 maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight OUTER/OUTER2 INNER/INNER2
231         if (rows == 0) {
232             int[] numRowsInCol = new int[cols];           // the number of cells occupied in each column
233             Box child = getChild(0);
234             for(; child != null && (((child.flags & ABSOLUTE_FLAG) != 0) || ((child.flags & INVISIBLE_FLAG) != 0)); child = child.nextSibling());
235             OUTER: for(int row=0; child != null; row++) {
236                 for(int col=0; child != null && col < cols;) {
237                     INNER: while(true) {  // scan across the row, looking for an unoccupied gap at least as wide as the child
238                         while(col < cols && numRowsInCol[col] > row) col++;
239                         for(int i=col; i < cols && i < col + min(cols, child.colspan); i++)
240                             if (numRowsInCol[col] > row) { col = i + 1; continue INNER; }
241                         break;
242                     }
243                     if (col + min(cols, child.colspan) > cols) break;
244                     for(int i=col; i < col + min(cols, child.colspan); i++) numRowsInCol[i] += child.rowspan;
245                     child.col = col;
246                     child.row = row;
247                     col += min(cols, child.colspan);
248                     child = child.nextSibling();
249                     for(; child != null && (((child.flags & ABSOLUTE_FLAG) != 0) || ((child.flags & INVISIBLE_FLAG) != 0)); child = child.nextSibling());
250                 }
251             }
252         }
253         //#end
254
255         // --- Phase 2 ----------------------------------------------------------------------
256         // compute the min/max sizes of the columns and rows and set our contentwidth
257         //#repeat x/y y/x width/height col/row cols/rows colspan/rowspan colWidth/rowHeight maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight numCols/numRows hpad/vpad
258         contentwidth = 2 * hpad;
259         int numCols = cols;
260         if (numCols == 0)
261             for(Box child = getChild(0); child != null; child = child.nextSibling())
262                 numCols = max(numCols, child.col + child.colspan);
263         LENGTH[] colWidth = new LENGTH[numCols];
264         for(Box child = getChild(0); child != null; child = child.nextSibling())
265             if (!(((child.flags & ABSOLUTE_FLAG) != 0) || ((child.flags & INVISIBLE_FLAG) != 0)))
266                 colWidth[child.col] = max(colWidth[child.col], child.contentwidth / child.colspan);
267         for(int col=0; col<numCols; col++) contentwidth += colWidth[col];
268         contentwidth = max(textwidth + 2 * hpad, contentwidth);
269         contentwidth = bound(minwidth, contentwidth, maxwidth);
270         //#end
271     }
272
273
274     private void resize(LENGTH x, LENGTH y, LENGTH width, LENGTH height) {
275         
276         // --- Phase 1 ----------------------------------------------------------------------
277         // run PosChange/SizeChange, dirty as needed
278         if (x != this.x || y != this.y || width != this.width || height != this.height) {
279             (parent == null ? this : parent).dirty(this.x, this.y, this.width, this.height);
280             boolean sizechange = false, poschange = false;
281             if ((this.width != width || this.height != height) && get("SizeChange", Trap.class) != null) sizechange = true;
282             if ((this.x != x || this.y != y) && get("PosChange", Trap.class) != null) poschange = true;
283             this.width = width; this.height = height; this.x = x; this.y = y;
284             dirty();
285             if (sizechange || poschange)
286                 if (sizePosChangesSinceLastRender == 500) {
287                     if (Log.on) Log.logJS(this, "Warning, more than 500 SizeChange/PosChange traps triggered since last complete render");
288                 } else {
289                     sizePosChangesSinceLastRender++;
290                     try { if (sizechange) put("SizeChange", Boolean.TRUE); } catch (Exception e) { Log.log(this, e); }
291                     try { if (poschange) put("PosChange", Boolean.TRUE); } catch (Exception e) { Log.log(this, e); }
292                     Surface.abort = true;
293                     return;
294                 }
295             needs_reflow = true;
296         }
297
298         // --- short circuit ----------------------------------------------------------------
299         if (!needs_reflow) return;
300         needs_reflow = false;
301         if (numChildren() == 0) return;
302
303         // --- Phase 2 ----------------------------------------------------------------------
304         // compute the min/max sizes of the columns and rows and set initial width/height to minimums
305
306         //#repeat x/y y/x width/height col/row cols/rows colspan/rowspan colWidth/rowHeight maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight marginWidth/marginHeight numCols/numRows
307         int numCols = cols;
308         if (numCols == 0)
309             for(Box child = getChild(0); child != null; child = child.nextSibling())
310                 numCols = max(numCols, child.col + child.colspan);
311         LENGTH[] colWidth = new LENGTH[numCols];
312         LENGTH[] colMaxWidth = new LENGTH[numCols];
313         int marginWidth = width;
314         for(int i=0; i<colMaxWidth.length; i++) colMaxWidth[i] = -1;
315         //#end
316
317         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
318             if (((child.flags & ABSOLUTE_FLAG) != 0) || ((child.flags & INVISIBLE_FLAG) != 0)) continue;
319             //#repeat x/y y/x width/height col/row cols/rows colspan/rowspan colWidth/rowHeight maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight HSHRINK_FLAG/VSHRINK_FLAG numCols/numRows
320             colWidth[child.col] = max(colWidth[child.col], child.contentwidth / child.colspan);
321             for(int i=child.col; i<child.col+child.colspan && i<numCols; i++)
322                 colMaxWidth[i] = max(colMaxWidth[i], (((child.flags & HSHRINK_FLAG) != 0) ? child.contentwidth : child.maxwidth) / child.colspan);
323             //#end
324         }
325
326         //#repeat x/y y/x width/height col/row cols/rows colspan/rowspan colWidth/rowHeight maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight marginWidth/marginHeight
327         for(int i=0; i<colMaxWidth.length; i++) if (colMaxWidth[i] == -1) colMaxWidth[i] = MAX_LENGTH;
328
329         for(int i=0; i<colMaxWidth.length; i++) {
330             if (colMaxWidth[i] == MAX_LENGTH) { marginWidth = 0; break; }
331             marginWidth -= colMaxWidth[i];
332             if (marginWidth < 0) { marginWidth = 0; break; }
333         }
334         //#end
335       
336
337         // --- Phase 3 ----------------------------------------------------------------------
338         // hand out the slack
339         int slack;
340         //#repeat x/y y/x width/height col/row cols/rows colspan/rowspan colWidth/rowHeight maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight numCols/numRows hpad/vpad
341         slack = width - 2 * hpad;
342         for(int i=0; i<numCols; i++) slack -= colWidth[i];
343         if (numChildren() > 0)
344             while(slack > 0) {  
345                 // FEATURE: inefficient
346                 int startslack = slack;
347                 int increment = max(1, slack / numCols);
348                 for(int col=0; col < numCols && slack > 0; col++) {
349                     slack += colWidth[col];
350                     colWidth[col] = min(colMaxWidth[col], colWidth[col] + increment);
351                     slack -= colWidth[col];
352                 }
353                 if (slack == startslack) break;
354             }   
355         //#end
356
357
358         // --- Phase 4 ----------------------------------------------------------------------
359         // assign children's new sizes and positions and recurse
360         for(Box child = getChild(0); child != null; child = child.nextSibling()) {
361             if ((child.flags & INVISIBLE_FLAG) != 0) continue;
362             int child_x = 0, child_y = 0, child_width = 0, child_height = 0;
363             if ((child.flags & ABSOLUTE_FLAG) != 0) {
364                 child_x = child.x;
365                 child_y = child.y;
366                 child_width = ((child.flags & HSHRINK_FLAG) != 0) ? child.contentwidth : min(child.maxwidth, width - child.x - hpad);
367                 child_height = ((child.flags & VSHRINK_FLAG) != 0) ? child.contentheight : min(child.maxheight, height - child.y - vpad);
368             } else {
369                 int diff;
370                 //#repeat x/y y/x width/height col/row cols/rows colspan/rowspan colWidth/rowHeight maxwidth/maxheight minwidth/minheight contentwidth/contentheight colMaxWidth/rowMaxHeight HSHRINK_FLAG/VSHRINK_FLAG marginWidth/marginHeight hpad/vpad child_x/child_y child_width/child_height
371                 child_width = 0; for(int i=child.col; i<child.col+child.colspan && i<colWidth.length; i++) child_width += colWidth[i];
372                 diff = bound(child.contentwidth, child_width, ((child.flags & HSHRINK_FLAG) != 0) ? child.contentwidth : child.maxwidth) - child_width;
373                 child_x = max(hpad, marginWidth / 2); for(int i=0; i<child.col; i++) child_x += colWidth[i];
374                 if (diff < 0) child_x += -1 * (diff / 2);
375                 child_width += diff;
376                 //#end
377             }
378             child.resize(child_x, child_y, child_width, child_height);
379         }
380     }
381
382
383
384
385     // Rendering Pipeline /////////////////////////////////////////////////////////////////////
386
387     /** Renders self and children within the specified region. All rendering operations are clipped to xIn,yIn,wIn,hIn */
388     void render(int parentx, int parenty, int clipx, int clipy, int clipw, int cliph, PixelBuffer buf) {
389         if (Surface.abort || (flags & INVISIBLE_FLAG) != 0) return;
390         int globalx = parentx + (parent == null ? 0 : x);
391         int globaly = parenty + (parent == null ? 0 : y);
392
393         // intersect the x,y,w,h rendering window with ourselves; quit if it's empty
394         clipw = min(max(clipx, parent == null ? 0 : globalx) + clipw, (parent == null ? 0 : globalx) + width) - globalx;
395         cliph = min(max(clipy, parent == null ? 0 : globaly) + cliph, (parent == null ? 0 : globaly) + height) - globaly;
396         clipx = max(clipx, parent == null ? 0 : globalx);
397         clipy = max(clipy, parent == null ? 0 : globaly);
398         if (clipw <= 0 || cliph <= 0) return;
399
400         if ((fillcolor & 0xFF000000) != 0x00000000)
401             buf.fillRect(clipx, clipy, clipx + clipw, clipy + cliph, fillcolor);
402
403         if (image != null)
404             if ((flags & TILE_FLAG) != 0) renderTiledImage(globalx, globaly, clipx, clipy, clipw, cliph, buf);
405             else renderStretchedImage(globalx, globaly, clipx, clipy, clipw, cliph, buf);
406
407         if (text != null && !text.equals(""))
408             renderText(globalx, globaly, clipx, clipy, clipw, cliph, buf);
409
410         // now subtract the pad region from the clip region before proceeding
411         clipw = min(max(clipx, globalx + hpad) + clipw, globalx + width - hpad) - clipx;
412         cliph = min(max(clipy, globaly + vpad) + cliph, globaly + height - vpad) - clipy;
413         clipx = max(clipx, globalx + hpad);
414         clipy = max(clipy, globaly + vpad);
415
416         for(Box b = getChild(0); b != null; b = b.nextSibling())
417             b.render(globalx, globaly, clipx, clipy, clipw, cliph, buf);   
418     }
419
420     void renderStretchedImage(int globalx, int globaly, int clipx, int clipy, int clipw, int cliph, PixelBuffer buf) {
421         // FIXME: wrong
422         buf.drawPicture(image, clipx, clipy, clipx + clipw, clipy + cliph, 0, 0, image.getWidth(), image.getHeight());
423     }
424
425     void renderTiledImage(int globalx, int globaly, int x, int y, int w, int h, PixelBuffer buf) {
426         int iw = image.getWidth();
427         int ih = image.getHeight();
428         for(int i=(x - x)/iw; i <= (x + w - x)/iw; i++) {
429             for(int j=(y - y)/ih; j<= (y + h - y)/ih; j++) {
430                 
431                 int dx1 = max(i * iw + x, x);
432                 int dy1 = max(j * ih + y, y);
433                 int dx2 = min((i+1) * iw + x, x + w);
434                 int dy2 = min((j+1) * ih + y, y + h);
435                 
436                 int sx1 = dx1 - (i*iw) - x;
437                 int sy1 = dy1 - (j*ih) - y;
438                 int sx2 = dx2 - (i*iw) - x;
439                 int sy2 = dy2 - (j*ih) - y;
440
441                 if (dx2 - dx1 > 0 && dy2 - dy1 > 0 && sx2 - sx1 > 0 && sy2 - sy1 > 0)
442                     buf.drawPicture(image, dx1, dy1, dx2, dy2, sx1, sy1, sx2, sy2);
443             }
444         }
445     }
446
447     void renderText(int x, int y, int clipx, int clipy, int clipw, int cliph, PixelBuffer buf) {
448         for(int i=0; i<text.length(); i++) {
449             // FIXME: clipping
450             char c = text.charAt(i);
451             Glyph g = Glyph.getGlyph(font, fontsize, c);
452             buf.drawPicture(g.p,
453                             x + hpad,
454                             y + vpad + g.max_ascent - g.baseline,
455                             x + hpad + g.p.getWidth(),
456                             y + vpad + g.max_ascent - g.baseline + g.p.getHeight(),
457                             0, 0,
458                             g.p.getWidth(), g.p.getHeight());
459             x += g.advance;
460         }
461     }
462
463
464     // Methods to implement org.xwt.js.JS //////////////////////////////////////
465
466     public Object callMethod(Object method, JS.Array args, boolean checkOnly) throws JS.Exn {
467         if ("indexof".equals(method)) {
468             if (checkOnly) return Boolean.TRUE;
469             if (args.length() != 1 || args.elementAt(0) == null || !(args.elementAt(0) instanceof Box)) return new Integer(-1);
470             Box b = (Box)args.elementAt(0);
471             if (b.parent != Box.this) {
472                 if (redirect == null || redirect == Box.this) return new Integer(-1);
473                 return redirect.callMethod(method, args, checkOnly);
474             }
475             return new Integer(b.getIndexInParent());
476         }
477         return null;
478     }
479
480     /** Returns the i_th child */
481     public Object get(int i) {
482         if (redirect == null) return null;
483         if (redirect != this) return redirect.get(i);
484         return i >= numChildren() || i < 0 ? null : getChild(i);
485     }
486
487     /**
488      *  Inserts value as child i; calls remove() if necessary.
489      *  This method handles "reinserting" one of your children properly.
490      *  INVARIANT: after completion, getChild(min(i, numChildren())) == newnode
491      *  WARNING: O(n) runtime, unless i == numChildren()
492      */
493     public void put(int i, Object value) {
494         if (i < 0) return;
495
496         if (value != null && !(value instanceof Box)) {
497             if (Log.on) Log.logJS(this, "attempt to set a numerical property on a box to anything other than a box");
498         } else if (redirect == null) {
499             if (Log.on) Log.logJS(this, "attempt to add/remove children to/from a node with a null redirect");
500         } else if (redirect != this) {
501             Box b = value == null ? (Box)redirect.get(i) : (Box)value;
502             redirect.put(i, value);
503             put("0", b);
504         } else if (value == null) {
505             if (i >= 0 && i < numChildren()) {
506                 Box b = getChild(i);
507                 b.remove();
508                 put("0", b);
509             }
510         } else {
511             Box newnode = (Box)value;
512
513             // check if box being moved is currently target of a redirect
514             for(Box cur = newnode.parent; cur != null; cur = cur.parent)
515                 if (cur.redirect == newnode) {
516                     if (Log.on) Log.logJS(this, "attempt to move a box that is the target of a redirect");
517                     return;
518                 }
519
520             // check for recursive ancestor violation
521             for(Box cur = this; cur != null; cur = cur.parent)
522                 if (cur == newnode) {
523                     if (Log.on) Log.logJS(this, "attempt to make a node a parent of its own ancestor");
524                     if (Log.on) Log.log(this, "box == " + this + "  ancestor == " + newnode);
525                     return;
526                 }
527
528             if (numKids > 15 && children == null) convert_to_array();
529             newnode.remove();
530             newnode.parent = this;
531             
532             if (children == null) {
533                 if (firstKid == null) {
534                     firstKid = newnode;
535                     newnode.prevSibling = newnode;
536                     newnode.nextSibling = newnode;
537                 } else if (i >= numKids) {
538                     newnode.prevSibling = firstKid.prevSibling;
539                     newnode.nextSibling = firstKid;
540                     firstKid.prevSibling.nextSibling = newnode;
541                     firstKid.prevSibling = newnode;
542                 } else {
543                     Box cur = firstKid;
544                     for(int j=0; j<i; j++) cur = cur.nextSibling;
545                     newnode.prevSibling = cur.prevSibling;
546                     newnode.nextSibling = cur;
547                     cur.prevSibling.nextSibling = newnode;
548                     cur.prevSibling = newnode;
549                     if (i == 0) firstKid = newnode;
550                 }
551                 numKids++;
552                 
553             } else {
554                 if (i >= children.size()) {
555                     newnode.indexInParent = children.size();
556                     children.addElement(newnode);
557                 } else {
558                     children.insertElementAt(newnode, i);
559                     for(int j=i; j<children.size(); j++)
560                         getChild(j).indexInParent = j;
561                 }
562             }
563             
564             // need both of these in case child was already uncalc'ed
565             Box b = newnode; 
566             MARK_FOR_REFLOW_b;
567             MARK_FOR_REFLOW_this;
568             
569             newnode.dirty();
570
571             // note that JavaScript box[0] will invoke put(int i), not put(String s)
572             put("0", newnode);
573         }
574     }
575     
576     public Object get(Object key, Object key2) { return super.get(key, key2); }
577     public void put(Object key, Object key2, Object val) { super.put(key, key2, val); }
578
579     public Object get_(Object name) { return super.get(name); }
580     public Object get(Object name) { return get(name, false); }
581     public Object get(Object name_, boolean ignoretraps) {
582         if (name_ instanceof Number) return get(((Number)name_).intValue());
583
584         if (!(name_ instanceof String)) return null;
585         String name = (String)name_;
586         if (name.equals("")) return null;
587
588         // See if we're triggering a trap
589         Trap t = ignoretraps ? (Trap)null : (Trap)get(name, Trap.class);
590         if (t != null) return t.perform();
591
592         // Check for a special handler
593         SpecialBoxProperty gph = (SpecialBoxProperty)SpecialBoxProperty.specialBoxProperties.get(name);
594         if (gph != null) return gph.get(this);
595
596         Object ret = super.get(name);
597         if (name.startsWith("$") && ret == null)
598             if (Log.on) Log.logJS(this, "WARNING: attempt to access " + name + ", but no child with id=\"" +
599                                   name.substring(1) + "\" found");
600         return ret;
601     }
602
603     public Object[] keys() {
604         Object[] ret = new Object[numChildren()];
605         for(int i=0; i<ret.length; i++) ret[i] = new Integer(i);
606         return ret;
607     }
608
609     public void addTrap(Object name, Object value) { Trap.addTrap(this, name, ((JS.CompiledFunction)value)); }
610     public void delTrap(Object name, Object value) { Trap.delTrap(this, name, ((JS.CompiledFunction)value)); }
611
612
613     /**
614      *  Scriptable.put()
615      *  @param ignoretraps if set, no traps will be triggered (set when 'cascade' reaches the bottom of the trap stack)
616      *  @param rp if this put is being performed via a root proxy, rp is the root proxy.
617      */
618     public void put_(Object name, Object value) { super.put(name, value); }
619     public void put(Object name, Object value) { put(name, value, false); }
620     public void put(Object name_, Object value, boolean ignoretraps) {
621         if (name_ instanceof Number) { put(((Number)name_).intValue(), value); return; }
622         if (!(name_ instanceof String)) { super.put(name_,value); return; }
623         String name = name_.toString();
624         if (!ignoretraps) {
625             Trap t = (Trap)get(name, Trap.class);
626             if (t != null) {
627                 t.perform(value);
628                 return;
629             }
630         }
631
632         // don't want to really cascade down to the box on this one
633         if (name.equals("0")) return;
634
635         SpecialBoxProperty gph = (SpecialBoxProperty)SpecialBoxProperty.specialBoxProperties.get(name);
636         if (gph != null) { gph.put(name, this, value); return; }
637
638         super.put(name, value);
639     }
640
641
642     // Tree Manipulation /////////////////////////////////////////////////////////////////////
643
644     /** The parent of this node */
645     private Box parent = null;
646     
647     // Variables used in Vector mode */
648     /** INVARIANT: if (parent != null) parent.children.elementAt(indexInParent) == this */
649     private int indexInParent;
650     private Vec children = null;
651
652     // Variables used in linked-list mode
653     private int numKids = 0;
654     private Box nextSibling = null;
655     private Box prevSibling = null;
656     private Box firstKid = null;
657     
658     // when we get more than 15 children, we switch to array-mode
659     private void convert_to_array() {
660         children = new Vec(numKids);
661         Box cur = firstKid;
662         do {
663             children.addElement(cur);
664             cur.indexInParent = children.size() - 1;
665             cur = cur.nextSibling;
666         } while (cur != firstKid);
667     }
668     
669     /** remove this node from its parent; INVARIANT: whenever the parent of a node is changed, remove() gets called. */
670     public void remove() {
671         if (parent == null) {
672             if (surface != null) surface.dispose(true);
673             return;
674         }
675         Box oldparent = parent;
676         if (oldparent == null) return;
677         MARK_FOR_REFLOW_this;
678         dirty();
679         flags &= ~MOUSEINSIDE_FLAG;
680
681         if (parent.children != null) {
682             parent.children.removeElementAt(indexInParent);
683             for(int j=indexInParent; j<parent.children.size(); j++)
684                 (parent.getChild(j)).indexInParent = j;
685
686         } else {
687             if (parent.firstKid == this) {
688                 if (nextSibling == this) parent.firstKid = null;
689                 else parent.firstKid = nextSibling;
690             }
691             parent.numKids--;
692             prevSibling.nextSibling = nextSibling;
693             nextSibling.prevSibling = prevSibling;
694             prevSibling = null;
695             nextSibling = null;
696         }
697         parent = null;
698
699         if (oldparent != null) { Box b = oldparent; MARK_FOR_REFLOW_b; }
700
701         // note that JavaScript box[0] will invoke put(int i), not put(String s)
702         if (oldparent != null) oldparent.put("0", this);
703     }
704
705     /** returns our next sibling (parent[ourindex + 1]) */
706     public final Box nextSibling() {
707         if (parent == null) return null;
708         if (parent.children == null) {
709             if (nextSibling == parent.firstKid) return null;
710             return nextSibling;
711         } else {
712             if (indexInParent >= parent.children.size() - 1) return null;
713             return (Box)parent.children.elementAt(indexInParent + 1);
714         }
715     }
716     
717     /** returns our next sibling (parent[ourindex + 1]) */
718     public final Box prevSibling() {
719         if (parent == null) return null;
720         if (parent.children == null) {
721             if (this == parent.firstKid) return null;
722             return prevSibling;
723         } else {
724             if (indexInParent == 0) return null;
725             return (Box)parent.children.elementAt(indexInParent - 1);
726         }
727     }
728     
729     /** Returns the parent of this node */
730     public Box getParent() { return parent; }
731     
732     /** Returns ith child */
733     public Box getChild(int i) {
734         if (children == null) {
735             if (firstKid == null) return null;
736             if (i >= numKids) return null;
737             if (i == numKids - 1) return firstKid.prevSibling;
738             Box cur = firstKid;
739             for(int j=0; j<i; j++) cur = cur.nextSibling;
740             return cur;
741         } else {
742             if (i >= children.size() || i < 0) return null;
743             return (Box)children.elementAt(i);
744         }
745     }
746     
747     /** Returns the number of children */
748     public int numChildren() {
749         if (children == null) {
750             if (firstKid == null) return 0;
751             int i=1;
752             for(Box cur = firstKid.nextSibling; cur != firstKid; i++) cur = cur.nextSibling;
753             return i;
754         } else {
755             return children.size();
756         }
757     }
758     
759     /** Returns our index in our parent */
760     public int getIndexInParent() {
761         if (parent == null) return 0;
762         if (parent.children == null) {
763             int i = 0;
764             for(Box cur = this; cur != parent.firstKid; i++) cur = cur.prevSibling;
765             return i;
766         } else {
767             return indexInParent;
768         }
769     }
770
771     /** returns the root of the surface that this box belongs to */
772     public final Box getRoot() {
773         if (parent == null && surface != null) return this;
774         if (parent == null) return null;
775         return parent.getRoot();
776     }
777
778
779     // Trivial Helper Methods (should be inlined) /////////////////////////////////////////
780
781     static final int min(int a, int b) { if (a<b) return a; else return b; }
782     static final double min(double a, double b) { if (a<b) return a; else return b; }
783     static final int max(int a, int b) { if (a>b) return a; else return b; }
784     static final int min(int a, int b, int c) { if (a<=b && a<=c) return a; else if (b<=c && b<=a) return b; else return c; }
785     static final int max(int a, int b, int c) { if (a>=b && a>=c) return a; else if (b>=c && b>=a) return b; else return c; }
786     static final int bound(int a, int b, int c) { if (c < b) return c; if (a > b) return a; return b; }
787     final boolean inside(int x, int y) { return (!((flags & INVISIBLE_FLAG) != 0) && x >= 0 && y >= 0 && x < width && y < height); }
788     
789     /** figures out what box in this subtree of the Box owns the pixel at x,y relitave to the Surface */
790     public static Box whoIs(Box cur, int x, int y) {
791
792         if (cur.parent != null) throw new Error("whoIs may only be invoked on the root box of a surface");
793         int globalx = 0;
794         int globaly = 0;
795
796         // WARNING: this method is called from the event-queueing
797         // thread -- it may run concurrently with ANY part of XWT, and
798         // is UNSYNCHRONIZED for performance reasons.  BE CAREFUL
799         // HERE.
800
801         if ((cur.flags & INVISIBLE_FLAG) != 0) return null;
802         if (!cur.inside(x - globalx, y - globaly)) return cur.parent == null ? cur : null;
803         OUTER: while(true) {
804             for(int i=cur.numChildren() - 1; i>=0; i--) {
805                 Box child = cur.getChild(i);
806                 if (child == null) continue;        // since this method is unsynchronized, we have to double-check
807                 globalx += child.x;
808                 globaly += child.y;
809                 if (!((child.flags & INVISIBLE_FLAG) != 0) && child.inside(x - globalx, y - globaly)) { cur = child; continue OUTER; }
810                 globalx -= child.x;
811                 globaly -= child.y;
812             }
813             break;
814         }
815         return cur;
816     }
817
818     /** 
819      *  A helper class for properties of Box which require special
820      *  handling.
821      *
822      *  To avoid excessive use of String.equals(), the Box.get() and
823      *  Box.put() methods employ a Hash keyed on property names that
824      *  require special handling. The value stored in the Hash is an
825      *  instance of an anonymous subclass of SpecialBoxProperty, which knows
826      *  how to handle get()s and put()s for that property name. There
827      *  should be one anonymous subclass of SpecialBoxProperty for each
828      *  specially-handled property on Box.
829      */
830     static class SpecialBoxProperty {
831
832         SpecialBoxProperty() { }
833
834         /** stores instances of SpecialBoxProperty; keyed on property name */
835         static Hash specialBoxProperties = new Hash(200, 3);
836
837         /** this method defines the behavior when the property is get()ed from b */
838         Object get(Box b) { return null; }
839
840         /** this method defines the behavior when the property is put() to b */
841         void put(Box b, Object value) { }
842
843         /** this method defines the behavior when the property is put() to b, allows a single SpecialBoxProperty to serve multiple properties */
844         void put(String name, Box b, Object value) { put(b, value); }
845
846         static {
847             //#repeat fillcolor/strokecolor
848             specialBoxProperties.put("fillcolor", new SpecialBoxProperty() {
849                     public Object get(Box b) {
850                         if ((b.fillcolor & 0xFF000000) == 0) return null;
851                         String red = Integer.toHexString((b.fillcolor & 0x00FF0000) >> 16);
852                         String green = Integer.toHexString((b.fillcolor & 0x0000FF00) >> 8);
853                         String blue = Integer.toHexString(b.fillcolor & 0x000000FF);
854                         if (red.length() < 2) red = "0" + red;
855                         if (blue.length() < 2) blue = "0" + blue;
856                         if (green.length() < 2) green = "0" + green;
857                         return "#" + red + green + blue;
858                     }
859                     public void put(Box b, Object value) {
860                         int newcolor = b.fillcolor;
861                         String s = value == null ? null : value.toString();
862                         if (value == null) newcolor = 0x00000000;
863                         else if (s.length() > 0 && s.charAt(0) == '#')
864                             try {
865                                 newcolor = 0xFF000000 |
866                                     (Integer.parseInt(s.substring(1, 3), 16) << 16) |
867                                     (Integer.parseInt(s.substring(3, 5), 16) << 8) |
868                                     Integer.parseInt(s.substring(5, 7), 16);
869                             } catch (NumberFormatException e) {
870                                 Log.log(this, "invalid color " + s);
871                                 return;
872                             }
873                         else if (org.xwt.translators.SVG.colors.get(s) != null)
874                             newcolor = 0xFF000000 | ((Integer)org.xwt.translators.SVG.colors.get(s)).intValue();
875                         if (newcolor == b.fillcolor) return;
876                         b.fillcolor = newcolor;
877                         b.dirty();
878                     }
879                 });
880             //#end
881         
882             specialBoxProperties.put("color", new SpecialBoxProperty() {
883                     public Object get(Box b) { return b.get("fillcolor"); }
884                     public void put(Box b, Object value) { b.put("fillcolor", value); }
885                 });
886
887             specialBoxProperties.put("textcolor", new SpecialBoxProperty() {
888                     public Object get(Box b) { return b.get("strokecolor"); }
889                     public void put(Box b, Object value) { b.put("strokecolor", value); }
890                 });
891
892             specialBoxProperties.put("text", new SpecialBoxProperty() {
893                     public Object get(Box b) { return b.text; }
894                     public void put(Box b, Object value) {
895                         String t = value == null ? "null" : value.toString();
896                         if (t.equals(b.text)) return;
897                         b.text = t;
898                         if (t == null) {
899                             if (b.textwidth != 0 || b.textheight != 0) MARK_FOR_REFLOW_b;
900                             b.textwidth = b.textheight = 0;
901                         } else {
902                             try {
903                                 MARK_FOR_REFLOW_b;
904                                 b.textwidth = 0;
905                                 for(int i=0; i<b.text.length(); i++) {
906                                     Glyph g = Glyph.getGlyph(b.font, b.fontsize, b.text.charAt(i));
907                                     b.textwidth += g.advance;
908                                     b.textheight = g.max_ascent + g.max_descent;
909                                 }
910                             } catch (Exception e) {
911                                 Log.log(this, e);
912                             }
913                         }
914                         b.dirty();
915                     } });
916
917             specialBoxProperties.put("font", new SpecialBoxProperty() {
918                     public Object get(Box b) { return b.font; }
919                     public void put(Box b, Object value) {
920                         // FIXME: translate value into a resource if it is a string
921                         b.font = value == null ? null : (Res)value;
922                         MARK_FOR_REFLOW_b;
923                         b.flags |= FONT_CHANGED_FLAG;
924                         b.dirty();
925                     } });
926         
927             specialBoxProperties.put("fontsize", new SpecialBoxProperty() {
928                     public Object get(Box b) { return b.font; }
929                     public void put(Box b, Object value) {
930                         if (b.fontsize == stoi(value)) return;
931                         b.fontsize = stoi(value);
932                         MARK_FOR_REFLOW_b;
933                         b.flags |= FONT_CHANGED_FLAG;
934                         b.dirty();
935                     } });
936         
937             specialBoxProperties.put("thisbox", new SpecialBoxProperty() {
938                     public Object get(Box b) { return b; }
939                     public void put(Box b, Object value) {
940                         if (value == null) b.remove();
941                         else if (value.equals("window") || value.equals("frame")) Platform.createSurface(b, value.equals("frame"), true);
942                         else if (Log.on) Log.log(this, "put invalid value to 'thisbox' property: " + value);
943                     }
944                 });
945
946             specialBoxProperties.put("orient", new SpecialBoxProperty() {
947                     public Object get(Box b) {
948                         Log.log(this, "warning: the orient property is deprecated");
949                         if (b.redirect == null) return "horizontal";
950                         else if (b.redirect != b) return get(b.redirect);
951                         else if (b.cols == 1) return "vertical";
952                         else if (b.rows == 1) return "horizontal";
953                         else return "grid";
954                     }
955                     public void put(Box b, Object value) {
956                         Log.log(this, "warning: the orient property is deprecated");
957                         if (value == null) return;
958                         if (b.redirect == null) return;
959                         if (b.redirect != b) { put(b.redirect, value); return; }
960                         if (value.equals("vertical")) {
961                             if (b.rows == 0) return;
962                             b.rows = 0; b.cols = 1;
963                         } else if (value.equals("horizontal")) {
964                             if (b.cols == 0) return;
965                             b.cols = 0; b.rows = 1;
966                         } else if (Log.on)
967                             Log.log(this, "invalid value put to orient property: " + value);
968                         MARK_FOR_REFLOW_b;
969                     } });
970
971             //FIXME
972             specialBoxProperties.put("static", new SpecialBoxProperty() {
973                 });
974
975             specialBoxProperties.put("shrink", new SpecialBoxProperty() {
976                     public Object get(Box b) { return (((b.flags & HSHRINK_FLAG) != 0) || ((b.flags & VSHRINK_FLAG) != 0)) ? Boolean.TRUE : Boolean.FALSE; }
977                     public void put(Box b, Object value) { b.put("hshrink", value); b.put("vshrink", value); }
978                 });
979         
980             //#repeat hshrink/vshrink HSHRINK_FLAG/VSHRINK_FLAG
981             specialBoxProperties.put("hshrink", new SpecialBoxProperty() {
982                     public Object get(Box b) { return new Boolean((b.flags & HSHRINK_FLAG) != 0); }
983                     public void put(Box b, Object value) {
984                         boolean newshrink = stob(value);
985                         if (((b.flags & HSHRINK_FLAG) != 0) == newshrink) return;
986                         if (newshrink) b.flags |= HSHRINK_FLAG; else b.flags &= ~HSHRINK_FLAG;
987                         MARK_FOR_REFLOW_b;
988                     }
989                 });
990             //#end
991         
992             //#repeat x/y
993             specialBoxProperties.put("x", new SpecialBoxProperty() {
994                     public Object get(Box b) {
995                         if (b.surface == null) return new Integer(0);
996                         if ((b.flags & INVISIBLE_FLAG) != 0) return new Integer(0);
997                         return new Integer(b.x);
998                     }
999                     public void put(Box b, Object value) {
1000                         if (!((b.flags & ABSOLUTE_FLAG) != 0)) return;
1001                         int x = stoi(value);
1002                         if (x == b.x) return;
1003                         b.dirty();
1004                         b.x = x;
1005                         if (b.parent == null && b.surface != null) b.surface.setLocation();
1006                         MARK_FOR_REFLOW_b;
1007                         b.dirty();
1008                     }
1009                 });
1010             //#end
1011         
1012             //#repeat width/height minwidth/minheight maxwidth/maxheight
1013             specialBoxProperties.put("width", new SpecialBoxProperty() {
1014                     public Object get(Box b) { return new Integer(b.width); }
1015                     public void put(Box b, Object value) {
1016                         b.width = stoi(value);
1017                         if (b.parent == null && b.surface != null) {
1018                             b.surface.setSize();
1019                             MARK_FOR_REFLOW_b;
1020                         } else {
1021                             if (b.minwidth == b.width && b.maxwidth == b.width) return;
1022                             b.minwidth = b.maxwidth = b.width;
1023                             MARK_FOR_REFLOW_b;
1024                         }
1025                     } });
1026             //#end
1027
1028             //#repeat cols/rows rows/cols
1029             specialBoxProperties.put("cols", new SpecialBoxProperty() {
1030                     public Object get(Box b) { return new Double(b.cols); }
1031                     public void put(Box b, Object value) {
1032                         if (b.cols == stoi(value)) return;
1033                         b.cols = stoi(value);
1034                         if (b.cols == 0 && b.rows == 0) b.rows = 1;
1035                         if (b.cols != 0 && b.rows != 0) b.rows = 0;
1036                         MARK_FOR_REFLOW_b;
1037                     } });
1038             //#end
1039         
1040             //#repeat colspan/rowspan
1041             specialBoxProperties.put("colspan", new SpecialBoxProperty() {
1042                     public Object get(Box b) { return new Double(b.colspan); }
1043                     public void put(Box b, Object value) {
1044                         if (b.colspan == stoi(value)) return;
1045                         b.colspan = stoi(value);
1046                         MARK_FOR_REFLOW_b;
1047                     }
1048                 });
1049             //#end
1050         
1051             specialBoxProperties.put("tile", new SpecialBoxProperty() {
1052                     public Object get(Box b) { return ((b.flags & TILE_FLAG) != 0) ? Boolean.TRUE : Boolean.FALSE; }
1053                     public void put(Box b, Object value) {
1054                         if (((b.flags & TILE_FLAG) != 0) == stob(value)) return;
1055                         if (stob(value)) b.flags |= TILE_FLAG; else b.flags &= ~TILE_FLAG;
1056                         b.dirty();
1057                     } });
1058         
1059             specialBoxProperties.put("invisible", new SpecialBoxProperty() {
1060                     public Object get(Box b) {
1061                         for (Box cur = b; cur != null; cur = cur.parent) {
1062                             if ((cur.flags & INVISIBLE_FLAG) != 0) return Boolean.TRUE; }
1063                         return Boolean.FALSE;
1064                     }
1065                     public void put(Box b, Object value) {
1066                         if (stob(value) == ((b.flags & INVISIBLE_FLAG) != 0)) return;
1067                         if (stob(value)) b.flags |= INVISIBLE_FLAG; else b.flags &= ~INVISIBLE_FLAG;
1068                         if (b.parent == null) {
1069                             if (b.surface != null) b.surface.setInvisible((b.flags & INVISIBLE_FLAG) != 0);
1070                         } else {
1071                             b.dirty();
1072                             MARK_FOR_REFLOW_b_parent;
1073                             b.parent.dirty(b.x, b.y, b.width, b.height);
1074                         }
1075                     }});
1076         
1077             specialBoxProperties.put("absolute", new SpecialBoxProperty() {
1078                     public Object get(Box b) { return ((b.flags & ABSOLUTE_FLAG) != 0) ? Boolean.TRUE : Boolean.FALSE; }
1079                     public void put(Box b, Object value) {
1080                         if (stob(value) == ((b.flags & ABSOLUTE_FLAG) != 0)) return;
1081                         if (stob(value)) b.flags |= ABSOLUTE_FLAG; else b.flags &= ~ABSOLUTE_FLAG;
1082                         if ((b.flags & ABSOLUTE_FLAG) != 0) { b.x = 0; b.y = 0; }
1083                         if (b.parent != null) MARK_FOR_REFLOW_b_parent;
1084                     } });
1085         
1086             specialBoxProperties.put("image", new SpecialBoxProperty() {
1087                     /* FIXME
1088                     public Object get(Box b) { return b.image == null ? null : ImageDecoder.imageToNameMap.get(b.image); }
1089                     */
1090                     public void put(Box b, Object value) {
1091                         //if (image != null) System.out.println("hit");
1092                         if (value == null) {
1093                             b.image = null;
1094                         } else if (value instanceof Res) {
1095                             b.image = Picture.fromRes((Res)value);
1096                         } else {
1097                             // FIXME
1098                         }
1099                         b.minwidth = min(b.maxwidth, max(b.minwidth, b.image == null ? 0 : b.image.getWidth()));
1100                         b.minheight = min(b.maxheight, max(b.minheight, b.image == null ? 0 : b.image.getHeight()));
1101                         MARK_FOR_REFLOW_b;
1102                         b.dirty();
1103                     }
1104                 });
1105
1106             //#repeat globalx/globaly x/y
1107             specialBoxProperties.put("globalx", new SpecialBoxProperty() {
1108                     public Object get(Box b) { return new Integer(b.parent == null || b.surface == null ? 0 : b.x); }
1109                     public void put(Box b, Object value) {
1110                         if (b.surface == null || b.parent == null) return;
1111                         b.put("x", new Integer(stoi(value) - stoi(get(b.parent))));
1112                         MARK_FOR_REFLOW_b;
1113                     }
1114                 });
1115             //#end
1116         
1117             specialBoxProperties.put("cursor", new SpecialBoxProperty() {
1118                     public Object get(Box b) { return b.cursor; } 
1119                     public void put(Box b, Object value) {
1120                         b.cursor = (String)value;
1121                         if (b.surface == null) return;
1122
1123                         // see if we need to update the surface cursor
1124                         Surface surface = b.getRoot().surface;
1125                         String tempcursor = surface.cursor;
1126                         b.Move(surface.mousex, surface.mousey, surface.mousex, surface.mousey);
1127                         if (surface.cursor != tempcursor) surface.syncCursor();
1128                     } 
1129                 });
1130         
1131             //#repeat mousex/mousey x/y
1132             specialBoxProperties.put("mousex", new SpecialBoxProperty() {
1133                     public Object get(Box b) {
1134                         Surface surface = b.getRoot().surface;
1135                         if (surface == null) return new Integer(0);
1136                         int mousex = surface.mousex;
1137                         for(Box cur = b; cur != null && cur.parent != null; cur = cur.parent) mousex -= cur.x;
1138                         return new Integer(mousex);
1139                     }
1140                 });
1141             //#end
1142         
1143             specialBoxProperties.put("mouseinside", new SpecialBoxProperty() {
1144                     public Object get(Box b) {
1145                         return ((b.flags & MOUSEINSIDE_FLAG) != 0) ? Boolean.TRUE : Boolean.FALSE; }
1146                 });
1147         
1148             specialBoxProperties.put("numchildren", new SpecialBoxProperty() {
1149                     public Object get(Box b) {
1150                         if (b.redirect == null) return new Integer(0);
1151                         if (b.redirect != b) return get(b.redirect);
1152                         return new Integer(b.numChildren());
1153                     } });
1154         
1155             SpecialBoxProperty mouseEventHandler = new SpecialBoxProperty() {
1156                     public void put(String name, Box b, Object value) {
1157                         Surface surface = b.getRoot().surface;
1158                         if (surface == null) return;
1159                         int mousex = surface.mousex;
1160                         int mousey = surface.mousey;
1161                         for(Box c = b.parent; c != null && c.parent != null; c = c.parent) {
1162                             mousex -= c.x;
1163                             mousey -= c.y;
1164                         }
1165                         for(Box c = b.prevSibling(); c != null; c = c.prevSibling()) {
1166                             if (c.inside(mousex - c.x, mousey - c.y)) {
1167                                 c.put(name, value);
1168                                 return;
1169                             }
1170                         }
1171                         if (b.parent != null) b.parent.put(name, value);
1172                     }};
1173
1174             specialBoxProperties.put("Press1", mouseEventHandler);
1175             specialBoxProperties.put("Press2", mouseEventHandler);
1176             specialBoxProperties.put("Press3", mouseEventHandler);
1177             specialBoxProperties.put("Release1", mouseEventHandler);
1178             specialBoxProperties.put("Release2", mouseEventHandler);
1179             specialBoxProperties.put("Release3", mouseEventHandler);
1180             specialBoxProperties.put("Click1", mouseEventHandler);
1181             specialBoxProperties.put("Click2", mouseEventHandler);
1182             specialBoxProperties.put("Click3", mouseEventHandler);
1183             specialBoxProperties.put("DoubleClick1", mouseEventHandler);
1184             specialBoxProperties.put("DoubleClick2", mouseEventHandler);
1185             specialBoxProperties.put("DoubleClick3", mouseEventHandler);
1186
1187             specialBoxProperties.put("root", new SpecialBoxProperty() {
1188                     public void put(Box b, Object value) {
1189                         if (stob(value)) b.flags |= ISROOT_FLAG;
1190                         else b.flags &= ~ISROOT_FLAG;
1191                     }
1192                     public Object get(Box b) {
1193                         if (b.parent == null || ((b.flags & ISROOT_FLAG) != 0)) return b;
1194                         else return get(b.parent);
1195                     } });
1196
1197             specialBoxProperties.put("Minimized", new SpecialBoxProperty() {
1198                     public Object get(Box b) {
1199                         if (b.parent == null && b.surface != null) return b.surface.minimized ? Boolean.TRUE : Boolean.FALSE;
1200                         else return null;
1201                     }
1202                     public void put(Box b, Object value) {
1203                         if (b.surface == null) return;
1204                         boolean val = stob(value);
1205                         if (b.parent == null && b.surface.minimized != val) b.surface.setMinimized(val);
1206                     }
1207                 });
1208
1209             specialBoxProperties.put("Maximized", new SpecialBoxProperty() {
1210                     public Object get(Box b) {
1211                         if (b.parent == null && b.surface != null) return b.surface.maximized ? Boolean.TRUE : Boolean.FALSE;
1212                         else return null;
1213                     }
1214                     public void put(Box b, Object value) {
1215                         if (b.surface == null) return;
1216                         boolean val = stob(value);
1217                         if (b.parent == null && b.surface.maximized != val) b.surface.setMaximized(val);
1218                     }
1219                 });
1220
1221             specialBoxProperties.put("toback", new SpecialBoxProperty() {
1222                     public void put(Box b, Object value) {
1223                         if (b.parent == null && stob(value) && b.surface != null) b.surface.toBack();
1224                     }
1225                 });
1226
1227             specialBoxProperties.put("tofront", new SpecialBoxProperty() {
1228                     public void put(Box b, Object value) {
1229                         if (b.parent == null && stob(value) && b.surface != null) b.surface.toFront();
1230                     }
1231                 });
1232
1233             specialBoxProperties.put("Close", new SpecialBoxProperty() {
1234                     public void put(Box b, Object value) {
1235                         if (b.parent == null && b.surface != null) b.surface.dispose(true);
1236                     }
1237                 });
1238
1239             // these are all do-nothings; just to prevent space from getting taken up in the params Hash.
1240             specialBoxProperties.put("KeyPressed", new SpecialBoxProperty());
1241             specialBoxProperties.put("KeyReleased", new SpecialBoxProperty());
1242             specialBoxProperties.put("PosChange", new SpecialBoxProperty());
1243             specialBoxProperties.put("SizeChange", new SpecialBoxProperty());
1244
1245             //#repeat hpad/vpad 
1246             specialBoxProperties.put("hpad", new SpecialBoxProperty() {
1247                     public Object get(Box b) {
1248                         if (b.redirect == null) return new Integer(0);
1249                         if (b.redirect != b) return get(b.redirect);
1250                         return new Integer(b.hpad);
1251                     }
1252                     public void put(Box b, Object value) {
1253                         if (b.redirect == null) return;
1254                         if (b.redirect != b) { put(b.redirect, value); return; }
1255                         int newval = stoi(value);
1256                         if (newval == b.hpad) return;
1257                         b.hpad = newval;
1258                         MARK_FOR_REFLOW_b;
1259                     }
1260                 });
1261             //#end
1262
1263             //#repeat minwidth/minheight maxwidth/maxheight
1264             specialBoxProperties.put("minwidth", new SpecialBoxProperty() {
1265                     public Object get(Box b) { return new Integer(b.minwidth); }
1266                     public void put(Box b, Object value) {
1267                         if (stoi(value) == b.minwidth) return;
1268                         b.minwidth = stoi(value);
1269                         MARK_FOR_REFLOW_b;
1270                     }
1271                 });
1272             specialBoxProperties.put("maxwidth", new SpecialBoxProperty() {
1273                     public Object get(Box b) { return new Integer(b.maxwidth); }
1274                     public void put(Box b, Object value) {
1275                         if (stoi(value) == b.maxwidth) return;
1276                         b.maxwidth = stoi(value);
1277                         MARK_FOR_REFLOW_b;
1278                     }
1279                 });
1280             //#end
1281
1282             specialBoxProperties.put("redirect", new SpecialBoxProperty() {
1283                     public void put(Box b, Object value) {
1284                         if (b.redirect != b) Log.log(this, "cannot change the redirect of a box once it is set");
1285                         else if (value == null) b.redirect = null;
1286                         else {
1287                             Box b2 = (Box)value;
1288                             while(b2 != b && b2 != null) b2 = b2.parent;
1289                             if (b2 == null) Log.log(this, "a box's redirect must be one of its descendants");
1290                             b.redirect = (Box)value;
1291                         }
1292                     }
1293                     public Object get(Box b) {
1294                         if (b.redirect == null) return null;
1295                         if (b.redirect == b) return Boolean.TRUE;
1296                         return get(b.redirect);
1297                     }
1298                 });
1299
1300             // FEATURE: this still isn't totally harmonious; when you createSurface, these aren't checked
1301             specialBoxProperties.put("titlebar", new SpecialBoxProperty() {
1302                     public void put(Box b, Object value) {
1303                         if (b.surface != null) b.surface.setTitleBarText(value.toString());
1304                         b.put_("titlebar", value);
1305                     }
1306                     public Object get(Box b) { return b.get_("titlebar"); }
1307                 });
1308
1309             specialBoxProperties.put("icon", new SpecialBoxProperty() {
1310                     // FIXME
1311                     /*
1312                     public void put(Box b, Object value) {
1313                         b.put_("icon", value);
1314                         if (b.surface == null) return;
1315                         Picture pic = ImageDecoder.getPicture(value.toString());
1316                         if (pic != null) b.surface.setIcon(pic);
1317                         else if (Log.on) Log.log(this, "unable to load icon " + value);
1318                     }
1319                     public Object get(Box b) { return b.get_("icon"); }
1320                     */
1321                 });
1322         }
1323     }
1324
1325     /** helper that converts a String to a boolean according to JavaScript coercion rules */
1326     public static boolean stob(Object o) {
1327         if (o == null) return false;
1328         return Boolean.TRUE.equals(o) || "true".equals(o);
1329     }
1330
1331     /** helper that converts a String to an int according to JavaScript coercion rules */
1332     public static int stoi(Object o) {
1333         if (o == null) return 0;
1334         if (o instanceof Integer) return ((Integer)o).intValue();
1335         
1336         String s;
1337         if (!(o instanceof String)) s = o.toString();
1338         else s = (String)o;
1339         
1340         try { return Integer.parseInt(s.indexOf('.') == -1 ? s : s.substring(0, s.indexOf('.'))); }
1341         catch (NumberFormatException e) { return 0; }
1342     }
1343 }
1344         
1345
1346