1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
12 * Encapsulates the data for a single XWT box as well as all layout
17 * This is the real meat of XWT. Part of its monolithic design is for
18 * performance reasons: deep inheritance heirarchies are slow, and
19 * neither javago nor GCJ can inline across class boundaries.
22 * <p>The rendering process consists of two phases:</p>
24 * <ol><li> <b>Prerendering pipeline</b>: a set of methods that
25 * traverse the tree (DFS, postorder) immediately before
26 * rendering. These methods calculate the appropriate size
27 * and position for all boxes. If no changes requiring a
28 * re-prerender have been made to a box or any of its
29 * descendants, <tt>needs_prerender</tt> will be false, and the box
30 * and its descendants will be skipped.
32 * <li> <b>Rendering pipeline</b>: a second set of methods that
33 * traverses the tree (DFS, preorder) and renders each Box
34 * onto the associated Surface. The render() method takes a
35 * region (x,y,w,h) as an argument, and will only render
36 * onto pixels within that region. Boxes which lie
37 * completely outside that region will be skipped.
41 * Either of these two phases may <i>abort</i> at any time by setting
42 * <tt>surface.abort</tt> to true. Currently, there are two reasons
43 * for aborting: a <tt>SizeChange</tt> or <tt>PosChange</tt> was
44 * triggered in the prerender phase (which ran scripts which modified
45 * the boxtree's composition, requiring another prerender pass), or
46 * else the user resized the surface. In either case, the
47 * [pre]rendering process is halted as soon as possible and
48 * re-started from the beginning.
51 * <p>Why are these done as seperate passes over the box tree?</p>
53 * <ol><li> Sometimes we need to make several trips through
54 * <tt>prerender()</tt?, as a result of <tt>SizeChange</tt>
55 * or <tt>PosChange</tt>. Calling <tt>prerender()</tt> is
56 * cheap; calling <tt>render()</tt> is expensive.
58 * <li> Even if no <tt>SizeChange</tt> or <tt>PosChange</tt> traps are
59 * triggered, updates to the size and position of boxes in
60 * the prerender phase can cause additional regions to be
61 * added to the dirty list. If the prerender and render
62 * passes were integrated, this might cause some screen
63 * regions to be painted twice (or more) in a single pass,
64 * which hurts performance.
68 * A box's <tt>_cmin_*</tt> variables hold the minimum possible
69 * dimensions of this box, taking into account the size of its
70 * children (and their children). The cmin variables must be kept in
71 * sync with its other geometric properties and the geometric
72 * properties of its children at all times -- they are not
73 * periodically recomputed during the [pre]rendering process, as size
74 * and pos are. If any data changes which might invalidate the cmin,
75 * the method <tt>sync_cmin_to_children()</tt> must be invoked
80 * A note on coordinates: the Box class represents regions
81 * internally as x,y,w,h tuples, even though the DoubleBuffer class
82 * uses x1,y1,x2,y2 tuples.
85 public final class Box extends JS.Scope {
88 // Static Data //////////////////////////////////////////////////////////////
90 /** a pool of one-element Object[]'s */
91 private static Queue singleObjects = new Queue(100);
93 /** caches images, keyed on resource name or url */
94 public static Hash pictureCache = new Hash();
96 /** cache of border objects */
97 static Hash bordercache = new Hash();
99 /** stores image names, keyed on image object */
100 static Hash imageToNameMap = new Hash();
102 /** the empty object, used for get-traps */
103 private static JS.Array emptyobj = new JS.Array();
106 // Instance Data: Templates ////////////////////////////////////////////////////////
108 /** the unresolved name of the first template applied to this node [ignoring preapply's], or null if this template was specified anonymously */
109 String templatename = null;
111 /** the importlist which was used to resolve <tt>templatename</tt>, or null if this template was specified anonymously */
112 String[] importlist = Template.defaultImportList;
114 /** the template instance that resulted from resolving <tt>templatename</tt> using <tt>importlist</tt>, or the anonymous template applied */
115 Template template = null;
118 // Instance Data: Geometry ////////////////////////////////////////////////////////
120 /** The number of elements in the geom array */
121 public static final int NUMINTS = 10;
123 /** The maximum <i>defined</i> width and height of this box */
124 public static final int dmax = 0;
125 private int _dmax_0 = 0;
126 private int _dmax_1 = 0;
127 public final int dmax(int axis) { return axis == 0 ? _dmax_0 : _dmax_1; }
129 /** The minimum <i>defined</i> width and height of this box */
130 public static final int dmin = 1;
131 private int _dmin_0 = 0;
132 private int _dmin_1 = 0;
133 public final int dmin(int axis) { return axis == 0 ? _dmin_0 : _dmin_1; }
135 /** The minimum <i>calculated</i> width and height of this box -- unlike dmin, this takes childrens' sizes into account */
136 public static final int cmin = 2;
137 private int _cmin_0 = 0;
138 private int _cmin_1 = 0;
139 public final int cmin(int axis) { return axis == 0 ? _cmin_0 : _cmin_1; }
141 /** The position of this box, relitave to the parent */
142 public static final int abs = 3;
143 private int _abs_0 = 0;
144 private int _abs_1 = 0;
145 public final int abs(int axis) { return axis == 0 ? _abs_0 : _abs_1; }
147 /** The absolute position of this box (ie relitave to the root); set by the parent */
148 public static final int pos = 4;
149 private int _pos_0 = 0;
150 private int _pos_1 = 0;
151 public final int pos(int axis) { return axis == 0 ? _pos_0 : _pos_1; }
153 /** The actual size of this box; set by the parent. */
154 public static final int size = 5;
157 public final int size(int axis) { return axis == 0 ? _size_0 : _size_1; }
159 /** The old actual absolute position of this box (ie relitave to the root) */
160 public static final int oldpos = 6;
161 private int _oldpos_0 = 0;
162 private int _oldpos_1 = 0;
163 public final int oldpos(int axis) { return axis == 0 ? _oldpos_0 : _oldpos_1; }
165 /** The old actual size of this box */
166 public static final int oldsize = 7;
167 private int _oldsize_0 = 0;
168 private int _oldsize_1 = 0;
169 public final int oldsize(int axis) { return axis == 0 ? _oldsize_0 : _oldsize_1; }
171 /** The padding along each edge for this box */
172 public static final int pad = 8;
173 private int _pad_0 = 0;
174 private int _pad_1 = 0;
175 public final int pad(int axis) { return axis == 0 ? _pad_0 : _pad_1; }
177 /** The dimensions of the text in this box */
178 public static final int textdim = 9;
179 private int _textdim_0 = 0;
180 private int _textdim_1 = 0;
181 public final int textdim(int axis) { return axis == 0 ? _textdim_0 : _textdim_1; }
184 // Instance Data /////////////////////////////////////////////////////////////////
186 /** This box's mouseinside property, as defined in the reference */
187 boolean mouseinside = false;
189 /** If redirect is enabled, this holds the Box redirected to */
192 /** the Box's font, null inherits from parent -- you must call textupdate() after changing this */
195 /** if font == null, this might be a cached copy of the inherited ancestor font */
196 String cachedFont = null;
198 /** The surface for us to render on; null if none; INVARIANT: surface == getParent().surface */
199 Surface surface = null;
201 /** Our alignment: top/left == -1, center == 0, bottom/right == +1 */
204 /** Our background image; to set this, use setImage() */
205 public Picture image;
207 /** The flex for this box */
210 /** The orientation, horizontal == 0, vertical == 1 */
213 /** The opposite of the orientation */
216 /** The id of this Box */
217 public String id = "";
219 /** The text of this Box -- you must call textupdate() after changing this */
222 /** The color of the text in this Box in 00RRGGBB form -- default is black */
223 int textcolor = 0xFF000000;
225 /** The background color of this box in AARRGGBB form -- default is clear; alpha is all-or-nothing */
226 int color = 0x00000000;
228 /** Holds four "strip images" -- 0=top, 1=bottom, 2=left, 3=right, 4=all */
229 Picture[] border = null;
231 /** true iff the box's background image should be tiled */
232 boolean tile = false;
234 /** True iff the Box is invisible */
235 public boolean invisible = false;
237 /** If true, the Box will force its own size to the natural size of its background image */
238 boolean sizetoimage = false;
240 /** If true and tile is false, the background of this image will never be stretched */
241 boolean fixedaspect = false;
243 /** If true, the box will shrink to the smallest vertical size possible */
244 boolean vshrink = false;
246 /** If true, the box will shrink to the smallest horizontal size possible */
247 boolean hshrink = false;
249 /** If true, the box will be positioned absolutely */
250 boolean absolute = false;
252 /** True iff the Box must be run through the prerender() pipeline before render()ing;<br>
253 * INVARIANT: if (needs_prerender) then getParent().needs_prerender. **/
254 boolean needs_prerender = true;
256 /** The cursor for this Box -- only meaningful on the root Box */
257 public String cursor = null;
259 /** Any traps placed on this Box */
260 public Hash traps = null;
263 // Instance Data: IndexOf ////////////////////////////////////////////////////////////
265 /** The indexof() Function; created lazily */
266 public JS.Callable indexof = null;
267 public JS.Callable indexof() { if (indexof == null) indexof = new IndexOf(); return indexof; }
269 /** a trivial private class to serve as the box.indexof function object */
270 private class IndexOf extends JS.Callable {
271 public IndexOf() { this.setSeal(true); }
272 public Object call(JS.Array args) throws JS.Exn {
273 if (args.length() != 1 || args.elementAt(0) == null || !(args.elementAt(0) instanceof Box)) return new Integer(-1);
274 Box b = (Box)args.elementAt(0);
275 if (b.getParent() != Box.this) {
276 if (redirect == null || redirect == Box.this) return new Integer(-1);
277 return Box.this.redirect.indexof().call(args);
279 return new Integer(b.getIndexInParent());
284 // Methods which enforce/preserve invariants ////////////////////////////////////////////
286 /** This method MUST be used to change geometry values -- it ensures that certain invariants are preserved. */
287 public final void set(int which, int axis, int newvalue) {
289 // if this Box is the root of the Surface, notify the Surface of size changes
290 if (getParent() == null && surface != null && which == size)
291 surface._setSize(axis == 0 ? newvalue : size(0), axis == 1 ? newvalue : size(1));
293 if (getParent() == null && surface != null && (which == dmin || which == dmax))
294 surface.setLimits(dmin(0), dmin(1), dmax(0), dmax(1));
297 case dmin: if (dmin(axis) == newvalue) return; if (axis == 0) _dmin_0 = newvalue; else _dmin_1 = newvalue; break;
298 case dmax: if (dmax(axis) == newvalue) return; if (axis == 0) _dmax_0 = newvalue; else _dmax_1 = newvalue; break;
299 case cmin: if (cmin(axis) == newvalue) return; if (axis == 0) _cmin_0 = newvalue; else _cmin_1 = newvalue; break;
300 case abs: if (abs(axis) == newvalue) return; if (axis == 0) _abs_0 = newvalue; else _abs_1 = newvalue; break;
301 case pos: if (pos(axis) == newvalue) return; if (axis == 0) _pos_0 = newvalue; else _pos_1 = newvalue; break;
302 case size: if (size(axis) == newvalue) return; if (axis == 0) _size_0 = newvalue; else _size_1 = newvalue; break;
303 case oldpos: if (oldpos(axis) == newvalue) return; if (axis == 0) _oldpos_0 = newvalue; else _oldpos_1 = newvalue; break;
304 case oldsize: if (oldsize(axis) == newvalue) return; if (axis == 0) _oldsize_0 = newvalue; else _oldsize_1 = newvalue; break;
305 case pad: if (pad(axis) == newvalue) return; if (axis == 0) _pad_0 = newvalue; else _pad_1 = newvalue; break;
306 case textdim: if (textdim(axis) == newvalue) return; if (axis == 0) _textdim_0 = newvalue; else _textdim_1 = newvalue; break;
310 // size must always agree with dmin/dmax
311 if (which == dmin) set(size, axis, max(size(axis), newvalue));
312 if (which == dmax) set(size, axis, min(size(axis), newvalue));
314 // keep cmin in line with dmin/dmax/textdim
315 if (which == dmax || which == dmin || which == textdim || which == pad || which == cmin)
318 min(dmax(axis), cmin(axis)),
320 min(dmax(axis), textdim(axis) + 2 * pad(axis))
324 // if the pad changes, update cmin
325 if (which == pad) sync_cmin_to_children();
327 // needed in the shrink case, since dmin may have been the deciding factor in calculating cmin
328 if ((vshrink || hshrink) && (which == dmin || which == textdim || which == pad)) sync_cmin_to_children();
330 // if the cmin changes, we need to be re-prerendered
331 if (which == cmin) mark_for_prerender();
333 // if the absolute position of a box changes, its parent needs to be re-prerendered (to update the child's position)
334 if (which == abs && getParent() != null) getParent().mark_for_prerender();
336 // if our cmin changes, then our parent's needs to be recalculated
337 if (getParent() != null && which == cmin) {
338 mark_for_prerender();
339 getParent().sync_cmin_to_children();
344 /** Marks this node and all its ancestors so that they will be prerender()ed */
345 public final void mark_for_prerender() {
346 if (needs_prerender) return;
347 needs_prerender = true;
348 if (getParent() != null) getParent().mark_for_prerender();
351 /** Ensures that cmin is in sync with the cmin's of our children. This should be called whenever a child is added or
352 * removed, as well as when our pad is changed. */
353 final void sync_cmin_to_children() {
354 int co = (int)(2 * pad(o));
355 int cxo = (int)(2 * pad(xo));
357 for(Box bt = getChild(0); bt != null; bt = bt.nextSibling()) {
358 if (bt.invisible || bt.absolute) continue;
360 cxo = (int)max(bt.cmin(xo) + 2 * pad(xo), cxo);
367 /** must be called after changes to <tt>image</tt> or <tt>border</tt> if sizetoimage is true */
368 public void syncSizeToImage() {
369 set(dmax, 0, (image == null ? 0 : image.getWidth()) + (border == null ? 0 : border[2].getWidth()) * 2);
370 set(dmax, 1, (image == null ? 0 : image.getHeight()) + (border == null ? 0 : border[0].getHeight()) * 2);
371 set(dmin, 0, (image == null ? 0 : image.getWidth()) + (border == null ? 0 : border[2].getWidth()) * 2);
372 set(dmin, 1, (image == null ? 0 : image.getHeight()) + (border == null ? 0 : border[0].getHeight()) * 2);
375 /** returns the actual font that should be used to render this box */
376 private String font() {
377 if (font != null) return font;
378 if (font == null && cachedFont != null) return cachedFont;
379 if (getParent() != null) return cachedFont = getParent().font();
380 return cachedFont = Platform.getDefaultFont();
383 /** this must be called when a box's font changes */
386 for(Box b = getChild(0); b != null; b = b.nextSibling())
387 if (b.font == null) {
388 b.cachedFont = font();
393 /** This must be called when font or text is changed */
395 if (text.equals("")) {
399 XWF xwf = XWF.getXWF(font());
401 set(textdim, 0, Platform.stringWidth(font(), text));
402 set(textdim, 1, (Platform.getMaxAscent(font()) + Platform.getMaxDescent(font())));
404 set(textdim, 0, xwf.stringWidth(text));
405 set(textdim, 1, (xwf.getMaxAscent() + xwf.getMaxDescent()));
411 // Instance Methods /////////////////////////////////////////////////////////////////////
413 /** Changes the Surface that this Box draws on. */
414 protected void setSurface(Surface newSurface) {
415 if (surface == newSurface) return;
417 if ((is_trapped("KeyPressed") || is_trapped("KeyReleased")) && surface != null)
418 surface.keywatchers.removeElement(this);
419 surface = newSurface;
420 if ((is_trapped("KeyPressed") || is_trapped("KeyReleased")) && surface != null)
421 surface.keywatchers.addElement(this);
422 for(Box i = getChild(0); i != null; i = i.nextSibling()) i.setSurface(surface);
423 if (numChildren() == 0) mark_for_prerender();
426 /** loads the image described by string str, possibly blocking for a network load */
427 static ImageDecoder getImage(String str, final JS.Callable callback) {
429 if (str.indexOf(':') == -1) {
431 byte[] b = Resources.getResource(Resources.resolve(s + ".png", null));
432 if (b != null) return PNG.decode(new ByteArrayInputStream(b), str);
433 b = Resources.getResource(Resources.resolve(s + ".jpeg", null));
434 if (b != null) return Platform.decodeJPEG(new ByteArrayInputStream(b), str);
438 java.lang.Thread thread = java.lang.Thread.currentThread();
439 if (!(thread instanceof ThreadMessage)) {
440 if (Log.on) Log.log(Box.class, "HTTP images can not be loaded from the foreground thread");
443 // FIXME: use primitives here
444 ThreadMessage mythread = (ThreadMessage)thread;
445 mythread.setPriority(java.lang.Thread.MIN_PRIORITY);
446 mythread.done.release();
448 HTTP http = new HTTP(str);
449 final HTTP.HTTPInputStream in = http.GET();
450 final int contentLength = in.getContentLength();
451 InputStream is = new FilterInputStream(in) {
452 int bytesDownloaded = 0;
453 boolean clear = true;
454 public int read() throws IOException {
458 public int read(byte[] b, int off, int len) throws IOException {
459 int ret = super.read(b, off, len);
460 if (ret != -1) bytesDownloaded += ret;
461 if (clear && callback != null) {
463 ThreadMessage.newthread(new JS.Callable() {
464 public Object call(JS.Array args_) throws JS.Exn {
466 JS.Array args = new JS.Array();
467 args.addElement(new Double(bytesDownloaded));
468 args.addElement(new Double(contentLength));
481 if (str.endsWith(".gif")) return GIF.decode(is, str);
482 else if (str.endsWith(".jpeg") || str.endsWith(".jpg")) return Platform.decodeJPEG(is, str);
483 else return PNG.decode(is, str);
485 } catch (IOException e) {
486 if (Log.on) Log.log(Box.class, "error while trying to load an image from " + str);
487 if (Log.on) Log.log(Box.class, e);
491 MessageQueue.add(mythread);
492 mythread.setPriority(java.lang.Thread.NORM_PRIORITY);
498 /** gets an Image using getImage(), adds it to the cache, and creates a Picture from it */
499 public static Picture getPicture(String os) {
501 ret = (Picture)pictureCache.get(os);
502 if (ret != null) return ret;
503 ImageDecoder id = getImage(os, null);
504 if (id == null) return null;
505 ret = Platform.createPicture(id);
506 pictureCache.put(os, ret);
507 imageToNameMap.put(ret, os);
511 /** Sets the image; argument should be a fully qualified s name or an URL */
512 void setImage(String s) {
513 if ((s == null && image == null) || (s != null && image != null && s.equals(imageToNameMap.get(image)))) return;
514 if (s == null || s.equals("")) {
516 if (sizetoimage) syncSizeToImage();
519 image = getPicture(s);
521 if (Log.on) Log.logJS(Box.class, "unable to load image " + s);
524 if (sizetoimage) syncSizeToImage();
529 /** Sets the border; argument should be a fully qualified resource name or an URL */
530 void setBorder(String s) {
531 if ((s == null && border == null) || (s != null && border != null && s.equals(imageToNameMap.get(border)))) return;
532 if (s == null || s.equals("")) {
534 if (sizetoimage) syncSizeToImage();
538 border = (Picture[])bordercache.get(s);
539 if (border == null) {
540 ImageDecoder id = getImage(s, null);
542 if (Log.on) Log.logJS(this, "unable to load border image " + s);
545 int[] data = id.getData();
546 int w = id.getWidth();
547 int h = id.getHeight();
551 int[][] dat = new int[4][];
552 dat[0] = new int[100 * vpad];
553 dat[1] = new int[100 * vpad];
554 dat[2] = new int[100 * hpad];
555 dat[3] = new int[100 * hpad];
557 for(int i=0; i<100; i++) {
558 for(int j=0; j<vpad; j++) {
559 dat[0][i + j * 100] = data[hpad + j * w];
560 dat[1][i + (vpad - j - 1) * 100] = data[hpad + (h - j - 1) * w];
562 for(int j=0; j<hpad; j++) {
563 dat[2][j + i * hpad] = data[j + vpad * w];
564 dat[3][hpad - j - 1 + i * hpad] = data[w - j - 1 + vpad * w];
568 border = new Picture[5];
569 border[0] = Platform.createPicture(dat[0], 100, vpad);
570 border[1] = Platform.createPicture(dat[1], 100, vpad);
571 border[2] = Platform.createPicture(dat[2], hpad, 100);
572 border[3] = Platform.createPicture(dat[3], hpad, 100);
573 border[4] = (Picture)pictureCache.get(s);
574 if (border[4] == null) {
575 border[4] = Platform.createPicture(data, w, h);
576 pictureCache.put(s, border[4]);
577 imageToNameMap.put(border[4], s);
579 bordercache.put(s, border);
581 if (sizetoimage) syncSizeToImage();
586 /** returns true if the property has a trap on it */
587 boolean is_trapped(String property) { return traps != null && traps.get(property) != null; }
589 /** Adds the node's current actual geometry to the Surface's dirty list */
590 void dirty() { dirty(pos(0), pos(1), size(0), size(1)); }
592 /** Adds the intersection of (x,y,w,h) and the node's current actual geometry to the Surface's dirty list */
593 public final void dirty(int x, int y, int w, int h) {
594 for(Box cur = this; cur != null; cur = cur.getParent()) {
595 w = min(x + w, cur.pos(0) + cur.size(0)) - max(x, cur.pos(0));
596 h = min(y + h, cur.pos(1) + cur.size(1)) - max(y, cur.pos(1));
597 x = max(x, cur.pos(0));
598 y = max(y, cur.pos(1));
599 if (w <= 0 || h <= 0) return;
601 if (surface != null) surface.dirty(x, y, w, h);
605 * Given an old and new mouse position, this will update <tt>mouseinside</tt> and check
606 * to see if this node requires any Enter, Leave, or Move notifications.
608 * @param forceleave set to true by the box's parent if the mouse is inside an older
609 * sibling, which is covering up this box.
611 void Move(int oldmousex, int oldmousey, int mousex, int mousey) { Move(oldmousex, oldmousey, mousex, mousey, false); }
612 void Move(int oldmousex, int oldmousey, int mousex, int mousey, boolean forceleave) {
614 boolean wasinside = mouseinside;
615 boolean isinside = !invisible && inside(mousex, mousey) && !forceleave;
616 mouseinside = isinside;
618 if (!wasinside && !isinside) return;
620 if (!wasinside && isinside && is_trapped("Enter")) put("Enter", this);
621 else if (wasinside && !isinside && is_trapped("Leave")) put("Leave", this);
622 else if (wasinside && isinside && (mousex != oldmousex || mousey != oldmousey) && is_trapped("Move")) put("Move", this);
624 if (isinside && cursor != null && surface != null) surface.cursor = cursor;
626 // if the mouse has moved into our padding region, it is considered 'outside' all our children
627 if (!(mousex >= pos(0) + pad(0) && mousey >= pos(1) + pad(1) &&
628 mousex < pos(0) + size(0) - pad(0) && mousey < pos(1) + size(1) + pad(1))) forceleave = true;
630 for(Box b = getChild(numChildren() - 1); b != null; b = b.prevSibling()) {
631 b.Move(oldmousex, oldmousey, mousex, mousey, forceleave);
632 if (b.inside(mousex, mousey)) forceleave = true;
636 /** creates a new box from an anonymous template; <tt>ids</tt> is passed through to Template.apply() */
637 Box(Template anonymous, Vec pboxes, Vec ptemplates, JS.Callable callback, int numerator, int denominator) {
639 set(dmax, 0, Integer.MAX_VALUE);
640 set(dmax, 1, Integer.MAX_VALUE);
641 template = anonymous;
642 template.apply(this, pboxes, ptemplates, callback, numerator, denominator);
647 /** creates a new box from an unresolved templatename and an importlist; use "box" for an untemplatized box */
648 public Box(String templatename, String[] importlist) { this(templatename, importlist, null); }
649 public Box(String templatename, String[] importlist, JS.Callable callback) {
651 set(dmax, 0, Integer.MAX_VALUE);
652 set(dmax, 1, Integer.MAX_VALUE);
653 this.importlist = importlist;
654 if (!"box".equals(templatename)) {
655 template = Template.getTemplate(templatename, importlist);
656 if (template == null)
657 if (Log.on) Log.log(this, "couldn't find template \"" + templatename + "\"");
659 if (template != null) {
660 this.templatename = templatename;
661 template.apply(this, null, null, callback, 0, template.numUnits());
662 if (redirect == this && !"self".equals(template.redirect)) redirect = null;
667 // Prerendering Pipeline ///////////////////////////////////////////////////////////////
669 /** Checks if the Box's size has changed, dirties it if necessary, and makes sure childrens' sizes are up to date */
672 if (invisible) return;
674 if (getParent() == null) {
679 if (pos(0) != oldpos(0) || pos(1) != oldpos(1) || size(0) != oldsize(0) || size(1) != oldsize(1)) {
680 needs_prerender = true;
681 check_geometry_changes();
684 if (!needs_prerender) return;
685 needs_prerender = false;
686 if (numChildren() == 0) return;
688 int sumchildren = sizeChildren();
689 positionChildren(pos(o) + pad(o) + max(0, size(o) - 2 * pad(o) - sumchildren) / 2);
691 for(Box b = getChild(0); b != null; b = b.nextSibling()) {
694 mark_for_prerender();
700 /** if the size or position of a box has changed, dirty() the appropriate regions and possibly send Enter/Leave/SizeChange/PosChange */
701 private void check_geometry_changes() {
703 // FASTPATH: if we haven't moved position (just changed size), and we're not a stretched image:
704 if (oldpos(0) == pos(0) && oldpos(1) == pos(1) && (image == null || tile)) {
706 // we use the max(border, pad) since because of the pad we might be revealing an abs-pos child
707 int bw = max(border == null ? 0 : border[2].getWidth(), pad(0));
708 int bh = max(border == null ? 0 : border[0].getHeight(), pad(1));
710 // dirty only the *change* in the area we cover, both on ourselves and on our parent
711 for(Box cur = this; cur != null && (cur == this || cur == this.getParent()); cur = cur.getParent()) {
712 cur.dirty(pos(0) + min(oldsize(0) - bw, size(0) - bw),
714 java.lang.Math.abs(oldsize(0) - size(0)) + bw,
715 max(oldsize(1), size(1)));
717 pos(1) + min(oldsize(1) - bh, size(1) - bh),
718 max(oldsize(0), size(0)),
719 java.lang.Math.abs(oldsize(1) - size(1)) + bh);
722 // SLOWPATH: dirty ourselves, as well as our former position on our parent
725 if (getParent() != null) getParent().dirty(oldpos(0), oldpos(1), oldsize(0), oldsize(1));
729 boolean sizechange = false;
730 boolean poschange = false;
731 if ((oldsize(0) != size(0) || oldsize(1) != size(1)) && is_trapped("SizeChange")) sizechange = true;
732 if ((oldpos(0) != pos(0) || oldpos(1) != pos(1)) && is_trapped("PosChange")) poschange = true;
734 set(oldsize, 0, size(0));
735 set(oldsize, 1, size(1));
736 set(oldpos, 0, pos(0));
737 set(oldpos, 1, pos(1));
739 if (!sizechange && !poschange) return;
741 if (++surface.sizePosChangesSinceLastRender >= 500) {
742 if (surface.sizePosChangesSinceLastRender == 500) {
743 if (Log.on) Log.logJS(this, "Warning, more than 500 SizeChange/PosChange traps triggered since last complete render");
746 Trap t = sizechange ? Trap.getTrap(this, "SizeChange") : Trap.getTrap(this, "PosChange");
747 InterpretedJS.Callable f = (InterpretedJS.Callable)t.f;
748 if (Log.on) Log.log(this, "Current trap is at " + f.getSourceName() + ":" + f.getLineNumbers()[0]);
749 } catch (Throwable t) { }
753 if (sizechange) put("SizeChange", Boolean.TRUE);
754 if (poschange) put("PosChange", Boolean.TRUE);
755 if (sizechange || poschange) {
756 surface.abort = true;
763 /** sets our childrens' sizes */
766 // Set sizes along minor axis, as well as sizes for absolute-positioned children
767 for(Box bt = getChild(0); bt != null; bt = bt.nextSibling()) {
768 if (bt.invisible) continue;
770 bt.set(size, 0, bt.hshrink ? bt.cmin(0) : max(bt.cmin(0), min(size(0) - bt.abs(0) - pad(0), bt.dmax(0))));
771 bt.set(size, 1, bt.vshrink ? bt.cmin(1) : max(bt.cmin(1), min(size(1) - bt.abs(1) - pad(1), bt.dmax(1))));
772 } else if (xo == 0 && bt.hshrink || xo == 1 && bt.vshrink) {
773 bt.set(size, xo, bt.cmin(xo));
775 bt.set(size, xo, bound(bt.cmin(xo), size(xo) - 2 * pad(xo), bt.dmax(xo)));
779 // the ideal size of our children, along our own major axis
780 int goal = (o == 0 && hshrink) || (o == 1 && vshrink) ? cmin(o) - 2 * pad(o) : size(o) - 2 * pad(o);
782 // the current sum of the sizes of all children
785 // each box is set to bound(box.cmin, box.flex * factor, box.dmax)
788 // Algorithm: we set the sizes of all boxes to bound(cmin, flex * factor, dmax) for some global value
789 // 'factor'. We figure out what 'factor' should be by starting at zero, and slowly increasing
790 // it. After each pass, 'factor' is set to the smaller of two values: ((goal - total) /
791 // remaining_flex) or the next largest value of factor which will cause some box to exceed its
792 // cmin or dmax (thereby changing remaining_flex).
797 // the sum of the flexes of all boxes which are not pegged at either cmin or dmax
798 int remaining_flex = 0;
800 // this is the next largest value of factor at which some box exceeds its cmin/dmax
801 int nextjoint = Integer.MAX_VALUE;
803 for(Box bt = getChild(0); bt != null; bt = bt.nextSibling()) {
804 if (bt.absolute || bt.invisible) continue;
806 int btmax = (o == 0 && bt.hshrink) || (o == 1 && bt.vshrink) ? bt.cmin(o) : bt.dmax(o);
807 bt.set(size, o, bound(bt.cmin(o), factor * bt.flex, btmax));
810 if (factor * bt.flex < bt.cmin(o) && bt.size(o) == bt.cmin(o)) {
811 nextjoint = min(nextjoint, divide_round_up(bt.cmin(o), bt.flex));
813 } else if (bt.size(o) < btmax) {
814 remaining_flex += bt.flex;
815 nextjoint = min(nextjoint, divide_round_up(btmax, bt.flex));
820 if (remaining_flex == 0) {
821 if (nextjoint <= factor) break;
824 factor = min((goal - total + factor * remaining_flex) / remaining_flex, nextjoint);
827 if (goal - total <= remaining_flex) break;
830 // arbitrarily distribute out any leftovers resulting from rounding errors
832 while(goal != total && total != last) {
834 for(Box bt = getChild(0); bt != null; bt = bt.nextSibling()) {
835 int btmax = (o == 0 && bt.hshrink) || (o == 1 && bt.vshrink) ? bt.cmin(o) : bt.dmax(o);
836 int newsize = bound(bt.cmin(o), bt.size(o) + (goal > total ? 1 : -1), btmax);
837 total += newsize - bt.size(o);
838 bt.set(size, o, newsize);
845 /** positions this Box's children; cur is the starting position along this' major axis */
846 void positionChildren(int cur) {
847 for(Box bt = getChild(0); bt != null; bt = bt.nextSibling()) {
848 if (bt.invisible) continue;
850 bt.set(pos, 0, pos(0) + bt.abs(0));
851 bt.set(pos, 1, pos(1) + bt.abs(1));
853 bt.set(pos, xo, pos(xo) + pad(xo) + max(0, ((size(xo) - 2 * pad(xo) - bt.size(xo)) * (bt.align + 1)) / 2));
855 bt.set(abs, 0, bt.pos(0) - pos(0));
856 bt.set(abs, 1, bt.pos(1) - pos(1));
863 // Rendering Pipeline /////////////////////////////////////////////////////////////////////
865 /** Renders self and children within the specified region. All rendering operations are clipped to xIn,yIn,wIn,hIn */
866 void render(int xIn, int yIn, int wIn, int hIn, DoubleBuffer buf) {
867 if (surface.abort || invisible) return;
869 // intersect the x,y,w,h rendering window with ourselves; quit if it's empty
870 int x = max(xIn, getParent() == null ? 0 : pos(0));
871 int y = max(yIn, getParent() == null ? 0 : pos(1));
872 int w = min(xIn + wIn, (getParent() == null ? 0 : pos(0)) + size(0)) - x;
873 int h = min(yIn + hIn, (getParent() == null ? 0 : pos(1)) + size(1)) - y;
874 if (w <= 0 || h <= 0) return;
876 if (border != null) renderBorder(x, y, w, h, buf);
877 if ((color & 0xFF000000) != 0x00000000 || getParent() == null) {
878 int bw = border == null ? 0 : border[2].getWidth();
879 int bh = border == null ? 0 : border[0].getHeight();
880 int x1 = max(x, pos(0) + bw);
881 int y1 = max(y, pos(1) + bh);
882 int x2 = min(x + w, pos(0) + size(0) - bw);
883 int y2 = min(y + h, pos(1) + size(1) - bh);
884 if (y2 - y1 > 0 && x2 - x1 > 0)
885 buf.fillRect(x1,y1,x2,y2,(color & 0xFF000000) != 0 ? color : SpecialBoxProperty.lightGray);
889 if (tile) renderTiledImage(x, y, w, h, buf);
890 else renderStretchedImage(x, y, w, h, buf);
893 if (text != null && !text.equals("")) renderText(x, y, w, h, buf);
895 // now subtract the pad region from the clip region before proceeding
896 int x2 = max(x, pos(0) + pad(0));
897 int y2 = max(y, pos(1) + pad(1));
898 int w2 = min(x + w, pos(0) + size(0) - pad(0)) - x2;
899 int h2 = min(y + h, pos(1) + size(1) - pad(1)) - y2;
901 for(Box b = getChild(0); b != null; b = b.nextSibling())
902 b.render(x2, y2, w2, h2, buf);
905 private void renderBorder(int x, int y, int w, int h, DoubleBuffer buf) {
906 int bw = border[4].getWidth();
907 int bh = border[4].getHeight();
908 buf.setClip(x, y, w + x, h + y);
910 if ((color & 0xFF000000) != 0xFF000000) {
911 // if the color is null, we have to be very careful about drawing the corners
912 //if (Log.verbose) Log.log(this, "WARNING: (color == null && border != null) on box with border " + imageToNameMap.get(border[4]));
915 buf.drawPicture(border[4],
916 pos(0), pos(1), pos(0) + bw / 2, pos(1) + bh / 2,
917 0, 0, bw / 2, bh / 2);
919 // upper right corner
920 buf.drawPicture(border[4],
921 pos(0) + size(0) - bw / 2, pos(1), pos(0) + size(0), pos(1) + bh / 2,
922 bw - bw / 2, 0, bw, bh / 2);
925 buf.drawPicture(border[4],
926 pos(0), pos(1) + size(1) - bh / 2, pos(0) + bw / 2, pos(1) + size(1),
927 0, bh - bh / 2, bw / 2, bh);
929 // lower right corner
930 buf.drawPicture(border[4],
931 pos(0) + size(0) - bw / 2, pos(1) + size(1) - bh / 2, pos(0) + size(0), pos(1) + size(1),
932 bw - bw / 2, bh - bh / 2, bw, bh);
935 buf.drawPicture(border[4], pos(0), pos(1)); // upper left corner
936 buf.drawPicture(border[4], pos(0) + size(0) - bw, pos(1)); // upper right corner
937 buf.drawPicture(border[4], pos(0), pos(1) + size(1) - bh); // lower left corner
938 buf.drawPicture(border[4], pos(0) + size(0) - bw, pos(1) + size(1) - bh); // lower right corner
942 // top and bottom edges
943 buf.setClip(max(x, pos(0) + bw / 2), y, min(x + w, pos(0) + size(0) - bw / 2), h + y);
944 for(int i = max(x, pos(0) + bw / 2); i + 100 < min(x + w, pos(0) + size(0) - bw / 2); i += 100) {
945 buf.drawPicture(border[0], i, pos(1));
946 buf.drawPicture(border[1], i, pos(1) + size(1) - bh / 2);
948 buf.drawPicture(border[0], min(x + w, pos(0) + size(0) - bw / 2) - 100, pos(1));
949 buf.drawPicture(border[1], min(x + w, pos(0) + size(0) - bw / 2) - 100, pos(1) + size(1) - bh / 2);
951 // left and right edges
952 buf.setClip(x, max(y, pos(1) + bh / 2), w + x, min(y + h, pos(1) + size(1) - bh / 2));
953 for(int i = max(y, pos(1) + bh / 2); i + 100 < min(y + h, pos(1) + size(1) - bh / 2); i += 100) {
954 buf.drawPicture(border[2], pos(0), i);
955 buf.drawPicture(border[3], pos(0) + size(0) - bw / 2, i);
957 buf.drawPicture(border[2], pos(0), min(y + h, pos(1) + size(1) - bh / 2) - 100);
958 buf.drawPicture(border[3], pos(0) + size(0) - bw / 2, min(y + h, pos(1) + size(1) - bh / 2) - 100);
960 buf.setClip(0, 0, buf.getWidth(), buf.getHeight());
963 void renderStretchedImage(int x, int y, int w, int h, DoubleBuffer buf) {
964 buf.setClip(x, y, w + x, h + y);
965 int bw = border == null ? 0 : border[4].getHeight();
966 int bh = border == null ? 0 : border[4].getWidth();
968 int width = pos(0) + size(0) - bw / 2 - pos(0) + bw / 2;
969 int height = pos(1) + size(1) - bh / 2 - pos(1) + bh / 2;
972 int hstretch = width / image.getWidth();
973 if (hstretch == 0) hstretch = -1 * image.getWidth() / width;
974 int vstretch = height / image.getHeight();
975 if (vstretch == 0) vstretch = -1 * image.getHeight() / height;
977 if (hstretch < vstretch) {
978 height = image.getHeight() * width / image.getWidth();
980 width = image.getWidth() * height / image.getHeight();
984 buf.drawPicture(image,
987 pos(0) + bw / 2 + width,
988 pos(1) + bh / 2 + height,
989 0, 0, image.getWidth(), image.getHeight());
990 buf.setClip(0, 0, buf.getWidth(), buf.getHeight());
993 void renderTiledImage(int x, int y, int w, int h, DoubleBuffer buf) {
994 int iw = image.getWidth();
995 int ih = image.getHeight();
996 int bh = border == null ? 0 : border[4].getWidth();
997 int bw = border == null ? 0 : border[4].getHeight();
999 for(int i=(x - pos(0) - bw)/iw; i <= (x + w - pos(0) - bw)/iw; i++) {
1000 for(int j=(y - pos(1) - bh)/ih; j<= (y + h - pos(1) - bh)/ih; j++) {
1002 int dx1 = max(i * iw + pos(0), x);
1003 int dy1 = max(j * ih + pos(1), y);
1004 int dx2 = min((i+1) * iw + pos(0), x + w);
1005 int dy2 = min((j+1) * ih + pos(1), y + h);
1007 int sx1 = dx1 - (i*iw) - pos(0);
1008 int sy1 = dy1 - (j*ih) - pos(1);
1009 int sx2 = dx2 - (i*iw) - pos(0);
1010 int sy2 = dy2 - (j*ih) - pos(1);
1012 if (dx2 - dx1 > 0 && dy2 - dy1 > 0 && sx2 - sx1 > 0 && sy2 - sy1 > 0)
1013 buf.drawPicture(image, dx1, dy1, dx2, dy2, sx1, sy1, sx2, sy2);
1019 void renderText(int x, int y, int w, int h, DoubleBuffer buf) {
1021 if ((textcolor & 0xFF000000) == 0x00000000) return;
1022 buf.setClip(x, y, w + x, h + y);
1024 XWF xwf = XWF.getXWF(font());
1026 xwf.drawString(buf, text,
1028 pos(1) + pad(1) + xwf.getMaxAscent() - 1,
1031 buf.drawString(font(), text,
1033 pos(1) + pad(1) + Platform.getMaxAscent(font()) - 1,
1037 buf.setClip(0, 0, buf.getWidth(), buf.getHeight());
1039 int i=0; while(i<font().length() && !Character.isDigit(font().charAt(i))) i++;
1041 if (font().lastIndexOf('d') > i) {
1042 for(int j = pos(0) + pad(0); j < pos(0) + pad(0) + textdim(0); j += 2)
1043 buf.fillRect(j, pos(1) + pad(1) + (xwf == null ? Platform.getMaxAscent(font()) : xwf.getMaxAscent()) + 2,
1044 j + 1, pos(1) + pad(1) + (xwf == null ? Platform.getMaxAscent(font()) : xwf.getMaxAscent()) + 2 + 1,
1047 } else if (font().lastIndexOf('u') > i) {
1048 buf.fillRect(pos(0) + pad(0),
1049 pos(1) + pad(1) + (xwf == null ? Platform.getMaxAscent(font()) : xwf.getMaxAscent()) + 2,
1050 pos(0) + pad(0) + textdim(0),
1051 pos(1) + pad(1) + (xwf == null ? Platform.getMaxAscent(font()) : xwf.getMaxAscent()) + 2 + 1,
1058 // Methods to implement org.mozilla.javascript.Scriptable //////////////////////////////////////
1060 /** Returns the i_th child */
1061 public Object get(int i) {
1062 if (redirect == null) return null;
1063 if (redirect != this) return redirect.get(i);
1064 return i >= numChildren() || i < 0 ? null : getChild(i);
1068 * Inserts value as child i; calls remove() if necessary.
1069 * This method handles "reinserting" one of your children properly.
1070 * INVARIANT: after completion, getChild(min(i, numChildren())) == newnode
1071 * WARNING: O(n) runtime, unless i == numChildren()
1073 public void put(int i, Object value) {
1076 if (value != null && !(value instanceof Box)) {
1077 if (Log.on) Log.logJS(this, "attempt to set a numerical property on a box to anything other than a box");
1078 } else if (redirect == null) {
1079 if (Log.on) Log.logJS(this, "attempt to add/remove children to/from a node with a null redirect");
1080 } else if (redirect != this) {
1081 Box b = value == null ? (Box)redirect.get(i) : (Box)value;
1082 redirect.put(i, value);
1085 } else if (value == null) {
1086 if (i >= 0 && i < numChildren()) {
1087 Box b = getChild(i);
1092 } else if (value instanceof RootProxy) {
1093 if (Log.on) Log.logJS(this, "attempt to reparent a box via its proxy object");
1096 Box newnode = (Box)value;
1098 // check if box being moved is currently target of a redirect
1099 for(Box cur = newnode.getParent(); cur != null; cur = cur.getParent())
1100 if (cur.redirect == newnode) {
1101 if (Log.on) Log.logJS(this, "attempt to move a box that is the target of a redirect");
1105 // check for recursive ancestor violation
1106 for(Box cur = this; cur != null; cur = cur.getParent())
1107 if (cur == newnode) {
1108 if (Log.on) Log.logJS(this, "attempt to make a node a parent of its own ancestor");
1109 if (Log.on) Log.log(this, "box == " + this + " ancestor == " + newnode);
1113 if (numKids > 15 && children == null) convert_to_array();
1115 newnode.parent = this;
1117 if (children == null) {
1118 if (firstKid == null) {
1120 newnode.prevSibling = newnode;
1121 newnode.nextSibling = newnode;
1122 } else if (i >= numKids) {
1123 newnode.prevSibling = firstKid.prevSibling;
1124 newnode.nextSibling = firstKid;
1125 firstKid.prevSibling.nextSibling = newnode;
1126 firstKid.prevSibling = newnode;
1129 for(int j=0; j<i; j++) cur = cur.nextSibling;
1130 newnode.prevSibling = cur.prevSibling;
1131 newnode.nextSibling = cur;
1132 cur.prevSibling.nextSibling = newnode;
1133 cur.prevSibling = newnode;
1134 if (i == 0) firstKid = newnode;
1139 if (i >= children.size()) {
1140 newnode.indexInParent = children.size();
1141 children.addElement(newnode);
1143 children.insertElementAt(newnode, i);
1144 for(int j=i; j<children.size(); j++)
1145 getChild(j).indexInParent = j;
1148 newnode.setSurface(surface);
1150 // need both of these in case child was already uncalc'ed
1151 newnode.mark_for_prerender();
1152 mark_for_prerender();
1155 sync_cmin_to_children();
1157 // note that JavaScript box[0] will invoke put(int i), not put(String s)
1162 public Object get(Object name) { return get(name, false); }
1163 public Object get(Object name_, boolean ignoretraps) {
1164 if (name_ instanceof Number) return get(((Number)name_).intValue());
1166 if (!(name_ instanceof String)) return null;
1167 String name = (String)name_;
1168 if (name.equals("")) return null;
1170 // See if we're reading back the function value of a trap
1171 if (name.charAt(0) == '_') {
1172 if (name.charAt(1) == '_') name = name.substring(2);
1173 else name = name.substring(1);
1174 Trap t = Trap.getTrap(this, name);
1175 return t == null ? null : t.f;
1178 // See if we're triggering a trap
1179 Trap t = traps == null || ignoretraps ? null : (Trap)traps.get(name);
1180 if (t != null && t.isreadtrap) return t.perform(emptyobj);
1182 // Check for a special handler
1183 SpecialBoxProperty gph = (SpecialBoxProperty)SpecialBoxProperty.specialBoxProperties.get(name);
1184 if (gph != null) return gph.get(this);
1186 Object ret = super.get(name);
1187 if (name.startsWith("$") && ret == null)
1188 if (Log.on) Log.logJS(this, "WARNING: attempt to access " + name + ", but no child with id=\"" + name.substring(1) + "\" found");
1192 public Object[] keys() {
1193 Object[] ret = new Object[numChildren()];
1194 for(int i=0; i<ret.length; i++) ret[i] = new Integer(i);
1200 * @param ignoretraps if set, no traps will be triggered (set when 'cascade' reaches the bottom of the trap stack)
1201 * @param rp if this put is being performed via a root proxy, rp is the root proxy.
1203 public void put(Object name, Object value) { put(name, value, false, null); }
1204 public void put(Object name, Object value, boolean ignoretraps) { put(name, value, ignoretraps, null); }
1205 public void put(Object name_, Object value, boolean ignoretraps, RootProxy rp) {
1206 if (name_ instanceof Number) { put(((Number)name_).intValue(), value); return; }
1207 if (!(name_ instanceof String)) { super.put(name_,value); return; }
1208 String name = name_.toString();
1209 if (name == null) return; // FIXME, shouldn't be necessary
1210 if (name.startsWith("xwt_")) {
1211 if (Log.on) Log.logJS(this, "attempt to set reserved property " + name);
1215 if (!ignoretraps && traps != null) {
1216 Trap t = (Trap)traps.get(name);
1218 JS.Array arg = new JS.Array();
1219 arg.addElement(value);
1221 arg.setElementAt(null, 0);
1226 // don't want to really cascade down to the box on this one
1227 if (name.equals("0")) return;
1229 SpecialBoxProperty gph = (SpecialBoxProperty)SpecialBoxProperty.specialBoxProperties.get(name);
1231 gph.put(name, this, value);
1235 if (name.charAt(0) == '_') {
1236 if (value != null && !(value instanceof JS.Callable)) {
1237 if (Log.on) Log.logJS(this, "attempt to put a non function value (" + value + ") to " + name);
1238 } else if (value != null && !(value instanceof JS.CompiledFunction)) {
1239 if (Log.on) Log.logJS(this, "attempt to put a non-compiled function value (" + value + ") to " + name);
1240 } else if (name.charAt(1) == '_') {
1241 name = name.substring(2).intern();
1242 Trap t = Trap.getTrap(this, name);
1243 if (t != null) t.delete();
1244 if (value != null) Trap.addTrap(this, name, ((JS.CompiledFunction)value), true, rp);
1246 name = name.substring(1).intern();
1247 Trap t = Trap.getTrap(this, name);
1248 if (t != null) t.delete();
1249 if (value != null) Trap.addTrap(this, name, ((JS.CompiledFunction)value), false, rp);
1254 super.put(name, value);
1256 // a bit of a hack, since titlebar is the only 'special' property stored in JSObject
1257 if (getParent() == null && surface != null) {
1258 if (name.equals("titlebar")) surface.setTitleBarText(value.toString());
1259 if (name.equals("icon")) {
1260 Picture pic = Box.getPicture(value.toString());
1261 if (pic != null) surface.setIcon(pic);
1262 else if (Log.on) Log.log(this, "unable to load icon " + value);
1268 // Tree Manipulation /////////////////////////////////////////////////////////////////////
1270 /** The parent of this node */
1271 private Box parent = null;
1273 // Variables used in Vector mode */
1274 /** INVARIANT: if (parent != null) parent.children.elementAt(indexInParent) == this */
1275 private int indexInParent;
1276 private Vec children = null;
1278 // Variables used in linked-list mode
1279 private int numKids = 0;
1280 private Box nextSibling = null;
1281 private Box prevSibling = null;
1282 private Box firstKid = null;
1284 // when we get more than 15 children, we switch to array-mode
1285 private void convert_to_array() {
1286 children = new Vec(numKids);
1289 children.addElement(cur);
1290 cur.indexInParent = children.size() - 1;
1291 cur = cur.nextSibling;
1292 } while (cur != firstKid);
1295 /** remove this node from its parent; INVARIANT: whenever the parent of a node is changed, remove() gets called. */
1296 public void remove() {
1298 if (parent == null) {
1299 if (surface != null) surface.dispose(true);
1302 Box oldparent = getParent();
1303 if (oldparent == null) return;
1304 mark_for_prerender();
1306 mouseinside = false;
1308 if (parent.children != null) {
1309 parent.children.removeElementAt(indexInParent);
1310 for(int j=indexInParent; j<parent.children.size(); j++)
1311 (parent.getChild(j)).indexInParent = j;
1314 if (parent.firstKid == this) {
1315 if (nextSibling == this) parent.firstKid = null;
1316 else parent.firstKid = nextSibling;
1319 prevSibling.nextSibling = nextSibling;
1320 nextSibling.prevSibling = prevSibling;
1326 if (oldparent != null) oldparent.sync_cmin_to_children();
1329 // note that JavaScript box[0] will invoke put(int i), not put(String s)
1330 if (oldparent != null) oldparent.put("0", this);
1333 /** returns our next sibling (parent[ourindex + 1]) */
1334 public final Box nextSibling() {
1335 if (parent == null) return null;
1336 if (parent.children == null) {
1337 if (nextSibling == parent.firstKid) return null;
1340 if (indexInParent >= parent.children.size() - 1) return null;
1341 return (Box)parent.children.elementAt(indexInParent + 1);
1345 /** returns our next sibling (parent[ourindex + 1]) */
1346 public final Box prevSibling() {
1347 if (parent == null) return null;
1348 if (parent.children == null) {
1349 if (this == parent.firstKid) return null;
1352 if (indexInParent == 0) return null;
1353 return (Box)parent.children.elementAt(indexInParent - 1);
1357 /** Returns the parent of this node */
1358 public Box getParent() { return parent; }
1360 /** Returns ith child */
1361 public Box getChild(int i) {
1362 if (children == null) {
1363 if (firstKid == null) return null;
1364 if (i >= numKids) return null;
1365 if (i == numKids - 1) return firstKid.prevSibling;
1367 for(int j=0; j<i; j++) cur = cur.nextSibling;
1370 if (i >= children.size() || i < 0) return null;
1371 return (Box)children.elementAt(i);
1375 /** Returns the number of children */
1376 public int numChildren() {
1377 if (children == null) {
1378 if (firstKid == null) return 0;
1380 for(Box cur = firstKid.nextSibling; cur != firstKid; i++) cur = cur.nextSibling;
1383 return children.size();
1387 /** Returns our index in our parent */
1388 public int getIndexInParent() {
1389 if (parent == null) return 0;
1390 if (parent.children == null) {
1392 for(Box cur = this; cur != parent.firstKid; i++) cur = cur.prevSibling;
1395 return indexInParent;
1399 /** returns the root of the surface that this box belongs to */
1400 public final Box getRoot() {
1401 if (getParent() == null && surface != null) return this;
1402 if (getParent() == null) return null;
1403 return getParent().getRoot();
1407 // Root Proxy ///////////////////////////////////////////////////////////////////////////////
1409 RootProxy myproxy = null;
1410 public JS getRootProxy() {
1411 if (myproxy == null) myproxy = new RootProxy(this);
1415 private static class RootProxy extends JS {
1417 RootProxy(Box b) { this.box = b; }
1418 public Object get(Object name) { return box.get(name); }
1419 public void put(Object name, Object value) { box.put(name, value, false, this); }
1420 public Object[] keys() { return box.keys(); }
1424 // Trivial Helper Methods (should be inlined) /////////////////////////////////////////
1426 /** helper, included in this class so it can be inlined */
1427 static final int min(int a, int b) {
1432 /** helper, included in this class so it can be inlined */
1433 static final double min(double a, double b) {
1438 /** helper, included in this class so it can be inlined */
1439 static final int max(int a, int b) {
1444 /** helper, included in this class so it can be inlined */
1445 static final int min(int a, int b, int c) {
1446 if (a<=b && a<=c) return a;
1447 else if (b<=c && b<=a) return b;
1451 /** helper, included in this class so it can be inlined */
1452 static final int max(int a, int b, int c) {
1453 if (a>=b && a>=c) return a;
1454 else if (b>=c && b>=a) return b;
1458 /** helper, included in this class so it can be inlined */
1459 static final int bound(int a, int b, int c) {
1460 if (c < b) return c;
1461 if (a > b) return a;
1465 /** returns numerator/denominator, but rounds <i>up</i> instead of down */
1466 static final int divide_round_up(int numerator, int denominator) {
1468 // cope with bozos who use flex==0.0
1469 if (denominator == 0) return Integer.MAX_VALUE;
1471 int ret = numerator / denominator;
1472 if (ret * denominator < numerator) return ret + 1;
1476 /** Simple helper function to determine if the point x,y falls within this node's actual current geometry */
1477 boolean inside(int x, int y) {
1478 if (invisible) return false;
1479 return (x >= pos(0) && y >= pos(1) && x < pos(0) + size(0) && y < pos(1) + size(1));
1482 /** figures out what box in this subtree of the Box owns the pixel at x,y relitave to the Surface
1484 * IMPORTANT: this method gets called from the event-queueing thread, since we need to determine which box is
1485 * underneath the mouse as early as possible. Because of this, we have to do some extra checks, as the
1486 * Box tree may be in flux.
1488 Box whoIs(int x, int y) {
1489 if (invisible) return null;
1490 if (!inside(x,y)) return getParent() == null ? this : null;
1492 // We do this because whoIs is unsynchronized (for
1493 // speed), yet is sometimes called while the structure of the
1495 for(int i=numChildren() - 1; i>=0; i--) {
1497 Box child = getChild(i);
1498 if (child == null) continue;
1500 Box bt = child.whoIs(x,y);
1501 if (bt != null) return bt;
1506 // This is the name returned by typeof() by JS
1507 public String typeName() {