2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import java
.awt
.image
.BufferedImage
;
32 import java
.io
.IOException
;
33 import java
.util
.List
;
34 import java
.util
.ArrayList
;
36 import jexer
.backend
.Screen
;
37 import jexer
.bits
.Cell
;
38 import jexer
.bits
.CellAttributes
;
39 import jexer
.bits
.ColorTheme
;
40 import jexer
.event
.TCommandEvent
;
41 import jexer
.event
.TInputEvent
;
42 import jexer
.event
.TKeypressEvent
;
43 import jexer
.event
.TMenuEvent
;
44 import jexer
.event
.TMouseEvent
;
45 import jexer
.event
.TResizeEvent
;
46 import jexer
.layout
.LayoutManager
;
47 import jexer
.menu
.TMenu
;
48 import jexer
.ttree
.TTreeItem
;
49 import jexer
.ttree
.TTreeView
;
50 import jexer
.ttree
.TTreeViewWidget
;
51 import static jexer
.TKeypress
.*;
54 * TWidget is the base class of all objects that can be drawn on screen or
55 * handle user input events.
57 public abstract class TWidget
implements Comparable
<TWidget
> {
59 // ------------------------------------------------------------------------
60 // Variables --------------------------------------------------------------
61 // ------------------------------------------------------------------------
64 * Every widget has a parent widget that it may be "contained" in. For
65 * example, a TWindow might contain several TFields, or a TComboBox may
66 * contain a TList that itself contains a TVScroller.
68 private TWidget parent
= null;
71 * Child widgets that this widget contains.
73 private List
<TWidget
> children
;
76 * The currently active child widget that will receive keypress events.
78 private TWidget activeChild
= null;
81 * If true, this widget will receive events.
83 private boolean active
= false;
86 * The window that this widget draws to.
88 private TWindow window
= null;
91 * Absolute X position of the top-left corner.
96 * Absolute Y position of the top-left corner.
103 private int width
= 0;
108 private int height
= 0;
111 * My tab order inside a window or containing widget.
113 private int tabOrder
= 0;
116 * If true, this widget can be tabbed to or receive events.
118 private boolean enabled
= true;
121 * If true, this widget will be rendered.
123 private boolean visible
= true;
126 * If true, this widget has a cursor.
128 private boolean cursorVisible
= false;
131 * Cursor column position in relative coordinates.
133 private int cursorX
= 0;
136 * Cursor row position in relative coordinates.
138 private int cursorY
= 0;
143 private LayoutManager layout
= null;
145 // ------------------------------------------------------------------------
146 // Constructors -----------------------------------------------------------
147 // ------------------------------------------------------------------------
150 * Default constructor for subclasses.
152 protected TWidget() {
153 children
= new ArrayList
<TWidget
>();
157 * Protected constructor.
159 * @param parent parent widget
161 protected TWidget(final TWidget parent
) {
166 * Protected constructor.
168 * @param parent parent widget
169 * @param x column relative to parent
170 * @param y row relative to parent
171 * @param width width of widget
172 * @param height height of widget
174 protected TWidget(final TWidget parent
, final int x
, final int y
,
175 final int width
, final int height
) {
177 this(parent
, true, x
, y
, width
, height
);
181 * Protected constructor used by subclasses that are disabled by default.
183 * @param parent parent widget
184 * @param enabled if true assume enabled
186 protected TWidget(final TWidget parent
, final boolean enabled
) {
187 this.enabled
= enabled
;
188 this.parent
= parent
;
189 children
= new ArrayList
<TWidget
>();
191 if (parent
!= null) {
192 this.window
= parent
.window
;
193 parent
.addChild(this);
198 * Protected constructor used by subclasses that are disabled by default.
200 * @param parent parent widget
201 * @param enabled if true assume enabled
202 * @param x column relative to parent
203 * @param y row relative to parent
204 * @param width width of widget
205 * @param height height of widget
207 protected TWidget(final TWidget parent
, final boolean enabled
,
208 final int x
, final int y
, final int width
, final int height
) {
211 throw new IllegalArgumentException("width cannot be negative");
214 throw new IllegalArgumentException("height cannot be negative");
217 this.enabled
= enabled
;
218 this.parent
= parent
;
219 children
= new ArrayList
<TWidget
>();
224 this.height
= height
;
226 if (parent
!= null) {
227 this.window
= parent
.window
;
228 parent
.addChild(this);
233 * Backdoor access for TWindow's constructor. ONLY TWindow USES THIS.
235 * @param window the top-level window
236 * @param x column relative to parent
237 * @param y row relative to parent
238 * @param width width of window
239 * @param height height of window
241 protected final void setupForTWindow(final TWindow window
,
242 final int x
, final int y
, final int width
, final int height
) {
245 throw new IllegalArgumentException("width cannot be negative");
248 throw new IllegalArgumentException("height cannot be negative");
251 this.parent
= window
;
252 this.window
= window
;
256 this.height
= height
;
259 // ------------------------------------------------------------------------
260 // Event handlers ---------------------------------------------------------
261 // ------------------------------------------------------------------------
264 * Subclasses should override this method to cleanup resources. This is
265 * called by TWindow.onClose().
267 protected void close() {
268 // Default: call close() on children.
269 for (TWidget w
: getChildren()) {
275 * Check if a mouse press/release event coordinate is contained in this
278 * @param mouse a mouse-based event
279 * @return whether or not a mouse click would be sent to this widget
281 public final boolean mouseWouldHit(final TMouseEvent mouse
) {
287 if ((this instanceof TTreeItem
)
288 && ((y
< 0) || (y
> parent
.getHeight() - 1))
293 if ((mouse
.getAbsoluteX() >= getAbsoluteX())
294 && (mouse
.getAbsoluteX() < getAbsoluteX() + width
)
295 && (mouse
.getAbsoluteY() >= getAbsoluteY())
296 && (mouse
.getAbsoluteY() < getAbsoluteY() + height
)
304 * Method that subclasses can override to handle keystrokes.
306 * @param keypress keystroke event
308 public void onKeypress(final TKeypressEvent keypress
) {
309 assert (parent
!= null);
311 if ((children
.size() == 0)
312 || (this instanceof TTreeView
)
313 || (this instanceof TText
)
314 || (this instanceof TComboBox
)
318 // tab / shift-tab - switch to next/previous widget
319 // left-arrow or up-arrow: same as shift-tab
320 if ((keypress
.equals(kbTab
))
321 || (keypress
.equals(kbDown
) && !(this instanceof TComboBox
))
323 parent
.switchWidget(true);
325 } else if ((keypress
.equals(kbShiftTab
))
326 || (keypress
.equals(kbBackTab
))
327 || (keypress
.equals(kbUp
) && !(this instanceof TComboBox
))
329 parent
.switchWidget(false);
334 if ((children
.size() == 0)
335 && !(this instanceof TTreeView
)
339 // right-arrow or down-arrow: same as tab
340 if (keypress
.equals(kbRight
)) {
341 parent
.switchWidget(true);
343 } else if (keypress
.equals(kbLeft
)) {
344 parent
.switchWidget(false);
349 // If I have any buttons on me AND this is an Alt-key that matches
350 // its mnemonic, send it an Enter keystroke.
351 for (TWidget widget
: children
) {
352 if (widget
instanceof TButton
) {
353 TButton button
= (TButton
) widget
;
354 if (button
.isEnabled()
355 && !keypress
.getKey().isFnKey()
356 && keypress
.getKey().isAlt()
357 && !keypress
.getKey().isCtrl()
358 && (Character
.toLowerCase(button
.getMnemonic().getShortcut())
359 == Character
.toLowerCase(keypress
.getKey().getChar()))
362 widget
.onKeypress(new TKeypressEvent(kbEnter
));
368 // If I have any labels on me AND this is an Alt-key that matches
369 // its mnemonic, call its action.
370 for (TWidget widget
: children
) {
371 if (widget
instanceof TLabel
) {
372 TLabel label
= (TLabel
) widget
;
373 if (!keypress
.getKey().isFnKey()
374 && keypress
.getKey().isAlt()
375 && !keypress
.getKey().isCtrl()
376 && (Character
.toLowerCase(label
.getMnemonic().getShortcut())
377 == Character
.toLowerCase(keypress
.getKey().getChar()))
386 // If I have any radiobuttons on me AND this is an Alt-key that
387 // matches its mnemonic, select it and send a Space to it.
388 for (TWidget widget
: children
) {
389 if (widget
instanceof TRadioButton
) {
390 TRadioButton button
= (TRadioButton
) widget
;
391 if (button
.isEnabled()
392 && !keypress
.getKey().isFnKey()
393 && keypress
.getKey().isAlt()
394 && !keypress
.getKey().isCtrl()
395 && (Character
.toLowerCase(button
.getMnemonic().getShortcut())
396 == Character
.toLowerCase(keypress
.getKey().getChar()))
399 widget
.onKeypress(new TKeypressEvent(kbSpace
));
403 if (widget
instanceof TRadioGroup
) {
404 for (TWidget child
: widget
.getChildren()) {
405 if (child
instanceof TRadioButton
) {
406 TRadioButton button
= (TRadioButton
) child
;
407 if (button
.isEnabled()
408 && !keypress
.getKey().isFnKey()
409 && keypress
.getKey().isAlt()
410 && !keypress
.getKey().isCtrl()
411 && (Character
.toLowerCase(button
.getMnemonic().getShortcut())
412 == Character
.toLowerCase(keypress
.getKey().getChar()))
415 widget
.activate(child
);
416 child
.onKeypress(new TKeypressEvent(kbSpace
));
424 // If I have any checkboxes on me AND this is an Alt-key that matches
425 // its mnemonic, select it and set it to checked.
426 for (TWidget widget
: children
) {
427 if (widget
instanceof TCheckBox
) {
428 TCheckBox checkBox
= (TCheckBox
) widget
;
429 if (checkBox
.isEnabled()
430 && !keypress
.getKey().isFnKey()
431 && keypress
.getKey().isAlt()
432 && !keypress
.getKey().isCtrl()
433 && (Character
.toLowerCase(checkBox
.getMnemonic().getShortcut())
434 == Character
.toLowerCase(keypress
.getKey().getChar()))
437 checkBox
.setChecked(true);
443 // Dispatch the keypress to an active widget
444 for (TWidget widget
: children
) {
446 widget
.onKeypress(keypress
);
453 * Method that subclasses can override to handle mouse button presses.
455 * @param mouse mouse button event
457 public void onMouseDown(final TMouseEvent mouse
) {
458 // Default: do nothing, pass to children instead
459 if (activeChild
!= null) {
460 if (activeChild
.mouseWouldHit(mouse
)) {
461 // Dispatch to the active child
463 // Set x and y relative to the child's coordinates
464 mouse
.setX(mouse
.getAbsoluteX() - activeChild
.getAbsoluteX());
465 mouse
.setY(mouse
.getAbsoluteY() - activeChild
.getAbsoluteY());
466 activeChild
.onMouseDown(mouse
);
470 for (int i
= children
.size() - 1 ; i
>= 0 ; i
--) {
471 TWidget widget
= children
.get(i
);
472 if (widget
.mouseWouldHit(mouse
)) {
473 // Dispatch to this child, also activate it
476 // Set x and y relative to the child's coordinates
477 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
478 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
479 widget
.onMouseDown(mouse
);
486 * Method that subclasses can override to handle mouse button releases.
488 * @param mouse mouse button event
490 public void onMouseUp(final TMouseEvent mouse
) {
491 // Default: do nothing, pass to children instead
492 if (activeChild
!= null) {
493 if (activeChild
.mouseWouldHit(mouse
)) {
494 // Dispatch to the active child
496 // Set x and y relative to the child's coordinates
497 mouse
.setX(mouse
.getAbsoluteX() - activeChild
.getAbsoluteX());
498 mouse
.setY(mouse
.getAbsoluteY() - activeChild
.getAbsoluteY());
499 activeChild
.onMouseUp(mouse
);
503 for (int i
= children
.size() - 1 ; i
>= 0 ; i
--) {
504 TWidget widget
= children
.get(i
);
505 if (widget
.mouseWouldHit(mouse
)) {
506 // Dispatch to this child, also activate it
509 // Set x and y relative to the child's coordinates
510 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
511 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
512 widget
.onMouseUp(mouse
);
519 * Method that subclasses can override to handle mouse movements.
521 * @param mouse mouse motion event
523 public void onMouseMotion(final TMouseEvent mouse
) {
524 // Default: do nothing, pass it on to ALL of my children. This way
525 // the children can see the mouse "leaving" their area.
526 for (TWidget widget
: children
) {
527 // Set x and y relative to the child's coordinates
528 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
529 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
530 widget
.onMouseMotion(mouse
);
535 * Method that subclasses can override to handle mouse button
538 * @param mouse mouse button event
540 public void onMouseDoubleClick(final TMouseEvent mouse
) {
541 // Default: do nothing, pass to children instead
542 if (activeChild
!= null) {
543 if (activeChild
.mouseWouldHit(mouse
)) {
544 // Dispatch to the active child
546 // Set x and y relative to the child's coordinates
547 mouse
.setX(mouse
.getAbsoluteX() - activeChild
.getAbsoluteX());
548 mouse
.setY(mouse
.getAbsoluteY() - activeChild
.getAbsoluteY());
549 activeChild
.onMouseDoubleClick(mouse
);
553 for (int i
= children
.size() - 1 ; i
>= 0 ; i
--) {
554 TWidget widget
= children
.get(i
);
555 if (widget
.mouseWouldHit(mouse
)) {
556 // Dispatch to this child, also activate it
559 // Set x and y relative to the child's coordinates
560 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
561 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
562 widget
.onMouseDoubleClick(mouse
);
569 * Method that subclasses can override to handle window/screen resize
572 * @param resize resize event
574 public void onResize(final TResizeEvent resize
) {
575 // Default: change my width/height.
576 if (resize
.getType() == TResizeEvent
.Type
.WIDGET
) {
577 width
= resize
.getWidth();
578 height
= resize
.getHeight();
579 if (layout
!= null) {
580 if (this instanceof TWindow
) {
581 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
582 width
- 2, height
- 2));
584 layout
.onResize(resize
);
588 // Let children see the screen resize
589 for (TWidget widget
: children
) {
590 widget
.onResize(resize
);
596 * Method that subclasses can override to handle posted command events.
598 * @param command command event
600 public void onCommand(final TCommandEvent command
) {
601 // Default: do nothing, pass to children instead
602 for (TWidget widget
: children
) {
603 widget
.onCommand(command
);
608 * Method that subclasses can override to handle menu or posted menu
611 * @param menu menu event
613 public void onMenu(final TMenuEvent menu
) {
614 // Default: do nothing, pass to children instead
615 for (TWidget widget
: children
) {
621 * Method that subclasses can override to do processing when the UI is
622 * idle. Note that repainting is NOT assumed. To get a refresh after
623 * onIdle, call doRepaint().
625 public void onIdle() {
626 // Default: do nothing, pass to children instead
627 for (TWidget widget
: children
) {
633 * Consume event. Subclasses that want to intercept all events in one go
634 * can override this method.
636 * @param event keyboard, mouse, resize, command, or menu event
638 public void handleEvent(final TInputEvent event
) {
640 System.err.printf("TWidget (%s) event: %s\n", this.getClass().getName(),
646 // System.err.println(" -- discard --");
650 if (event
instanceof TKeypressEvent
) {
651 onKeypress((TKeypressEvent
) event
);
652 } else if (event
instanceof TMouseEvent
) {
654 TMouseEvent mouse
= (TMouseEvent
) event
;
656 switch (mouse
.getType()) {
667 onMouseMotion(mouse
);
670 case MOUSE_DOUBLE_CLICK
:
671 onMouseDoubleClick(mouse
);
675 throw new IllegalArgumentException("Invalid mouse event type: "
678 } else if (event
instanceof TResizeEvent
) {
679 onResize((TResizeEvent
) event
);
680 } else if (event
instanceof TCommandEvent
) {
681 onCommand((TCommandEvent
) event
);
682 } else if (event
instanceof TMenuEvent
) {
683 onMenu((TMenuEvent
) event
);
690 // ------------------------------------------------------------------------
691 // TWidget ----------------------------------------------------------------
692 // ------------------------------------------------------------------------
697 * @return parent widget
699 public final TWidget
getParent() {
704 * Get the list of child widgets that this widget contains.
706 * @return the list of child widgets
708 public List
<TWidget
> getChildren() {
713 * Remove this widget from its parent container. close() will be called
714 * before it is removed.
716 public final void remove() {
721 * Remove this widget from its parent container.
723 * @param doClose if true, call the close() method before removing the
726 public final void remove(final boolean doClose
) {
727 if (parent
!= null) {
728 parent
.remove(this, doClose
);
733 * Remove a child widget from this container.
735 * @param child the child widget to remove
737 public final void remove(final TWidget child
) {
742 * Remove a child widget from this container.
744 * @param child the child widget to remove
745 * @param doClose if true, call the close() method before removing the
748 public final void remove(final TWidget child
, final boolean doClose
) {
749 if (!children
.contains(child
)) {
750 throw new IndexOutOfBoundsException("child widget is not in " +
751 "list of children of this parent");
756 children
.remove(child
);
759 if (layout
!= null) {
765 * Set this widget's parent to a different widget.
767 * @param newParent new parent widget
768 * @param doClose if true, call the close() method before removing the
769 * child from its existing parent widget
771 public final void setParent(final TWidget newParent
,
772 final boolean doClose
) {
774 if (parent
!= null) {
775 parent
.remove(this, doClose
);
778 assert (parent
== null);
779 assert (window
== null);
781 setWindow(parent
.window
);
782 parent
.addChild(this);
786 * Set this widget's window to a specific window.
788 * Having a null parent with a specified window is only used within Jexer
789 * by TStatusBar because TApplication routes events directly to it and
790 * calls its draw() method. Any other non-parented widgets will require
791 * similar special case functionality to receive events or be drawn to
794 * @param window the window to use
796 public final void setWindow(final TWindow window
) {
797 this.window
= window
;
798 for (TWidget child
: getChildren()) {
799 child
.setWindow(window
);
804 * Remove a child widget from this container, and all of its children
805 * recursively from their parent containers.
807 * @param child the child widget to remove
808 * @param doClose if true, call the close() method before removing each
811 public final void removeAll(final TWidget child
, final boolean doClose
) {
812 remove(child
, doClose
);
813 for (TWidget w
: child
.children
) {
814 child
.removeAll(w
, doClose
);
821 * @return if true, this widget will receive events
823 public final boolean isActive() {
830 * @param active if true, this widget will receive events
832 public final void setActive(final boolean active
) {
833 this.active
= active
;
837 * Get the window this widget is on.
841 public final TWindow
getWindow() {
848 * @return absolute X position of the top-left corner
850 public final int getX() {
857 * @param x absolute X position of the top-left corner
859 public final void setX(final int x
) {
866 * @return absolute Y position of the top-left corner
868 public final int getY() {
875 * @param y absolute Y position of the top-left corner
877 public final void setY(final int y
) {
884 * @return widget width
886 public int getWidth() {
893 * @param width new widget width
895 public void setWidth(final int width
) {
897 if (layout
!= null) {
898 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
906 * @return widget height
908 public int getHeight() {
915 * @param height new widget height
917 public void setHeight(final int height
) {
918 this.height
= height
;
919 if (layout
!= null) {
920 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
926 * Change the dimensions.
928 * @param x absolute X position of the top-left corner
929 * @param y absolute Y position of the top-left corner
930 * @param width new widget width
931 * @param height new widget height
933 public final void setDimensions(final int x
, final int y
, final int width
,
939 this.height
= height
;
940 if (layout
!= null) {
941 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
947 * Get the layout manager.
949 * @return the layout manager, or null if not set
951 public LayoutManager
getLayoutManager() {
956 * Set the layout manager.
958 * @param layout the new layout manager
960 public void setLayoutManager(LayoutManager layout
) {
961 if (this.layout
!= null) {
962 for (TWidget w
: children
) {
963 this.layout
.remove(w
);
967 this.layout
= layout
;
968 if (this.layout
!= null) {
969 for (TWidget w
: children
) {
978 * @return if true, this widget can be tabbed to or receive events
980 public final boolean isEnabled() {
987 * @param enabled if true, this widget can be tabbed to or receive events
989 public final void setEnabled(final boolean enabled
) {
990 this.enabled
= enabled
;
993 // See if there are any active siblings to switch to
994 boolean foundSibling
= false;
995 if (parent
!= null) {
996 for (TWidget w
: parent
.children
) {
998 && !(this instanceof THScroller
)
999 && !(this instanceof TVScroller
)
1002 foundSibling
= true;
1006 if (!foundSibling
) {
1007 parent
.activeChild
= null;
1016 * @param visible if true, this widget will be drawn
1018 public final void setVisible(final boolean visible
) {
1019 this.visible
= visible
;
1023 * See if this widget is visible.
1025 * @return if true, this widget will be drawn
1027 public final boolean isVisible() {
1032 * Set visible cursor flag.
1034 * @param cursorVisible if true, this widget has a cursor
1036 public final void setCursorVisible(final boolean cursorVisible
) {
1037 this.cursorVisible
= cursorVisible
;
1041 * See if this widget has a visible cursor.
1043 * @return if true, this widget has a visible cursor
1045 public final boolean isCursorVisible() {
1046 // If cursor is out of my bounds, it is not visible.
1047 if ((cursorX
>= width
)
1049 || (cursorY
>= height
)
1055 assert (window
!= null);
1057 if (window
instanceof TDesktop
) {
1058 // Desktop doesn't have a window border.
1059 return cursorVisible
;
1062 // If cursor is out of my window's bounds, it is not visible.
1063 if ((getCursorAbsoluteX() >= window
.getAbsoluteX()
1064 + window
.getWidth() - 1)
1065 || (getCursorAbsoluteX() < 0)
1066 || (getCursorAbsoluteY() >= window
.getAbsoluteY()
1067 + window
.getHeight() - 1)
1068 || (getCursorAbsoluteY() < 0)
1072 return cursorVisible
;
1076 * Get cursor X value.
1078 * @return cursor column position in relative coordinates
1080 public final int getCursorX() {
1085 * Set cursor X value.
1087 * @param cursorX column position in relative coordinates
1089 public final void setCursorX(final int cursorX
) {
1090 this.cursorX
= cursorX
;
1094 * Get cursor Y value.
1096 * @return cursor row position in relative coordinates
1098 public final int getCursorY() {
1103 * Set cursor Y value.
1105 * @param cursorY row position in relative coordinates
1107 public final void setCursorY(final int cursorY
) {
1108 this.cursorY
= cursorY
;
1112 * Get this TWidget's parent TApplication.
1114 * @return the parent TApplication, or null if not assigned
1116 public TApplication
getApplication() {
1117 if (window
!= null) {
1118 return window
.getApplication();
1126 * @return the Screen, or null if not assigned
1128 public Screen
getScreen() {
1129 if (window
!= null) {
1130 return window
.getScreen();
1136 * Comparison operator. For various subclasses it sorts on:
1138 * <li>tabOrder for TWidgets</li>
1139 * <li>z for TWindows</li>
1140 * <li>text for TTreeItems</li>
1143 * @param that another TWidget, TWindow, or TTreeItem instance
1144 * @return difference between this.tabOrder and that.tabOrder, or
1145 * difference between this.z and that.z, or String.compareTo(text)
1147 public final int compareTo(final TWidget that
) {
1148 if ((this instanceof TWindow
)
1149 && (that
instanceof TWindow
)
1151 return (((TWindow
) this).getZ() - ((TWindow
) that
).getZ());
1153 if ((this instanceof TTreeItem
)
1154 && (that
instanceof TTreeItem
)
1156 return (((TTreeItem
) this).getText().compareTo(
1157 ((TTreeItem
) that
).getText()));
1159 return (this.tabOrder
- that
.tabOrder
);
1163 * See if this widget should render with the active color.
1165 * @return true if this widget is active and all of its parents are
1168 public final boolean isAbsoluteActive() {
1169 if (parent
== this) {
1172 return (active
&& (parent
== null ?
true : parent
.isAbsoluteActive()));
1176 * Returns the cursor X position.
1178 * @return absolute screen column number for the cursor's X position
1180 public final int getCursorAbsoluteX() {
1181 return getAbsoluteX() + cursorX
;
1185 * Returns the cursor Y position.
1187 * @return absolute screen row number for the cursor's Y position
1189 public final int getCursorAbsoluteY() {
1190 return getAbsoluteY() + cursorY
;
1194 * Compute my absolute X position as the sum of my X plus all my parent's
1197 * @return absolute screen column number for my X position
1199 public final int getAbsoluteX() {
1200 assert (parent
!= null);
1201 if (parent
== this) {
1204 if ((parent
instanceof TWindow
)
1205 && !(parent
instanceof TMenu
)
1206 && !(parent
instanceof TDesktop
)
1208 // Widgets on a TWindow have (0,0) as their top-left, but this is
1209 // actually the TWindow's (1,1).
1210 return parent
.getAbsoluteX() + x
+ 1;
1212 return parent
.getAbsoluteX() + x
;
1216 * Compute my absolute Y position as the sum of my Y plus all my parent's
1219 * @return absolute screen row number for my Y position
1221 public final int getAbsoluteY() {
1222 assert (parent
!= null);
1223 if (parent
== this) {
1226 if ((parent
instanceof TWindow
)
1227 && !(parent
instanceof TMenu
)
1228 && !(parent
instanceof TDesktop
)
1230 // Widgets on a TWindow have (0,0) as their top-left, but this is
1231 // actually the TWindow's (1,1).
1232 return parent
.getAbsoluteY() + y
+ 1;
1234 return parent
.getAbsoluteY() + y
;
1238 * Get the global color theme.
1240 * @return the ColorTheme
1242 protected final ColorTheme
getTheme() {
1243 return window
.getApplication().getTheme();
1247 * See if this widget can be drawn onto a screen.
1249 * @return true if this widget is part of the hierarchy that can draw to
1252 public final boolean isDrawable() {
1253 if ((window
== null)
1254 || (window
.getScreen() == null)
1259 if (parent
== this) {
1262 return (parent
.isDrawable());
1266 * Draw my specific widget. When called, the screen rectangle I draw
1267 * into is already setup (offset and clipping).
1269 public void draw() {
1270 // Default widget draws nothing.
1274 * Called by parent to render to TWindow. Note package private access.
1276 final void drawChildren() {
1277 if (!isDrawable()) {
1281 // Set my clipping rectangle
1282 assert (window
!= null);
1283 assert (getScreen() != null);
1284 Screen screen
= getScreen();
1286 // Special case: TStatusBar is drawn by TApplication, not anything
1288 if (this instanceof TStatusBar
) {
1292 screen
.setClipRight(width
);
1293 screen
.setClipBottom(height
);
1295 int absoluteRightEdge
= window
.getAbsoluteX() + window
.getWidth();
1296 int absoluteBottomEdge
= window
.getAbsoluteY() + window
.getHeight();
1297 if (!(this instanceof TWindow
)
1298 && !(this instanceof TVScroller
)
1299 && !(window
instanceof TDesktop
)
1301 absoluteRightEdge
-= 1;
1303 if (!(this instanceof TWindow
)
1304 && !(this instanceof THScroller
)
1305 && !(window
instanceof TDesktop
)
1307 absoluteBottomEdge
-= 1;
1309 int myRightEdge
= getAbsoluteX() + width
;
1310 int myBottomEdge
= getAbsoluteY() + height
;
1311 if (getAbsoluteX() > absoluteRightEdge
) {
1313 screen
.setClipRight(0);
1314 } else if (myRightEdge
> absoluteRightEdge
) {
1315 screen
.setClipRight(screen
.getClipRight()
1316 - (myRightEdge
- absoluteRightEdge
));
1318 if (getAbsoluteY() > absoluteBottomEdge
) {
1320 screen
.setClipBottom(0);
1321 } else if (myBottomEdge
> absoluteBottomEdge
) {
1322 screen
.setClipBottom(screen
.getClipBottom()
1323 - (myBottomEdge
- absoluteBottomEdge
));
1327 screen
.setOffsetX(getAbsoluteX());
1328 screen
.setOffsetY(getAbsoluteY());
1332 if (!isDrawable()) {
1333 // An action taken by a draw method unhooked me from the UI.
1338 assert (visible
== true);
1340 // Continue down the chain. Draw the active child last so that it
1342 for (TWidget widget
: children
) {
1343 if (widget
.isVisible() && (widget
!= activeChild
)) {
1344 widget
.drawChildren();
1345 if (!isDrawable()) {
1346 // An action taken by a draw method unhooked me from the UI.
1352 if (activeChild
!= null) {
1353 activeChild
.drawChildren();
1358 * Repaint the screen on the next update.
1360 protected final void doRepaint() {
1361 window
.getApplication().doRepaint();
1365 * Add a child widget to my list of children. We set its tabOrder to 0
1366 * and increment the tabOrder of all other children.
1368 * @param child TWidget to add
1370 private void addChild(final TWidget child
) {
1371 children
.add(child
);
1374 && !(child
instanceof THScroller
)
1375 && !(child
instanceof TVScroller
)
1377 for (TWidget widget
: children
) {
1378 widget
.active
= false;
1380 child
.active
= true;
1381 activeChild
= child
;
1383 for (int i
= 0; i
< children
.size(); i
++) {
1384 children
.get(i
).tabOrder
= i
;
1386 if (layout
!= null) {
1392 * Reset the tab order of children to match their position in the list.
1393 * Available so that subclasses can re-order their widgets if needed.
1395 protected void resetTabOrder() {
1396 for (int i
= 0; i
< children
.size(); i
++) {
1397 children
.get(i
).tabOrder
= i
;
1402 * Switch the active child.
1404 * @param child TWidget to activate
1406 public final void activate(final TWidget child
) {
1407 assert (child
.enabled
);
1408 if ((child
instanceof THScroller
)
1409 || (child
instanceof TVScroller
)
1414 if (children
.size() == 1) {
1415 if (children
.get(0).enabled
== true) {
1416 child
.active
= true;
1417 activeChild
= child
;
1420 if (child
!= activeChild
) {
1421 if (activeChild
!= null) {
1422 activeChild
.active
= false;
1424 child
.active
= true;
1425 activeChild
= child
;
1431 * Switch the active child.
1433 * @param tabOrder tabOrder of the child to activate. If that child
1434 * isn't enabled, then the next enabled child will be activated.
1436 public final void activate(final int tabOrder
) {
1437 if (children
.size() == 1) {
1438 if (children
.get(0).enabled
== true) {
1439 children
.get(0).active
= true;
1440 activeChild
= children
.get(0);
1445 TWidget child
= null;
1446 for (TWidget widget
: children
) {
1447 if ((widget
.enabled
)
1448 && !(widget
instanceof THScroller
)
1449 && !(widget
instanceof TVScroller
)
1450 && (widget
.tabOrder
>= tabOrder
)
1456 if ((child
!= null) && (child
!= activeChild
)) {
1457 if (activeChild
!= null) {
1458 activeChild
.active
= false;
1460 assert (child
.enabled
);
1461 child
.active
= true;
1462 activeChild
= child
;
1467 * Make this widget the active child of its parent. Note that this is
1468 * not final since TWindow overrides activate().
1470 public void activate() {
1472 if (parent
!= null) {
1473 parent
.activate(this);
1479 * Switch the active widget with the next in the tab order.
1481 * @param forward if true, then switch to the next enabled widget in the
1482 * list, otherwise switch to the previous enabled widget in the list
1484 public final void switchWidget(final boolean forward
) {
1486 // No children: do nothing.
1487 if (children
.size() == 0) {
1491 assert (parent
!= null);
1493 // If there is only one child, make it active if it is enabled.
1494 if (children
.size() == 1) {
1495 if (children
.get(0).enabled
== true) {
1496 activeChild
= children
.get(0);
1497 activeChild
.active
= true;
1499 children
.get(0).active
= false;
1505 // Two or more children: go forward or backward to the next enabled
1508 if (activeChild
!= null) {
1509 tabOrder
= activeChild
.tabOrder
;
1519 // If at the end, pass the switch to my parent.
1520 if ((!forward
) && (parent
!= this)) {
1521 parent
.switchWidget(forward
);
1525 tabOrder
= children
.size() - 1;
1526 } else if (tabOrder
== children
.size()) {
1527 // If at the end, pass the switch to my parent.
1528 if ((forward
) && (parent
!= this)) {
1529 parent
.switchWidget(forward
);
1535 if (activeChild
== null) {
1536 if (tabOrder
== 0) {
1537 // We wrapped around
1540 } else if (activeChild
.tabOrder
== tabOrder
) {
1541 // We wrapped around
1544 } while ((!children
.get(tabOrder
).enabled
)
1545 && !(children
.get(tabOrder
) instanceof THScroller
)
1546 && !(children
.get(tabOrder
) instanceof TVScroller
));
1548 if (activeChild
!= null) {
1549 assert (children
.get(tabOrder
).enabled
);
1551 activeChild
.active
= false;
1553 if (children
.get(tabOrder
).enabled
== true) {
1554 children
.get(tabOrder
).active
= true;
1555 activeChild
= children
.get(tabOrder
);
1560 * Returns my active widget.
1562 * @return widget that is active, or this if no children
1564 public TWidget
getActiveChild() {
1565 if ((this instanceof THScroller
)
1566 || (this instanceof TVScroller
)
1571 for (TWidget widget
: children
) {
1572 if (widget
.active
) {
1573 return widget
.getActiveChild();
1576 // No active children, return me
1581 * Insert a vertical split between this widget and parent, and optionally
1582 * put another widget in the other side of the split.
1584 * @param newWidgetOnLeft if true, the new widget (if specified) will be
1585 * on the left pane, and this widget will be placed on the right pane
1586 * @param newWidget the new widget to add to the other pane, or null
1587 * @return the new split pane widget
1589 public TSplitPane
splitVertical(final boolean newWidgetOnLeft
,
1590 final TWidget newWidget
) {
1592 TSplitPane splitPane
= new TSplitPane(null, x
, y
, width
, height
, true);
1593 TWidget myParent
= parent
;
1595 if (myParent
instanceof TSplitPane
) {
1596 // TSplitPane has a left/right/top/bottom link to me somewhere,
1597 // replace it with a link to splitPane.
1598 ((TSplitPane
) myParent
).replaceWidget(this, splitPane
);
1600 splitPane
.setParent(myParent
, false);
1601 if (newWidgetOnLeft
) {
1602 splitPane
.setLeft(newWidget
);
1603 splitPane
.setRight(this);
1605 splitPane
.setLeft(this);
1606 splitPane
.setRight(newWidget
);
1608 splitPane
.activate();
1609 if (newWidget
!= null) {
1610 newWidget
.activate();
1615 assert (parent
!= null);
1616 assert (window
!= null);
1617 assert (splitPane
.getWindow() != null);
1618 assert (splitPane
.getParent() != null);
1619 assert (splitPane
.isActive() == true);
1620 assert (parent
== splitPane
);
1621 if (newWidget
!= null) {
1622 assert (newWidget
.parent
== parent
);
1623 assert (newWidget
.active
== true);
1624 assert (active
== false);
1626 assert (active
== true);
1632 * Insert a horizontal split between this widget and parent, and
1633 * optionally put another widget in the other side of the split.
1635 * @param newWidgetOnTop if true, the new widget (if specified) will be
1636 * on the top pane, and this widget's children will be placed on the
1638 * @param newWidget the new widget to add to the other pane, or null
1639 * @return the new split pane widget
1641 public TSplitPane
splitHorizontal(final boolean newWidgetOnTop
,
1642 final TWidget newWidget
) {
1644 TSplitPane splitPane
= new TSplitPane(null, x
, y
, width
, height
, false);
1645 TWidget myParent
= parent
;
1647 if (myParent
instanceof TSplitPane
) {
1648 // TSplitPane has a left/right/top/bottom link to me somewhere,
1649 // replace it with a link to splitPane.
1650 ((TSplitPane
) myParent
).replaceWidget(this, splitPane
);
1652 splitPane
.setParent(myParent
, false);
1653 if (newWidgetOnTop
) {
1654 splitPane
.setTop(newWidget
);
1655 splitPane
.setBottom(this);
1657 splitPane
.setTop(this);
1658 splitPane
.setBottom(newWidget
);
1660 splitPane
.activate();
1661 if (newWidget
!= null) {
1662 newWidget
.activate();
1667 assert (parent
!= null);
1668 assert (window
!= null);
1669 assert (splitPane
.getWindow() != null);
1670 assert (splitPane
.getParent() != null);
1671 assert (splitPane
.isActive() == true);
1672 assert (parent
== splitPane
);
1673 if (newWidget
!= null) {
1674 assert (newWidget
.parent
== parent
);
1675 assert (newWidget
.active
== true);
1676 assert (active
== false);
1678 assert (active
== true);
1684 * Generate a human-readable string for this widget.
1686 * @return a human-readable string
1689 public String
toString() {
1690 return String
.format("%s(%8x) position (%d, %d) geometry %dx%d " +
1691 "active %s enabled %s visible %s", getClass().getName(),
1692 hashCode(), x
, y
, width
, height
, active
, enabled
, visible
);
1696 * Generate a string for this widget's hierarchy.
1698 * @param prefix a prefix to use for this widget's place in the hierarchy
1699 * @return a pretty-printable string of this hierarchy
1701 protected String
toPrettyString(final String prefix
) {
1702 StringBuilder sb
= new StringBuilder(prefix
);
1703 sb
.append(toString());
1704 String newPrefix
= "";
1705 for (int i
= 0; i
< prefix
.length(); i
++) {
1708 for (int i
= 0; i
< children
.size(); i
++) {
1709 TWidget child
= children
.get(i
);
1711 if (i
== children
.size() - 1) {
1712 sb
.append(child
.toPrettyString(newPrefix
+ " \u2514\u2500"));
1714 sb
.append(child
.toPrettyString(newPrefix
+ " \u251c\u2500"));
1717 return sb
.toString();
1721 * Generate a string for this widget's hierarchy.
1723 * @return a pretty-printable string of this hierarchy
1725 public String
toPrettyString() {
1726 return toPrettyString("");
1729 // ------------------------------------------------------------------------
1730 // Passthru for Screen functions ------------------------------------------
1731 // ------------------------------------------------------------------------
1734 * Get the attributes at one location.
1736 * @param x column coordinate. 0 is the left-most column.
1737 * @param y row coordinate. 0 is the top-most row.
1738 * @return attributes at (x, y)
1740 protected final CellAttributes
getAttrXY(final int x
, final int y
) {
1741 return getScreen().getAttrXY(x
, y
);
1745 * Set the attributes at one location.
1747 * @param x column coordinate. 0 is the left-most column.
1748 * @param y row coordinate. 0 is the top-most row.
1749 * @param attr attributes to use (bold, foreColor, backColor)
1751 protected final void putAttrXY(final int x
, final int y
,
1752 final CellAttributes attr
) {
1754 getScreen().putAttrXY(x
, y
, attr
);
1758 * Set the attributes at one location.
1760 * @param x column coordinate. 0 is the left-most column.
1761 * @param y row coordinate. 0 is the top-most row.
1762 * @param attr attributes to use (bold, foreColor, backColor)
1763 * @param clip if true, honor clipping/offset
1765 protected final void putAttrXY(final int x
, final int y
,
1766 final CellAttributes attr
, final boolean clip
) {
1768 getScreen().putAttrXY(x
, y
, attr
, clip
);
1772 * Fill the entire screen with one character with attributes.
1774 * @param ch character to draw
1775 * @param attr attributes to use (bold, foreColor, backColor)
1777 protected final void putAll(final int ch
, final CellAttributes attr
) {
1778 getScreen().putAll(ch
, attr
);
1782 * Render one character with attributes.
1784 * @param x column coordinate. 0 is the left-most column.
1785 * @param y row coordinate. 0 is the top-most row.
1786 * @param ch character + attributes to draw
1788 protected final void putCharXY(final int x
, final int y
, final Cell ch
) {
1789 getScreen().putCharXY(x
, y
, ch
);
1793 * Render one character with attributes.
1795 * @param x column coordinate. 0 is the left-most column.
1796 * @param y row coordinate. 0 is the top-most row.
1797 * @param ch character to draw
1798 * @param attr attributes to use (bold, foreColor, backColor)
1800 protected final void putCharXY(final int x
, final int y
, final int ch
,
1801 final CellAttributes attr
) {
1803 getScreen().putCharXY(x
, y
, ch
, attr
);
1807 * Render one character without changing the underlying attributes.
1809 * @param x column coordinate. 0 is the left-most column.
1810 * @param y row coordinate. 0 is the top-most row.
1811 * @param ch character to draw
1813 protected final void putCharXY(final int x
, final int y
, final int ch
) {
1814 getScreen().putCharXY(x
, y
, ch
);
1818 * Render a string. Does not wrap if the string exceeds the line.
1820 * @param x column coordinate. 0 is the left-most column.
1821 * @param y row coordinate. 0 is the top-most row.
1822 * @param str string to draw
1823 * @param attr attributes to use (bold, foreColor, backColor)
1825 protected final void putStringXY(final int x
, final int y
, final String str
,
1826 final CellAttributes attr
) {
1828 getScreen().putStringXY(x
, y
, str
, attr
);
1832 * Render a string without changing the underlying attribute. Does not
1833 * wrap if the string exceeds the line.
1835 * @param x column coordinate. 0 is the left-most column.
1836 * @param y row coordinate. 0 is the top-most row.
1837 * @param str string to draw
1839 protected final void putStringXY(final int x
, final int y
, final String str
) {
1840 getScreen().putStringXY(x
, y
, str
);
1844 * Draw a vertical line from (x, y) to (x, y + n).
1846 * @param x column coordinate. 0 is the left-most column.
1847 * @param y row coordinate. 0 is the top-most row.
1848 * @param n number of characters to draw
1849 * @param ch character to draw
1850 * @param attr attributes to use (bold, foreColor, backColor)
1852 protected final void vLineXY(final int x
, final int y
, final int n
,
1853 final int ch
, final CellAttributes attr
) {
1855 getScreen().vLineXY(x
, y
, n
, ch
, attr
);
1859 * Draw a horizontal line from (x, y) to (x + n, y).
1861 * @param x column coordinate. 0 is the left-most column.
1862 * @param y row coordinate. 0 is the top-most row.
1863 * @param n number of characters to draw
1864 * @param ch character to draw
1865 * @param attr attributes to use (bold, foreColor, backColor)
1867 protected final void hLineXY(final int x
, final int y
, final int n
,
1868 final int ch
, final CellAttributes attr
) {
1870 getScreen().hLineXY(x
, y
, n
, ch
, attr
);
1874 * Draw a box with a border and empty background.
1876 * @param left left column of box. 0 is the left-most row.
1877 * @param top top row of the box. 0 is the top-most row.
1878 * @param right right column of box
1879 * @param bottom bottom row of the box
1880 * @param border attributes to use for the border
1881 * @param background attributes to use for the background
1883 protected final void drawBox(final int left
, final int top
,
1884 final int right
, final int bottom
,
1885 final CellAttributes border
, final CellAttributes background
) {
1887 getScreen().drawBox(left
, top
, right
, bottom
, border
, background
);
1891 * Draw a box with a border and empty background.
1893 * @param left left column of box. 0 is the left-most row.
1894 * @param top top row of the box. 0 is the top-most row.
1895 * @param right right column of box
1896 * @param bottom bottom row of the box
1897 * @param border attributes to use for the border
1898 * @param background attributes to use for the background
1899 * @param borderType if 1, draw a single-line border; if 2, draw a
1900 * double-line border; if 3, draw double-line top/bottom edges and
1901 * single-line left/right edges (like Qmodem)
1902 * @param shadow if true, draw a "shadow" on the box
1904 protected final void drawBox(final int left
, final int top
,
1905 final int right
, final int bottom
,
1906 final CellAttributes border
, final CellAttributes background
,
1907 final int borderType
, final boolean shadow
) {
1909 getScreen().drawBox(left
, top
, right
, bottom
, border
, background
,
1910 borderType
, shadow
);
1914 * Draw a box shadow.
1916 * @param left left column of box. 0 is the left-most row.
1917 * @param top top row of the box. 0 is the top-most row.
1918 * @param right right column of box
1919 * @param bottom bottom row of the box
1921 protected final void drawBoxShadow(final int left
, final int top
,
1922 final int right
, final int bottom
) {
1924 getScreen().drawBoxShadow(left
, top
, right
, bottom
);
1927 // ------------------------------------------------------------------------
1928 // Other TWidget constructors ---------------------------------------------
1929 // ------------------------------------------------------------------------
1932 * Convenience function to add a label to this container/window.
1935 * @param x column relative to parent
1936 * @param y row relative to parent
1937 * @return the new label
1939 public final TLabel
addLabel(final String text
, final int x
, final int y
) {
1940 return addLabel(text
, x
, y
, "tlabel");
1944 * Convenience function to add a label to this container/window.
1947 * @param x column relative to parent
1948 * @param y row relative to parent
1949 * @param action to call when shortcut is pressed
1950 * @return the new label
1952 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1953 final TAction action
) {
1955 return addLabel(text
, x
, y
, "tlabel", action
);
1959 * Convenience function to add a label to this container/window.
1962 * @param x column relative to parent
1963 * @param y row relative to parent
1964 * @param colorKey ColorTheme key color to use for foreground text.
1965 * Default is "tlabel"
1966 * @return the new label
1968 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1969 final String colorKey
) {
1971 return new TLabel(this, text
, x
, y
, colorKey
);
1975 * Convenience function to add a label to this container/window.
1978 * @param x column relative to parent
1979 * @param y row relative to parent
1980 * @param colorKey ColorTheme key color to use for foreground text.
1981 * Default is "tlabel"
1982 * @param action to call when shortcut is pressed
1983 * @return the new label
1985 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1986 final String colorKey
, final TAction action
) {
1988 return new TLabel(this, text
, x
, y
, colorKey
, action
);
1992 * Convenience function to add a label to this container/window.
1995 * @param x column relative to parent
1996 * @param y row relative to parent
1997 * @param colorKey ColorTheme key color to use for foreground text.
1998 * Default is "tlabel"
1999 * @param useWindowBackground if true, use the window's background color
2000 * @return the new label
2002 public final TLabel
addLabel(final String text
, final int x
, final int y
,
2003 final String colorKey
, final boolean useWindowBackground
) {
2005 return new TLabel(this, text
, x
, y
, colorKey
, useWindowBackground
);
2009 * Convenience function to add a label to this container/window.
2012 * @param x column relative to parent
2013 * @param y row relative to parent
2014 * @param colorKey ColorTheme key color to use for foreground text.
2015 * Default is "tlabel"
2016 * @param useWindowBackground if true, use the window's background color
2017 * @param action to call when shortcut is pressed
2018 * @return the new label
2020 public final TLabel
addLabel(final String text
, final int x
, final int y
,
2021 final String colorKey
, final boolean useWindowBackground
,
2022 final TAction action
) {
2024 return new TLabel(this, text
, x
, y
, colorKey
, useWindowBackground
,
2029 * Convenience function to add a button to this container/window.
2031 * @param text label on the button
2032 * @param x column relative to parent
2033 * @param y row relative to parent
2034 * @param action action to call when button is pressed
2035 * @return the new button
2037 public final TButton
addButton(final String text
, final int x
, final int y
,
2038 final TAction action
) {
2040 return new TButton(this, text
, x
, y
, action
);
2044 * Convenience function to add a checkbox to this container/window.
2046 * @param x column relative to parent
2047 * @param y row relative to parent
2048 * @param label label to display next to (right of) the checkbox
2049 * @param checked initial check state
2050 * @return the new checkbox
2052 public final TCheckBox
addCheckBox(final int x
, final int y
,
2053 final String label
, final boolean checked
) {
2055 return new TCheckBox(this, x
, y
, label
, checked
);
2059 * Convenience function to add a combobox to this container/window.
2061 * @param x column relative to parent
2062 * @param y row relative to parent
2063 * @param width visible combobox width, including the down-arrow
2064 * @param values the possible values for the box, shown in the drop-down
2065 * @param valuesIndex the initial index in values, or -1 for no default
2067 * @param maxValuesHeight the maximum height of the values drop-down when
2069 * @param updateAction action to call when a new value is selected from
2070 * the list or enter is pressed in the edit field
2071 * @return the new combobox
2073 public final TComboBox
addComboBox(final int x
, final int y
,
2074 final int width
, final List
<String
> values
, final int valuesIndex
,
2075 final int maxValuesHeight
, final TAction updateAction
) {
2077 return new TComboBox(this, x
, y
, width
, values
, valuesIndex
,
2078 maxValuesHeight
, updateAction
);
2082 * Convenience function to add a spinner to this container/window.
2084 * @param x column relative to parent
2085 * @param y row relative to parent
2086 * @param upAction action to call when the up arrow is clicked or pressed
2087 * @param downAction action to call when the down arrow is clicked or
2089 * @return the new spinner
2091 public final TSpinner
addSpinner(final int x
, final int y
,
2092 final TAction upAction
, final TAction downAction
) {
2094 return new TSpinner(this, x
, y
, upAction
, downAction
);
2098 * Convenience function to add a calendar to this container/window.
2100 * @param x column relative to parent
2101 * @param y row relative to parent
2102 * @param updateAction action to call when the user changes the value of
2104 * @return the new calendar
2106 public final TCalendar
addCalendar(final int x
, final int y
,
2107 final TAction updateAction
) {
2109 return new TCalendar(this, x
, y
, updateAction
);
2113 * Convenience function to add a progress bar to this container/window.
2115 * @param x column relative to parent
2116 * @param y row relative to parent
2117 * @param width width of progress bar
2118 * @param value initial value of percent complete
2119 * @return the new progress bar
2121 public final TProgressBar
addProgressBar(final int x
, final int y
,
2122 final int width
, final int value
) {
2124 return new TProgressBar(this, x
, y
, width
, value
);
2128 * Convenience function to add a radio button group to this
2131 * @param x column relative to parent
2132 * @param y row relative to parent
2133 * @param label label to display on the group box
2134 * @return the new radio button group
2136 public final TRadioGroup
addRadioGroup(final int x
, final int y
,
2137 final String label
) {
2139 return new TRadioGroup(this, x
, y
, label
);
2143 * Convenience function to add a text field to this container/window.
2145 * @param x column relative to parent
2146 * @param y row relative to parent
2147 * @param width visible text width
2148 * @param fixed if true, the text cannot exceed the display width
2149 * @return the new text field
2151 public final TField
addField(final int x
, final int y
,
2152 final int width
, final boolean fixed
) {
2154 return new TField(this, x
, y
, width
, fixed
);
2158 * Convenience function to add a text field to this container/window.
2160 * @param x column relative to parent
2161 * @param y row relative to parent
2162 * @param width visible text width
2163 * @param fixed if true, the text cannot exceed the display width
2164 * @param text initial text, default is empty string
2165 * @return the new text field
2167 public final TField
addField(final int x
, final int y
,
2168 final int width
, final boolean fixed
, final String text
) {
2170 return new TField(this, x
, y
, width
, fixed
, text
);
2174 * Convenience function to add a text field to this container/window.
2176 * @param x column relative to parent
2177 * @param y row relative to parent
2178 * @param width visible text width
2179 * @param fixed if true, the text cannot exceed the display width
2180 * @param text initial text, default is empty string
2181 * @param enterAction function to call when enter key is pressed
2182 * @param updateAction function to call when the text is updated
2183 * @return the new text field
2185 public final TField
addField(final int x
, final int y
,
2186 final int width
, final boolean fixed
, final String text
,
2187 final TAction enterAction
, final TAction updateAction
) {
2189 return new TField(this, x
, y
, width
, fixed
, text
, enterAction
,
2194 * Convenience function to add a scrollable text box to this
2197 * @param text text on the screen
2198 * @param x column relative to parent
2199 * @param y row relative to parent
2200 * @param width width of text area
2201 * @param height height of text area
2202 * @param colorKey ColorTheme key color to use for foreground text
2203 * @return the new text box
2205 public final TText
addText(final String text
, final int x
,
2206 final int y
, final int width
, final int height
, final String colorKey
) {
2208 return new TText(this, text
, x
, y
, width
, height
, colorKey
);
2212 * Convenience function to add a scrollable text box to this
2215 * @param text text on the screen
2216 * @param x column relative to parent
2217 * @param y row relative to parent
2218 * @param width width of text area
2219 * @param height height of text area
2220 * @return the new text box
2222 public final TText
addText(final String text
, final int x
, final int y
,
2223 final int width
, final int height
) {
2225 return new TText(this, text
, x
, y
, width
, height
, "ttext");
2229 * Convenience function to add an editable text area box to this
2232 * @param text text on the screen
2233 * @param x column relative to parent
2234 * @param y row relative to parent
2235 * @param width width of text area
2236 * @param height height of text area
2237 * @return the new text box
2239 public final TEditorWidget
addEditor(final String text
, final int x
,
2240 final int y
, final int width
, final int height
) {
2242 return new TEditorWidget(this, text
, x
, y
, width
, height
);
2246 * Convenience function to spawn a message box.
2248 * @param title window title, will be centered along the top border
2249 * @param caption message to display. Use embedded newlines to get a
2251 * @return the new message box
2253 public final TMessageBox
messageBox(final String title
,
2254 final String caption
) {
2256 return getApplication().messageBox(title
, caption
, TMessageBox
.Type
.OK
);
2260 * Convenience function to spawn a message box.
2262 * @param title window title, will be centered along the top border
2263 * @param caption message to display. Use embedded newlines to get a
2265 * @param type one of the TMessageBox.Type constants. Default is
2267 * @return the new message box
2269 public final TMessageBox
messageBox(final String title
,
2270 final String caption
, final TMessageBox
.Type type
) {
2272 return getApplication().messageBox(title
, caption
, type
);
2276 * Convenience function to spawn an input box.
2278 * @param title window title, will be centered along the top border
2279 * @param caption message to display. Use embedded newlines to get a
2281 * @return the new input box
2283 public final TInputBox
inputBox(final String title
, final String caption
) {
2285 return getApplication().inputBox(title
, caption
);
2289 * Convenience function to spawn an input box.
2291 * @param title window title, will be centered along the top border
2292 * @param caption message to display. Use embedded newlines to get a
2294 * @param text initial text to seed the field with
2295 * @return the new input box
2297 public final TInputBox
inputBox(final String title
, final String caption
,
2298 final String text
) {
2300 return getApplication().inputBox(title
, caption
, text
);
2304 * Convenience function to spawn an input box.
2306 * @param title window title, will be centered along the top border
2307 * @param caption message to display. Use embedded newlines to get a
2309 * @param text initial text to seed the field with
2310 * @param type one of the Type constants. Default is Type.OK.
2311 * @return the new input box
2313 public final TInputBox
inputBox(final String title
, final String caption
,
2314 final String text
, final TInputBox
.Type type
) {
2316 return getApplication().inputBox(title
, caption
, text
, type
);
2320 * Convenience function to add a password text field to this
2323 * @param x column relative to parent
2324 * @param y row relative to parent
2325 * @param width visible text width
2326 * @param fixed if true, the text cannot exceed the display width
2327 * @return the new text field
2329 public final TPasswordField
addPasswordField(final int x
, final int y
,
2330 final int width
, final boolean fixed
) {
2332 return new TPasswordField(this, x
, y
, width
, fixed
);
2336 * Convenience function to add a password text field to this
2339 * @param x column relative to parent
2340 * @param y row relative to parent
2341 * @param width visible text width
2342 * @param fixed if true, the text cannot exceed the display width
2343 * @param text initial text, default is empty string
2344 * @return the new text field
2346 public final TPasswordField
addPasswordField(final int x
, final int y
,
2347 final int width
, final boolean fixed
, final String text
) {
2349 return new TPasswordField(this, x
, y
, width
, fixed
, text
);
2353 * Convenience function to add a password text field to this
2356 * @param x column relative to parent
2357 * @param y row relative to parent
2358 * @param width visible text width
2359 * @param fixed if true, the text cannot exceed the display width
2360 * @param text initial text, default is empty string
2361 * @param enterAction function to call when enter key is pressed
2362 * @param updateAction function to call when the text is updated
2363 * @return the new text field
2365 public final TPasswordField
addPasswordField(final int x
, final int y
,
2366 final int width
, final boolean fixed
, final String text
,
2367 final TAction enterAction
, final TAction updateAction
) {
2369 return new TPasswordField(this, x
, y
, width
, fixed
, text
, enterAction
,
2374 * Convenience function to add a scrollable tree view to this
2377 * @param x column relative to parent
2378 * @param y row relative to parent
2379 * @param width width of tree view
2380 * @param height height of tree view
2381 * @return the new tree view
2383 public final TTreeViewWidget
addTreeViewWidget(final int x
, final int y
,
2384 final int width
, final int height
) {
2386 return new TTreeViewWidget(this, x
, y
, width
, height
);
2390 * Convenience function to add a scrollable tree view to this
2393 * @param x column relative to parent
2394 * @param y row relative to parent
2395 * @param width width of tree view
2396 * @param height height of tree view
2397 * @param action action to perform when an item is selected
2398 * @return the new tree view
2400 public final TTreeViewWidget
addTreeViewWidget(final int x
, final int y
,
2401 final int width
, final int height
, final TAction action
) {
2403 return new TTreeViewWidget(this, x
, y
, width
, height
, action
);
2407 * Convenience function to spawn a file open box.
2409 * @param path path of selected file
2410 * @return the result of the new file open box
2411 * @throws IOException if a java.io operation throws
2413 public final String
fileOpenBox(final String path
) throws IOException
{
2414 return getApplication().fileOpenBox(path
);
2418 * Convenience function to spawn a file save box.
2420 * @param path path of selected file
2421 * @return the result of the new file open box
2422 * @throws IOException if a java.io operation throws
2424 public final String
fileSaveBox(final String path
) throws IOException
{
2425 return getApplication().fileOpenBox(path
, TFileOpenBox
.Type
.SAVE
);
2429 * Convenience function to spawn a file open box.
2431 * @param path path of selected file
2432 * @param type one of the Type constants
2433 * @return the result of the new file open box
2434 * @throws IOException if a java.io operation throws
2436 public final String
fileOpenBox(final String path
,
2437 final TFileOpenBox
.Type type
) throws IOException
{
2439 return getApplication().fileOpenBox(path
, type
);
2443 * Convenience function to spawn a file open box.
2445 * @param path path of selected file
2446 * @param type one of the Type constants
2447 * @param filter a string that files must match to be displayed
2448 * @return the result of the new file open box
2449 * @throws IOException of a java.io operation throws
2451 public final String
fileOpenBox(final String path
,
2452 final TFileOpenBox
.Type type
, final String filter
) throws IOException
{
2454 ArrayList
<String
> filters
= new ArrayList
<String
>();
2455 filters
.add(filter
);
2457 return getApplication().fileOpenBox(path
, type
, filters
);
2461 * Convenience function to spawn a file open box.
2463 * @param path path of selected file
2464 * @param type one of the Type constants
2465 * @param filters a list of strings that files must match to be displayed
2466 * @return the result of the new file open box
2467 * @throws IOException of a java.io operation throws
2469 public final String
fileOpenBox(final String path
,
2470 final TFileOpenBox
.Type type
,
2471 final List
<String
> filters
) throws IOException
{
2473 return getApplication().fileOpenBox(path
, type
, filters
);
2477 * Convenience function to add a directory list to this container/window.
2479 * @param path directory path, must be a directory
2480 * @param x column relative to parent
2481 * @param y row relative to parent
2482 * @param width width of text area
2483 * @param height height of text area
2484 * @return the new directory list
2486 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2487 final int y
, final int width
, final int height
) {
2489 return new TDirectoryList(this, path
, x
, y
, width
, height
, null);
2493 * Convenience function to add a directory list to this container/window.
2495 * @param path directory path, must be a directory
2496 * @param x column relative to parent
2497 * @param y row relative to parent
2498 * @param width width of text area
2499 * @param height height of text area
2500 * @param action action to perform when an item is selected (enter or
2502 * @return the new directory list
2504 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2505 final int y
, final int width
, final int height
, final TAction action
) {
2507 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
);
2511 * Convenience function to add a directory list to this container/window.
2513 * @param path directory path, must be a directory
2514 * @param x column relative to parent
2515 * @param y row relative to parent
2516 * @param width width of text area
2517 * @param height height of text area
2518 * @param action action to perform when an item is selected (enter or
2520 * @param singleClickAction action to perform when an item is selected
2522 * @return the new directory list
2524 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2525 final int y
, final int width
, final int height
, final TAction action
,
2526 final TAction singleClickAction
) {
2528 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
,
2533 * Convenience function to add a directory list to this container/window.
2535 * @param path directory path, must be a directory
2536 * @param x column relative to parent
2537 * @param y row relative to parent
2538 * @param width width of text area
2539 * @param height height of text area
2540 * @param action action to perform when an item is selected (enter or
2542 * @param singleClickAction action to perform when an item is selected
2544 * @param filters a list of strings that files must match to be displayed
2545 * @return the new directory list
2547 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2548 final int y
, final int width
, final int height
, final TAction action
,
2549 final TAction singleClickAction
, final List
<String
> filters
) {
2551 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
,
2552 singleClickAction
, filters
);
2556 * Convenience function to add a list to this container/window.
2558 * @param strings list of strings to show
2559 * @param x column relative to parent
2560 * @param y row relative to parent
2561 * @param width width of text area
2562 * @param height height of text area
2563 * @return the new directory list
2565 public final TList
addList(final List
<String
> strings
, final int x
,
2566 final int y
, final int width
, final int height
) {
2568 return new TList(this, strings
, x
, y
, width
, height
, null);
2572 * Convenience function to add a list to this container/window.
2574 * @param strings list of strings to show
2575 * @param x column relative to parent
2576 * @param y row relative to parent
2577 * @param width width of text area
2578 * @param height height of text area
2579 * @param enterAction action to perform when an item is selected
2580 * @return the new directory list
2582 public final TList
addList(final List
<String
> strings
, final int x
,
2583 final int y
, final int width
, final int height
,
2584 final TAction enterAction
) {
2586 return new TList(this, strings
, x
, y
, width
, height
, enterAction
);
2590 * Convenience function to add a list to this container/window.
2592 * @param strings list of strings to show
2593 * @param x column relative to parent
2594 * @param y row relative to parent
2595 * @param width width of text area
2596 * @param height height of text area
2597 * @param enterAction action to perform when an item is selected
2598 * @param moveAction action to perform when the user navigates to a new
2599 * item with arrow/page keys
2600 * @return the new directory list
2602 public final TList
addList(final List
<String
> strings
, final int x
,
2603 final int y
, final int width
, final int height
,
2604 final TAction enterAction
, final TAction moveAction
) {
2606 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,
2611 * Convenience function to add a list to this container/window.
2613 * @param strings list of strings to show. This is allowed to be null
2614 * and set later with setList() or by subclasses.
2615 * @param x column relative to parent
2616 * @param y row relative to parent
2617 * @param width width of text area
2618 * @param height height of text area
2619 * @param enterAction action to perform when an item is selected
2620 * @param moveAction action to perform when the user navigates to a new
2621 * item with arrow/page keys
2622 * @param singleClickAction action to perform when the user clicks on an
2625 public TList
addList(final List
<String
> strings
, final int x
,
2626 final int y
, final int width
, final int height
,
2627 final TAction enterAction
, final TAction moveAction
,
2628 final TAction singleClickAction
) {
2630 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,
2631 moveAction
, singleClickAction
);
2636 * Convenience function to add an image to this container/window.
2638 * @param x column relative to parent
2639 * @param y row relative to parent
2640 * @param width number of text cells for width of the image
2641 * @param height number of text cells for height of the image
2642 * @param image the image to display
2643 * @param left left column of the image. 0 is the left-most column.
2644 * @param top top row of the image. 0 is the top-most row.
2646 public final TImage
addImage(final int x
, final int y
,
2647 final int width
, final int height
,
2648 final BufferedImage image
, final int left
, final int top
) {
2650 return new TImage(this, x
, y
, width
, height
, image
, left
, top
);
2654 * Convenience function to add an image to this container/window.
2656 * @param x column relative to parent
2657 * @param y row relative to parent
2658 * @param width number of text cells for width of the image
2659 * @param height number of text cells for height of the image
2660 * @param image the image to display
2661 * @param left left column of the image. 0 is the left-most column.
2662 * @param top top row of the image. 0 is the top-most row.
2663 * @param clickAction function to call when mouse is pressed
2665 public final TImage
addImage(final int x
, final int y
,
2666 final int width
, final int height
,
2667 final BufferedImage image
, final int left
, final int top
,
2668 final TAction clickAction
) {
2670 return new TImage(this, x
, y
, width
, height
, image
, left
, top
,
2675 * Convenience function to add an editable 2D data table to this
2678 * @param x column relative to parent
2679 * @param y row relative to parent
2680 * @param width width of widget
2681 * @param height height of widget
2683 public TTableWidget
addTable(final int x
, final int y
, final int width
,
2686 return new TTableWidget(this, x
, y
, width
, height
);
2690 * Convenience function to add an editable 2D data table to this
2693 * @param x column relative to parent
2694 * @param y row relative to parent
2695 * @param width width of widget
2696 * @param height height of widget
2697 * @param gridColumns number of columns in grid
2698 * @param gridRows number of rows in grid
2700 public TTableWidget
addTable(final int x
, final int y
, final int width
,
2701 final int height
, final int gridColumns
, final int gridRows
) {
2703 return new TTableWidget(this, x
, y
, width
, height
, gridColumns
,
2708 * Convenience function to add a panel to this container/window.
2710 * @param x column relative to parent
2711 * @param y row relative to parent
2712 * @param width width of text area
2713 * @param height height of text area
2714 * @return the new panel
2716 public final TPanel
addPanel(final int x
, final int y
, final int width
,
2719 return new TPanel(this, x
, y
, width
, height
);
2723 * Convenience function to add a split pane to this container/window.
2725 * @param x column relative to parent
2726 * @param y row relative to parent
2727 * @param width width of text area
2728 * @param height height of text area
2729 * @param vertical if true, split vertically
2730 * @return the new split pane
2732 public final TSplitPane
addSplitPane(final int x
, final int y
,
2733 final int width
, final int height
, final boolean vertical
) {
2735 return new TSplitPane(this, x
, y
, width
, height
, vertical
);