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
736 * @param doClose if true, call the close() method before removing the
739 public final void remove(final TWidget child
, final boolean doClose
) {
740 if (!children
.contains(child
)) {
741 throw new IndexOutOfBoundsException("child widget is not in " +
742 "list of children of this parent");
747 children
.remove(child
);
749 if (layout
!= null) {
755 * Set this widget's parent to a different widget.
757 * @param newParent new parent widget
758 * @param doClose if true, call the close() method before removing the
759 * child from its existing parent widget
761 public final void setParent(final TWidget newParent
,
762 final boolean doClose
) {
764 if (parent
!= null) {
765 parent
.remove(this, doClose
);
767 assert (parent
== null);
768 window
= newParent
.window
;
769 newParent
.addChild(this);
773 * Set this widget's window to a specific window. Parent must already be
774 * null. Having a null parent with a specified window is only used
775 * within Jexer by TStatusBar because TApplication routes events directly
776 * to it and calls its draw() method. Any other non-parented widgets
777 * will require similar special case functionality to receive events or
778 * be drawn to screen.
780 * @param window the window to use
782 public final void setWindow(final TWindow window
) {
784 if (parent
!= null) {
785 throw new IllegalArgumentException("Cannot have different " +
786 "windows for parent and child");
788 this.window
= window
;
792 * Remove a child widget from this container, and all of its children
793 * recursively from their parent containers.
795 * @param child the child widget to remove
796 * @param doClose if true, call the close() method before removing each
799 public final void removeAll(final TWidget child
, final boolean doClose
) {
800 remove(child
, doClose
);
801 for (TWidget w
: child
.children
) {
802 child
.removeAll(w
, doClose
);
809 * @return if true, this widget will receive events
811 public final boolean isActive() {
818 * @param active if true, this widget will receive events
820 public final void setActive(final boolean active
) {
821 this.active
= active
;
825 * Get the window this widget is on.
829 public final TWindow
getWindow() {
836 * @return absolute X position of the top-left corner
838 public final int getX() {
845 * @param x absolute X position of the top-left corner
847 public final void setX(final int x
) {
854 * @return absolute Y position of the top-left corner
856 public final int getY() {
863 * @param y absolute Y position of the top-left corner
865 public final void setY(final int y
) {
872 * @return widget width
874 public int getWidth() {
881 * @param width new widget width
883 public void setWidth(final int width
) {
885 if (layout
!= null) {
886 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
894 * @return widget height
896 public int getHeight() {
903 * @param height new widget height
905 public void setHeight(final int height
) {
906 this.height
= height
;
907 if (layout
!= null) {
908 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
914 * Change the dimensions.
916 * @param x absolute X position of the top-left corner
917 * @param y absolute Y position of the top-left corner
918 * @param width new widget width
919 * @param height new widget height
921 public final void setDimensions(final int x
, final int y
, final int width
,
928 if (layout
!= null) {
929 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
935 * Get the layout manager.
937 * @return the layout manager, or null if not set
939 public LayoutManager
getLayoutManager() {
944 * Set the layout manager.
946 * @param layout the new layout manager
948 public void setLayoutManager(LayoutManager layout
) {
949 if (this.layout
!= null) {
950 for (TWidget w
: children
) {
951 this.layout
.remove(w
);
955 this.layout
= layout
;
956 if (this.layout
!= null) {
957 for (TWidget w
: children
) {
966 * @return if true, this widget can be tabbed to or receive events
968 public final boolean isEnabled() {
975 * @param enabled if true, this widget can be tabbed to or receive events
977 public final void setEnabled(final boolean enabled
) {
978 this.enabled
= enabled
;
981 // See if there are any active siblings to switch to
982 boolean foundSibling
= false;
983 if (parent
!= null) {
984 for (TWidget w
: parent
.children
) {
986 && !(this instanceof THScroller
)
987 && !(this instanceof TVScroller
)
995 parent
.activeChild
= null;
1004 * @param visible if true, this widget will be drawn
1006 public final void setVisible(final boolean visible
) {
1007 this.visible
= visible
;
1011 * See if this widget is visible.
1013 * @return if true, this widget will be drawn
1015 public final boolean isVisible() {
1020 * Set visible cursor flag.
1022 * @param cursorVisible if true, this widget has a cursor
1024 public final void setCursorVisible(final boolean cursorVisible
) {
1025 this.cursorVisible
= cursorVisible
;
1029 * See if this widget has a visible cursor.
1031 * @return if true, this widget has a visible cursor
1033 public final boolean isCursorVisible() {
1034 // If cursor is out of my bounds, it is not visible.
1035 if ((cursorX
>= width
)
1037 || (cursorY
>= height
)
1043 assert (window
!= null);
1045 // If cursor is out of my window's bounds, it is not visible.
1046 if ((getCursorAbsoluteX() >= window
.getAbsoluteX()
1047 + window
.getWidth() - 1)
1048 || (getCursorAbsoluteX() < 0)
1049 || (getCursorAbsoluteY() >= window
.getAbsoluteY()
1050 + window
.getHeight() - 1)
1051 || (getCursorAbsoluteY() < 0)
1055 return cursorVisible
;
1059 * Get cursor X value.
1061 * @return cursor column position in relative coordinates
1063 public final int getCursorX() {
1068 * Set cursor X value.
1070 * @param cursorX column position in relative coordinates
1072 public final void setCursorX(final int cursorX
) {
1073 this.cursorX
= cursorX
;
1077 * Get cursor Y value.
1079 * @return cursor row position in relative coordinates
1081 public final int getCursorY() {
1086 * Set cursor Y value.
1088 * @param cursorY row position in relative coordinates
1090 public final void setCursorY(final int cursorY
) {
1091 this.cursorY
= cursorY
;
1095 * Get this TWidget's parent TApplication.
1097 * @return the parent TApplication
1099 public TApplication
getApplication() {
1100 return window
.getApplication();
1106 * @return the Screen
1108 public Screen
getScreen() {
1109 return window
.getScreen();
1113 * Comparison operator. For various subclasses it sorts on:
1115 * <li>tabOrder for TWidgets</li>
1116 * <li>z for TWindows</li>
1117 * <li>text for TTreeItems</li>
1120 * @param that another TWidget, TWindow, or TTreeItem instance
1121 * @return difference between this.tabOrder and that.tabOrder, or
1122 * difference between this.z and that.z, or String.compareTo(text)
1124 public final int compareTo(final TWidget that
) {
1125 if ((this instanceof TWindow
)
1126 && (that
instanceof TWindow
)
1128 return (((TWindow
) this).getZ() - ((TWindow
) that
).getZ());
1130 if ((this instanceof TTreeItem
)
1131 && (that
instanceof TTreeItem
)
1133 return (((TTreeItem
) this).getText().compareTo(
1134 ((TTreeItem
) that
).getText()));
1136 return (this.tabOrder
- that
.tabOrder
);
1140 * See if this widget should render with the active color.
1142 * @return true if this widget is active and all of its parents are
1145 public final boolean isAbsoluteActive() {
1146 if (parent
== this) {
1149 return (active
&& (parent
== null ?
true : parent
.isAbsoluteActive()));
1153 * Returns the cursor X position.
1155 * @return absolute screen column number for the cursor's X position
1157 public final int getCursorAbsoluteX() {
1158 return getAbsoluteX() + cursorX
;
1162 * Returns the cursor Y position.
1164 * @return absolute screen row number for the cursor's Y position
1166 public final int getCursorAbsoluteY() {
1167 return getAbsoluteY() + cursorY
;
1171 * Compute my absolute X position as the sum of my X plus all my parent's
1174 * @return absolute screen column number for my X position
1176 public final int getAbsoluteX() {
1177 assert (parent
!= null);
1178 if (parent
== this) {
1181 if ((parent
instanceof TWindow
)
1182 && !(parent
instanceof TMenu
)
1183 && !(parent
instanceof TDesktop
)
1185 // Widgets on a TWindow have (0,0) as their top-left, but this is
1186 // actually the TWindow's (1,1).
1187 return parent
.getAbsoluteX() + x
+ 1;
1189 return parent
.getAbsoluteX() + x
;
1193 * Compute my absolute Y position as the sum of my Y plus all my parent's
1196 * @return absolute screen row number for my Y position
1198 public final int getAbsoluteY() {
1199 assert (parent
!= null);
1200 if (parent
== this) {
1203 if ((parent
instanceof TWindow
)
1204 && !(parent
instanceof TMenu
)
1205 && !(parent
instanceof TDesktop
)
1207 // Widgets on a TWindow have (0,0) as their top-left, but this is
1208 // actually the TWindow's (1,1).
1209 return parent
.getAbsoluteY() + y
+ 1;
1211 return parent
.getAbsoluteY() + y
;
1215 * Get the global color theme.
1217 * @return the ColorTheme
1219 protected final ColorTheme
getTheme() {
1220 return window
.getApplication().getTheme();
1224 * Draw my specific widget. When called, the screen rectangle I draw
1225 * into is already setup (offset and clipping).
1227 public void draw() {
1228 // Default widget draws nothing.
1232 * Called by parent to render to TWindow. Note package private access.
1234 final void drawChildren() {
1235 // Set my clipping rectangle
1236 assert (window
!= null);
1237 assert (getScreen() != null);
1238 Screen screen
= getScreen();
1240 // Special case: TStatusBar is drawn by TApplication, not anything
1242 if (this instanceof TStatusBar
) {
1246 screen
.setClipRight(width
);
1247 screen
.setClipBottom(height
);
1249 int absoluteRightEdge
= window
.getAbsoluteX() + window
.getWidth();
1250 int absoluteBottomEdge
= window
.getAbsoluteY() + window
.getHeight();
1251 if (!(this instanceof TWindow
) && !(this instanceof TVScroller
)) {
1252 absoluteRightEdge
-= 1;
1254 if (!(this instanceof TWindow
) && !(this instanceof THScroller
)) {
1255 absoluteBottomEdge
-= 1;
1257 int myRightEdge
= getAbsoluteX() + width
;
1258 int myBottomEdge
= getAbsoluteY() + height
;
1259 if (getAbsoluteX() > absoluteRightEdge
) {
1261 screen
.setClipRight(0);
1262 } else if (myRightEdge
> absoluteRightEdge
) {
1263 screen
.setClipRight(screen
.getClipRight()
1264 - (myRightEdge
- absoluteRightEdge
));
1266 if (getAbsoluteY() > absoluteBottomEdge
) {
1268 screen
.setClipBottom(0);
1269 } else if (myBottomEdge
> absoluteBottomEdge
) {
1270 screen
.setClipBottom(screen
.getClipBottom()
1271 - (myBottomEdge
- absoluteBottomEdge
));
1275 screen
.setOffsetX(getAbsoluteX());
1276 screen
.setOffsetY(getAbsoluteY());
1280 assert (visible
== true);
1282 // Continue down the chain. Draw the active child last so that it
1284 for (TWidget widget
: children
) {
1285 if (widget
.isVisible() && (widget
!= activeChild
)) {
1286 widget
.drawChildren();
1289 if (activeChild
!= null) {
1290 activeChild
.drawChildren();
1295 * Repaint the screen on the next update.
1297 protected final void doRepaint() {
1298 window
.getApplication().doRepaint();
1302 * Add a child widget to my list of children. We set its tabOrder to 0
1303 * and increment the tabOrder of all other children.
1305 * @param child TWidget to add
1307 private void addChild(final TWidget child
) {
1308 children
.add(child
);
1311 && !(child
instanceof THScroller
)
1312 && !(child
instanceof TVScroller
)
1314 for (TWidget widget
: children
) {
1315 widget
.active
= false;
1317 child
.active
= true;
1318 activeChild
= child
;
1320 for (int i
= 0; i
< children
.size(); i
++) {
1321 children
.get(i
).tabOrder
= i
;
1323 if (layout
!= null) {
1329 * Reset the tab order of children to match their position in the list.
1330 * Available so that subclasses can re-order their widgets if needed.
1332 protected void resetTabOrder() {
1333 for (int i
= 0; i
< children
.size(); i
++) {
1334 children
.get(i
).tabOrder
= i
;
1339 * Switch the active child.
1341 * @param child TWidget to activate
1343 public final void activate(final TWidget child
) {
1344 assert (child
.enabled
);
1345 if ((child
instanceof THScroller
)
1346 || (child
instanceof TVScroller
)
1351 if (children
.size() == 1) {
1352 if (children
.get(0).enabled
== true) {
1353 child
.active
= true;
1354 activeChild
= child
;
1357 if (child
!= activeChild
) {
1358 if (activeChild
!= null) {
1359 activeChild
.active
= false;
1361 child
.active
= true;
1362 activeChild
= child
;
1368 * Switch the active child.
1370 * @param tabOrder tabOrder of the child to activate. If that child
1371 * isn't enabled, then the next enabled child will be activated.
1373 public final void activate(final int tabOrder
) {
1374 if (children
.size() == 1) {
1375 if (children
.get(0).enabled
== true) {
1376 children
.get(0).active
= true;
1377 activeChild
= children
.get(0);
1382 TWidget child
= null;
1383 for (TWidget widget
: children
) {
1384 if ((widget
.enabled
)
1385 && !(widget
instanceof THScroller
)
1386 && !(widget
instanceof TVScroller
)
1387 && (widget
.tabOrder
>= tabOrder
)
1393 if ((child
!= null) && (child
!= activeChild
)) {
1394 if (activeChild
!= null) {
1395 activeChild
.active
= false;
1397 assert (child
.enabled
);
1398 child
.active
= true;
1399 activeChild
= child
;
1404 * Make this widget the active child of its parent. Note that this is
1405 * not final since TWindow overrides activate().
1407 public void activate() {
1409 if (parent
!= null) {
1410 parent
.activate(this);
1416 * Switch the active widget with the next in the tab order.
1418 * @param forward if true, then switch to the next enabled widget in the
1419 * list, otherwise switch to the previous enabled widget in the list
1421 public final void switchWidget(final boolean forward
) {
1423 // No children: do nothing.
1424 if (children
.size() == 0) {
1428 assert (parent
!= null);
1430 // If there is only one child, make it active if it is enabled.
1431 if (children
.size() == 1) {
1432 if (children
.get(0).enabled
== true) {
1433 activeChild
= children
.get(0);
1434 activeChild
.active
= true;
1436 children
.get(0).active
= false;
1442 // Two or more children: go forward or backward to the next enabled
1445 if (activeChild
!= null) {
1446 tabOrder
= activeChild
.tabOrder
;
1456 // If at the end, pass the switch to my parent.
1457 if ((!forward
) && (parent
!= this)) {
1458 parent
.switchWidget(forward
);
1462 tabOrder
= children
.size() - 1;
1463 } else if (tabOrder
== children
.size()) {
1464 // If at the end, pass the switch to my parent.
1465 if ((forward
) && (parent
!= this)) {
1466 parent
.switchWidget(forward
);
1472 if (activeChild
== null) {
1473 if (tabOrder
== 0) {
1474 // We wrapped around
1477 } else if (activeChild
.tabOrder
== tabOrder
) {
1478 // We wrapped around
1481 } while ((!children
.get(tabOrder
).enabled
)
1482 && !(children
.get(tabOrder
) instanceof THScroller
)
1483 && !(children
.get(tabOrder
) instanceof TVScroller
));
1485 if (activeChild
!= null) {
1486 assert (children
.get(tabOrder
).enabled
);
1488 activeChild
.active
= false;
1490 if (children
.get(tabOrder
).enabled
== true) {
1491 children
.get(tabOrder
).active
= true;
1492 activeChild
= children
.get(tabOrder
);
1497 * Returns my active widget.
1499 * @return widget that is active, or this if no children
1501 public TWidget
getActiveChild() {
1502 if ((this instanceof THScroller
)
1503 || (this instanceof TVScroller
)
1508 for (TWidget widget
: children
) {
1509 if (widget
.active
) {
1510 return widget
.getActiveChild();
1513 // No active children, return me
1517 // ------------------------------------------------------------------------
1518 // Passthru for Screen functions ------------------------------------------
1519 // ------------------------------------------------------------------------
1522 * Get the attributes at one location.
1524 * @param x column coordinate. 0 is the left-most column.
1525 * @param y row coordinate. 0 is the top-most row.
1526 * @return attributes at (x, y)
1528 protected final CellAttributes
getAttrXY(final int x
, final int y
) {
1529 return getScreen().getAttrXY(x
, y
);
1533 * Set the attributes at one location.
1535 * @param x column coordinate. 0 is the left-most column.
1536 * @param y row coordinate. 0 is the top-most row.
1537 * @param attr attributes to use (bold, foreColor, backColor)
1539 protected final void putAttrXY(final int x
, final int y
,
1540 final CellAttributes attr
) {
1542 getScreen().putAttrXY(x
, y
, attr
);
1546 * Set the attributes at one location.
1548 * @param x column coordinate. 0 is the left-most column.
1549 * @param y row coordinate. 0 is the top-most row.
1550 * @param attr attributes to use (bold, foreColor, backColor)
1551 * @param clip if true, honor clipping/offset
1553 protected final void putAttrXY(final int x
, final int y
,
1554 final CellAttributes attr
, final boolean clip
) {
1556 getScreen().putAttrXY(x
, y
, attr
, clip
);
1560 * Fill the entire screen with one character with attributes.
1562 * @param ch character to draw
1563 * @param attr attributes to use (bold, foreColor, backColor)
1565 protected final void putAll(final int ch
, final CellAttributes attr
) {
1566 getScreen().putAll(ch
, attr
);
1570 * Render one character with attributes.
1572 * @param x column coordinate. 0 is the left-most column.
1573 * @param y row coordinate. 0 is the top-most row.
1574 * @param ch character + attributes to draw
1576 protected final void putCharXY(final int x
, final int y
, final Cell ch
) {
1577 getScreen().putCharXY(x
, y
, ch
);
1581 * Render one character with attributes.
1583 * @param x column coordinate. 0 is the left-most column.
1584 * @param y row coordinate. 0 is the top-most row.
1585 * @param ch character to draw
1586 * @param attr attributes to use (bold, foreColor, backColor)
1588 protected final void putCharXY(final int x
, final int y
, final int ch
,
1589 final CellAttributes attr
) {
1591 getScreen().putCharXY(x
, y
, ch
, attr
);
1595 * Render one character without changing the underlying attributes.
1597 * @param x column coordinate. 0 is the left-most column.
1598 * @param y row coordinate. 0 is the top-most row.
1599 * @param ch character to draw
1601 protected final void putCharXY(final int x
, final int y
, final int ch
) {
1602 getScreen().putCharXY(x
, y
, ch
);
1606 * Render a string. Does not wrap if the string exceeds the line.
1608 * @param x column coordinate. 0 is the left-most column.
1609 * @param y row coordinate. 0 is the top-most row.
1610 * @param str string to draw
1611 * @param attr attributes to use (bold, foreColor, backColor)
1613 protected final void putStringXY(final int x
, final int y
, final String str
,
1614 final CellAttributes attr
) {
1616 getScreen().putStringXY(x
, y
, str
, attr
);
1620 * Render a string without changing the underlying attribute. Does not
1621 * wrap if the string exceeds the line.
1623 * @param x column coordinate. 0 is the left-most column.
1624 * @param y row coordinate. 0 is the top-most row.
1625 * @param str string to draw
1627 protected final void putStringXY(final int x
, final int y
, final String str
) {
1628 getScreen().putStringXY(x
, y
, str
);
1632 * Draw a vertical line from (x, y) to (x, y + n).
1634 * @param x column coordinate. 0 is the left-most column.
1635 * @param y row coordinate. 0 is the top-most row.
1636 * @param n number of characters to draw
1637 * @param ch character to draw
1638 * @param attr attributes to use (bold, foreColor, backColor)
1640 protected final void vLineXY(final int x
, final int y
, final int n
,
1641 final int ch
, final CellAttributes attr
) {
1643 getScreen().vLineXY(x
, y
, n
, ch
, attr
);
1647 * Draw a horizontal line from (x, y) to (x + n, y).
1649 * @param x column coordinate. 0 is the left-most column.
1650 * @param y row coordinate. 0 is the top-most row.
1651 * @param n number of characters to draw
1652 * @param ch character to draw
1653 * @param attr attributes to use (bold, foreColor, backColor)
1655 protected final void hLineXY(final int x
, final int y
, final int n
,
1656 final int ch
, final CellAttributes attr
) {
1658 getScreen().hLineXY(x
, y
, n
, ch
, attr
);
1662 * Draw a box with a border and empty background.
1664 * @param left left column of box. 0 is the left-most row.
1665 * @param top top row of the box. 0 is the top-most row.
1666 * @param right right column of box
1667 * @param bottom bottom row of the box
1668 * @param border attributes to use for the border
1669 * @param background attributes to use for the background
1671 protected final void drawBox(final int left
, final int top
,
1672 final int right
, final int bottom
,
1673 final CellAttributes border
, final CellAttributes background
) {
1675 getScreen().drawBox(left
, top
, right
, bottom
, border
, background
);
1679 * Draw a box with a border and empty background.
1681 * @param left left column of box. 0 is the left-most row.
1682 * @param top top row of the box. 0 is the top-most row.
1683 * @param right right column of box
1684 * @param bottom bottom row of the box
1685 * @param border attributes to use for the border
1686 * @param background attributes to use for the background
1687 * @param borderType if 1, draw a single-line border; if 2, draw a
1688 * double-line border; if 3, draw double-line top/bottom edges and
1689 * single-line left/right edges (like Qmodem)
1690 * @param shadow if true, draw a "shadow" on the box
1692 protected final void drawBox(final int left
, final int top
,
1693 final int right
, final int bottom
,
1694 final CellAttributes border
, final CellAttributes background
,
1695 final int borderType
, final boolean shadow
) {
1697 getScreen().drawBox(left
, top
, right
, bottom
, border
, background
,
1698 borderType
, shadow
);
1702 * Draw a box shadow.
1704 * @param left left column of box. 0 is the left-most row.
1705 * @param top top row of the box. 0 is the top-most row.
1706 * @param right right column of box
1707 * @param bottom bottom row of the box
1709 protected final void drawBoxShadow(final int left
, final int top
,
1710 final int right
, final int bottom
) {
1712 getScreen().drawBoxShadow(left
, top
, right
, bottom
);
1715 // ------------------------------------------------------------------------
1716 // Other TWidget constructors ---------------------------------------------
1717 // ------------------------------------------------------------------------
1720 * Convenience function to add a label to this container/window.
1723 * @param x column relative to parent
1724 * @param y row relative to parent
1725 * @return the new label
1727 public final TLabel
addLabel(final String text
, final int x
, final int y
) {
1728 return addLabel(text
, x
, y
, "tlabel");
1732 * Convenience function to add a label to this container/window.
1735 * @param x column relative to parent
1736 * @param y row relative to parent
1737 * @param action to call when shortcut is pressed
1738 * @return the new label
1740 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1741 final TAction action
) {
1743 return addLabel(text
, x
, y
, "tlabel", action
);
1747 * Convenience function to add a label to this container/window.
1750 * @param x column relative to parent
1751 * @param y row relative to parent
1752 * @param colorKey ColorTheme key color to use for foreground text.
1753 * Default is "tlabel"
1754 * @return the new label
1756 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1757 final String colorKey
) {
1759 return new TLabel(this, text
, x
, y
, colorKey
);
1763 * Convenience function to add a label to this container/window.
1766 * @param x column relative to parent
1767 * @param y row relative to parent
1768 * @param colorKey ColorTheme key color to use for foreground text.
1769 * Default is "tlabel"
1770 * @param action to call when shortcut is pressed
1771 * @return the new label
1773 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1774 final String colorKey
, final TAction action
) {
1776 return new TLabel(this, text
, x
, y
, colorKey
, action
);
1780 * Convenience function to add a label to this container/window.
1783 * @param x column relative to parent
1784 * @param y row relative to parent
1785 * @param colorKey ColorTheme key color to use for foreground text.
1786 * Default is "tlabel"
1787 * @param useWindowBackground if true, use the window's background color
1788 * @return the new label
1790 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1791 final String colorKey
, final boolean useWindowBackground
) {
1793 return new TLabel(this, text
, x
, y
, colorKey
, useWindowBackground
);
1797 * Convenience function to add a label to this container/window.
1800 * @param x column relative to parent
1801 * @param y row relative to parent
1802 * @param colorKey ColorTheme key color to use for foreground text.
1803 * Default is "tlabel"
1804 * @param useWindowBackground if true, use the window's background color
1805 * @param action to call when shortcut is pressed
1806 * @return the new label
1808 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1809 final String colorKey
, final boolean useWindowBackground
,
1810 final TAction action
) {
1812 return new TLabel(this, text
, x
, y
, colorKey
, useWindowBackground
,
1817 * Convenience function to add a button to this container/window.
1819 * @param text label on the button
1820 * @param x column relative to parent
1821 * @param y row relative to parent
1822 * @param action action to call when button is pressed
1823 * @return the new button
1825 public final TButton
addButton(final String text
, final int x
, final int y
,
1826 final TAction action
) {
1828 return new TButton(this, text
, x
, y
, action
);
1832 * Convenience function to add a checkbox to this container/window.
1834 * @param x column relative to parent
1835 * @param y row relative to parent
1836 * @param label label to display next to (right of) the checkbox
1837 * @param checked initial check state
1838 * @return the new checkbox
1840 public final TCheckBox
addCheckBox(final int x
, final int y
,
1841 final String label
, final boolean checked
) {
1843 return new TCheckBox(this, x
, y
, label
, checked
);
1847 * Convenience function to add a combobox to this container/window.
1849 * @param x column relative to parent
1850 * @param y row relative to parent
1851 * @param width visible combobox width, including the down-arrow
1852 * @param values the possible values for the box, shown in the drop-down
1853 * @param valuesIndex the initial index in values, or -1 for no default
1855 * @param maxValuesHeight the maximum height of the values drop-down when
1857 * @param updateAction action to call when a new value is selected from
1858 * the list or enter is pressed in the edit field
1859 * @return the new combobox
1861 public final TComboBox
addComboBox(final int x
, final int y
,
1862 final int width
, final List
<String
> values
, final int valuesIndex
,
1863 final int maxValuesHeight
, final TAction updateAction
) {
1865 return new TComboBox(this, x
, y
, width
, values
, valuesIndex
,
1866 maxValuesHeight
, updateAction
);
1870 * Convenience function to add a spinner to this container/window.
1872 * @param x column relative to parent
1873 * @param y row relative to parent
1874 * @param upAction action to call when the up arrow is clicked or pressed
1875 * @param downAction action to call when the down arrow is clicked or
1877 * @return the new spinner
1879 public final TSpinner
addSpinner(final int x
, final int y
,
1880 final TAction upAction
, final TAction downAction
) {
1882 return new TSpinner(this, x
, y
, upAction
, downAction
);
1886 * Convenience function to add a calendar to this container/window.
1888 * @param x column relative to parent
1889 * @param y row relative to parent
1890 * @param updateAction action to call when the user changes the value of
1892 * @return the new calendar
1894 public final TCalendar
addCalendar(final int x
, final int y
,
1895 final TAction updateAction
) {
1897 return new TCalendar(this, x
, y
, updateAction
);
1901 * Convenience function to add a progress bar to this container/window.
1903 * @param x column relative to parent
1904 * @param y row relative to parent
1905 * @param width width of progress bar
1906 * @param value initial value of percent complete
1907 * @return the new progress bar
1909 public final TProgressBar
addProgressBar(final int x
, final int y
,
1910 final int width
, final int value
) {
1912 return new TProgressBar(this, x
, y
, width
, value
);
1916 * Convenience function to add a radio button group to this
1919 * @param x column relative to parent
1920 * @param y row relative to parent
1921 * @param label label to display on the group box
1922 * @return the new radio button group
1924 public final TRadioGroup
addRadioGroup(final int x
, final int y
,
1925 final String label
) {
1927 return new TRadioGroup(this, x
, y
, label
);
1931 * Convenience function to add a text field to this container/window.
1933 * @param x column relative to parent
1934 * @param y row relative to parent
1935 * @param width visible text width
1936 * @param fixed if true, the text cannot exceed the display width
1937 * @return the new text field
1939 public final TField
addField(final int x
, final int y
,
1940 final int width
, final boolean fixed
) {
1942 return new TField(this, x
, y
, width
, fixed
);
1946 * Convenience function to add a text field to this container/window.
1948 * @param x column relative to parent
1949 * @param y row relative to parent
1950 * @param width visible text width
1951 * @param fixed if true, the text cannot exceed the display width
1952 * @param text initial text, default is empty string
1953 * @return the new text field
1955 public final TField
addField(final int x
, final int y
,
1956 final int width
, final boolean fixed
, final String text
) {
1958 return new TField(this, x
, y
, width
, fixed
, text
);
1962 * Convenience function to add a text field to this container/window.
1964 * @param x column relative to parent
1965 * @param y row relative to parent
1966 * @param width visible text width
1967 * @param fixed if true, the text cannot exceed the display width
1968 * @param text initial text, default is empty string
1969 * @param enterAction function to call when enter key is pressed
1970 * @param updateAction function to call when the text is updated
1971 * @return the new text field
1973 public final TField
addField(final int x
, final int y
,
1974 final int width
, final boolean fixed
, final String text
,
1975 final TAction enterAction
, final TAction updateAction
) {
1977 return new TField(this, x
, y
, width
, fixed
, text
, enterAction
,
1982 * Convenience function to add a scrollable text box to this
1985 * @param text text on the screen
1986 * @param x column relative to parent
1987 * @param y row relative to parent
1988 * @param width width of text area
1989 * @param height height of text area
1990 * @param colorKey ColorTheme key color to use for foreground text
1991 * @return the new text box
1993 public final TText
addText(final String text
, final int x
,
1994 final int y
, final int width
, final int height
, final String colorKey
) {
1996 return new TText(this, text
, x
, y
, width
, height
, colorKey
);
2000 * Convenience function to add a scrollable text box to this
2003 * @param text text on the screen
2004 * @param x column relative to parent
2005 * @param y row relative to parent
2006 * @param width width of text area
2007 * @param height height of text area
2008 * @return the new text box
2010 public final TText
addText(final String text
, final int x
, final int y
,
2011 final int width
, final int height
) {
2013 return new TText(this, text
, x
, y
, width
, height
, "ttext");
2017 * Convenience function to add an editable text area box to this
2020 * @param text text on the screen
2021 * @param x column relative to parent
2022 * @param y row relative to parent
2023 * @param width width of text area
2024 * @param height height of text area
2025 * @return the new text box
2027 public final TEditorWidget
addEditor(final String text
, final int x
,
2028 final int y
, final int width
, final int height
) {
2030 return new TEditorWidget(this, text
, x
, y
, width
, height
);
2034 * Convenience function to spawn a message box.
2036 * @param title window title, will be centered along the top border
2037 * @param caption message to display. Use embedded newlines to get a
2039 * @return the new message box
2041 public final TMessageBox
messageBox(final String title
,
2042 final String caption
) {
2044 return getApplication().messageBox(title
, caption
, TMessageBox
.Type
.OK
);
2048 * Convenience function to spawn a message box.
2050 * @param title window title, will be centered along the top border
2051 * @param caption message to display. Use embedded newlines to get a
2053 * @param type one of the TMessageBox.Type constants. Default is
2055 * @return the new message box
2057 public final TMessageBox
messageBox(final String title
,
2058 final String caption
, final TMessageBox
.Type type
) {
2060 return getApplication().messageBox(title
, caption
, type
);
2064 * Convenience function to spawn an input box.
2066 * @param title window title, will be centered along the top border
2067 * @param caption message to display. Use embedded newlines to get a
2069 * @return the new input box
2071 public final TInputBox
inputBox(final String title
, final String caption
) {
2073 return getApplication().inputBox(title
, caption
);
2077 * Convenience function to spawn an input box.
2079 * @param title window title, will be centered along the top border
2080 * @param caption message to display. Use embedded newlines to get a
2082 * @param text initial text to seed the field with
2083 * @return the new input box
2085 public final TInputBox
inputBox(final String title
, final String caption
,
2086 final String text
) {
2088 return getApplication().inputBox(title
, caption
, text
);
2092 * Convenience function to spawn an input box.
2094 * @param title window title, will be centered along the top border
2095 * @param caption message to display. Use embedded newlines to get a
2097 * @param text initial text to seed the field with
2098 * @param type one of the Type constants. Default is Type.OK.
2099 * @return the new input box
2101 public final TInputBox
inputBox(final String title
, final String caption
,
2102 final String text
, final TInputBox
.Type type
) {
2104 return getApplication().inputBox(title
, caption
, text
, type
);
2108 * Convenience function to add a password text field to this
2111 * @param x column relative to parent
2112 * @param y row relative to parent
2113 * @param width visible text width
2114 * @param fixed if true, the text cannot exceed the display width
2115 * @return the new text field
2117 public final TPasswordField
addPasswordField(final int x
, final int y
,
2118 final int width
, final boolean fixed
) {
2120 return new TPasswordField(this, x
, y
, width
, fixed
);
2124 * Convenience function to add a password text field to this
2127 * @param x column relative to parent
2128 * @param y row relative to parent
2129 * @param width visible text width
2130 * @param fixed if true, the text cannot exceed the display width
2131 * @param text initial text, default is empty string
2132 * @return the new text field
2134 public final TPasswordField
addPasswordField(final int x
, final int y
,
2135 final int width
, final boolean fixed
, final String text
) {
2137 return new TPasswordField(this, x
, y
, width
, fixed
, text
);
2141 * Convenience function to add a password text field to this
2144 * @param x column relative to parent
2145 * @param y row relative to parent
2146 * @param width visible text width
2147 * @param fixed if true, the text cannot exceed the display width
2148 * @param text initial text, default is empty string
2149 * @param enterAction function to call when enter key is pressed
2150 * @param updateAction function to call when the text is updated
2151 * @return the new text field
2153 public final TPasswordField
addPasswordField(final int x
, final int y
,
2154 final int width
, final boolean fixed
, final String text
,
2155 final TAction enterAction
, final TAction updateAction
) {
2157 return new TPasswordField(this, x
, y
, width
, fixed
, text
, enterAction
,
2162 * Convenience function to add a scrollable tree view to this
2165 * @param x column relative to parent
2166 * @param y row relative to parent
2167 * @param width width of tree view
2168 * @param height height of tree view
2169 * @return the new tree view
2171 public final TTreeViewWidget
addTreeViewWidget(final int x
, final int y
,
2172 final int width
, final int height
) {
2174 return new TTreeViewWidget(this, x
, y
, width
, height
);
2178 * Convenience function to add a scrollable tree view to this
2181 * @param x column relative to parent
2182 * @param y row relative to parent
2183 * @param width width of tree view
2184 * @param height height of tree view
2185 * @param action action to perform when an item is selected
2186 * @return the new tree view
2188 public final TTreeViewWidget
addTreeViewWidget(final int x
, final int y
,
2189 final int width
, final int height
, final TAction action
) {
2191 return new TTreeViewWidget(this, x
, y
, width
, height
, action
);
2195 * Convenience function to spawn a file open box.
2197 * @param path path of selected file
2198 * @return the result of the new file open box
2199 * @throws IOException if a java.io operation throws
2201 public final String
fileOpenBox(final String path
) throws IOException
{
2202 return getApplication().fileOpenBox(path
);
2206 * Convenience function to spawn a file save box.
2208 * @param path path of selected file
2209 * @return the result of the new file open box
2210 * @throws IOException if a java.io operation throws
2212 public final String
fileSaveBox(final String path
) throws IOException
{
2213 return getApplication().fileOpenBox(path
, TFileOpenBox
.Type
.SAVE
);
2217 * Convenience function to spawn a file open box.
2219 * @param path path of selected file
2220 * @param type one of the Type constants
2221 * @return the result of the new file open box
2222 * @throws IOException if a java.io operation throws
2224 public final String
fileOpenBox(final String path
,
2225 final TFileOpenBox
.Type type
) throws IOException
{
2227 return getApplication().fileOpenBox(path
, type
);
2231 * Convenience function to spawn a file open box.
2233 * @param path path of selected file
2234 * @param type one of the Type constants
2235 * @param filter a string that files must match to be displayed
2236 * @return the result of the new file open box
2237 * @throws IOException of a java.io operation throws
2239 public final String
fileOpenBox(final String path
,
2240 final TFileOpenBox
.Type type
, final String filter
) throws IOException
{
2242 ArrayList
<String
> filters
= new ArrayList
<String
>();
2243 filters
.add(filter
);
2245 return getApplication().fileOpenBox(path
, type
, filters
);
2249 * Convenience function to spawn a file open box.
2251 * @param path path of selected file
2252 * @param type one of the Type constants
2253 * @param filters a list of strings that files must match to be displayed
2254 * @return the result of the new file open box
2255 * @throws IOException of a java.io operation throws
2257 public final String
fileOpenBox(final String path
,
2258 final TFileOpenBox
.Type type
,
2259 final List
<String
> filters
) throws IOException
{
2261 return getApplication().fileOpenBox(path
, type
, filters
);
2265 * Convenience function to add a directory list to this container/window.
2267 * @param path directory path, must be a directory
2268 * @param x column relative to parent
2269 * @param y row relative to parent
2270 * @param width width of text area
2271 * @param height height of text area
2272 * @return the new directory list
2274 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2275 final int y
, final int width
, final int height
) {
2277 return new TDirectoryList(this, path
, x
, y
, width
, height
, null);
2281 * Convenience function to add a directory list to this container/window.
2283 * @param path directory path, must be a directory
2284 * @param x column relative to parent
2285 * @param y row relative to parent
2286 * @param width width of text area
2287 * @param height height of text area
2288 * @param action action to perform when an item is selected (enter or
2290 * @return the new directory list
2292 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2293 final int y
, final int width
, final int height
, final TAction action
) {
2295 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
);
2299 * Convenience function to add a directory list to this container/window.
2301 * @param path directory path, must be a directory
2302 * @param x column relative to parent
2303 * @param y row relative to parent
2304 * @param width width of text area
2305 * @param height height of text area
2306 * @param action action to perform when an item is selected (enter or
2308 * @param singleClickAction action to perform when an item is selected
2310 * @return the new directory list
2312 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2313 final int y
, final int width
, final int height
, final TAction action
,
2314 final TAction singleClickAction
) {
2316 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
,
2321 * Convenience function to add a directory list to this container/window.
2323 * @param path directory path, must be a directory
2324 * @param x column relative to parent
2325 * @param y row relative to parent
2326 * @param width width of text area
2327 * @param height height of text area
2328 * @param action action to perform when an item is selected (enter or
2330 * @param singleClickAction action to perform when an item is selected
2332 * @param filters a list of strings that files must match to be displayed
2333 * @return the new directory list
2335 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2336 final int y
, final int width
, final int height
, final TAction action
,
2337 final TAction singleClickAction
, final List
<String
> filters
) {
2339 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
,
2340 singleClickAction
, filters
);
2344 * Convenience function to add a list to this container/window.
2346 * @param strings list of strings to show
2347 * @param x column relative to parent
2348 * @param y row relative to parent
2349 * @param width width of text area
2350 * @param height height of text area
2351 * @return the new directory list
2353 public final TList
addList(final List
<String
> strings
, final int x
,
2354 final int y
, final int width
, final int height
) {
2356 return new TList(this, strings
, x
, y
, width
, height
, null);
2360 * Convenience function to add a list to this container/window.
2362 * @param strings list of strings to show
2363 * @param x column relative to parent
2364 * @param y row relative to parent
2365 * @param width width of text area
2366 * @param height height of text area
2367 * @param enterAction action to perform when an item is selected
2368 * @return the new directory list
2370 public final TList
addList(final List
<String
> strings
, final int x
,
2371 final int y
, final int width
, final int height
,
2372 final TAction enterAction
) {
2374 return new TList(this, strings
, x
, y
, width
, height
, enterAction
);
2378 * Convenience function to add a list to this container/window.
2380 * @param strings list of strings to show
2381 * @param x column relative to parent
2382 * @param y row relative to parent
2383 * @param width width of text area
2384 * @param height height of text area
2385 * @param enterAction action to perform when an item is selected
2386 * @param moveAction action to perform when the user navigates to a new
2387 * item with arrow/page keys
2388 * @return the new directory list
2390 public final TList
addList(final List
<String
> strings
, final int x
,
2391 final int y
, final int width
, final int height
,
2392 final TAction enterAction
, final TAction moveAction
) {
2394 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,
2399 * Convenience function to add a list to this container/window.
2401 * @param strings list of strings to show. This is allowed to be null
2402 * and set later with setList() or by subclasses.
2403 * @param x column relative to parent
2404 * @param y row relative to parent
2405 * @param width width of text area
2406 * @param height height of text area
2407 * @param enterAction action to perform when an item is selected
2408 * @param moveAction action to perform when the user navigates to a new
2409 * item with arrow/page keys
2410 * @param singleClickAction action to perform when the user clicks on an
2413 public TList
addList(final List
<String
> strings
, final int x
,
2414 final int y
, final int width
, final int height
,
2415 final TAction enterAction
, final TAction moveAction
,
2416 final TAction singleClickAction
) {
2418 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,
2419 moveAction
, singleClickAction
);
2424 * Convenience function to add an image to this container/window.
2426 * @param x column relative to parent
2427 * @param y row relative to parent
2428 * @param width number of text cells for width of the image
2429 * @param height number of text cells for height of the image
2430 * @param image the image to display
2431 * @param left left column of the image. 0 is the left-most column.
2432 * @param top top row of the image. 0 is the top-most row.
2434 public final TImage
addImage(final int x
, final int y
,
2435 final int width
, final int height
,
2436 final BufferedImage image
, final int left
, final int top
) {
2438 return new TImage(this, x
, y
, width
, height
, image
, left
, top
);
2442 * Convenience function to add an image to this container/window.
2444 * @param x column relative to parent
2445 * @param y row relative to parent
2446 * @param width number of text cells for width of the image
2447 * @param height number of text cells for height of the image
2448 * @param image the image to display
2449 * @param left left column of the image. 0 is the left-most column.
2450 * @param top top row of the image. 0 is the top-most row.
2451 * @param clickAction function to call when mouse is pressed
2453 public final TImage
addImage(final int x
, final int y
,
2454 final int width
, final int height
,
2455 final BufferedImage image
, final int left
, final int top
,
2456 final TAction clickAction
) {
2458 return new TImage(this, x
, y
, width
, height
, image
, left
, top
,
2463 * Convenience function to add an editable 2D data table to this
2466 * @param x column relative to parent
2467 * @param y row relative to parent
2468 * @param width width of widget
2469 * @param height height of widget
2471 public TTableWidget
addTable(final int x
, final int y
, final int width
,
2474 return new TTableWidget(this, x
, y
, width
, height
);
2478 * Convenience function to add an editable 2D data table to this
2481 * @param x column relative to parent
2482 * @param y row relative to parent
2483 * @param width width of widget
2484 * @param height height of widget
2485 * @param gridColumns number of columns in grid
2486 * @param gridRows number of rows in grid
2488 public TTableWidget
addTable(final int x
, final int y
, final int width
,
2489 final int height
, final int gridColumns
, final int gridRows
) {
2491 return new TTableWidget(this, x
, y
, width
, height
, gridColumns
,
2496 * Convenience function to add a panel to this container/window.
2498 * @param x column relative to parent
2499 * @param y row relative to parent
2500 * @param width width of text area
2501 * @param height height of text area
2502 * @return the new panel
2504 public final TPanel
addPanel(final int x
, final int y
, final int width
,
2507 return new TPanel(this, x
, y
, width
, height
);