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
) {
615 // Special case: if a split command comes in, insert a TPanel and
616 // TSplitPane in the hierarchy here.
618 TSplitPane pane
= null;
619 List
<TWidget
> widgets
= null;
620 switch (menu
.getId()) {
621 case TMenu
.MID_SPLIT_VERTICAL
:
622 if (children
.size() == 0) {
625 panel
= new TPanel(null, x
, y
, width
, height
);
626 pane
= new TSplitPane(null, x
, y
, width
, height
, true);
627 widgets
= new ArrayList
<TWidget
>(children
);
628 for (TWidget w
: widgets
) {
629 w
.setParent(panel
, false);
632 pane
.setParent(this, false);
635 for (TWidget w
: widgets
) {
636 assert (w
.window
!= null);
637 assert (w
.parent
!= null);
639 assert (pane
.getWindow() != null);
640 assert (pane
.getParent() != null);
641 assert (panel
.getWindow() != null);
642 assert (panel
.getParent() != null);
643 assert (pane
.isActive() == true);
644 assert (panel
.isActive() == true);
646 case TMenu
.MID_SPLIT_HORIZONTAL
:
647 if (children
.size() == 0) {
650 panel
= new TPanel(null, x
, y
, width
, height
);
651 pane
= new TSplitPane(null, x
, y
, width
, height
, false);
652 widgets
= new ArrayList
<TWidget
>(children
);
653 for (TWidget w
: widgets
) {
654 w
.setParent(panel
, false);
657 pane
.setParent(this, false);
660 for (TWidget w
: widgets
) {
661 assert (w
.window
!= null);
662 assert (w
.parent
!= null);
664 assert (pane
.getWindow() != null);
665 assert (pane
.getParent() != null);
666 assert (panel
.getWindow() != null);
667 assert (panel
.getParent() != null);
668 assert (pane
.isActive() == true);
669 assert (panel
.isActive() == true);
675 // Default: do nothing, pass to children instead
676 for (TWidget widget
: children
) {
682 * Method that subclasses can override to do processing when the UI is
683 * idle. Note that repainting is NOT assumed. To get a refresh after
684 * onIdle, call doRepaint().
686 public void onIdle() {
687 // Default: do nothing, pass to children instead
688 for (TWidget widget
: children
) {
694 * Consume event. Subclasses that want to intercept all events in one go
695 * can override this method.
697 * @param event keyboard, mouse, resize, command, or menu event
699 public void handleEvent(final TInputEvent event
) {
701 System.err.printf("TWidget (%s) event: %s\n", this.getClass().getName(),
707 // System.err.println(" -- discard --");
711 if (event
instanceof TKeypressEvent
) {
712 onKeypress((TKeypressEvent
) event
);
713 } else if (event
instanceof TMouseEvent
) {
715 TMouseEvent mouse
= (TMouseEvent
) event
;
717 switch (mouse
.getType()) {
728 onMouseMotion(mouse
);
731 case MOUSE_DOUBLE_CLICK
:
732 onMouseDoubleClick(mouse
);
736 throw new IllegalArgumentException("Invalid mouse event type: "
739 } else if (event
instanceof TResizeEvent
) {
740 onResize((TResizeEvent
) event
);
741 } else if (event
instanceof TCommandEvent
) {
742 onCommand((TCommandEvent
) event
);
743 } else if (event
instanceof TMenuEvent
) {
744 onMenu((TMenuEvent
) event
);
751 // ------------------------------------------------------------------------
752 // TWidget ----------------------------------------------------------------
753 // ------------------------------------------------------------------------
758 * @return parent widget
760 public final TWidget
getParent() {
765 * Get the list of child widgets that this widget contains.
767 * @return the list of child widgets
769 public List
<TWidget
> getChildren() {
774 * Remove this widget from its parent container. close() will be called
775 * before it is removed.
777 public final void remove() {
782 * Remove this widget from its parent container.
784 * @param doClose if true, call the close() method before removing the
787 public final void remove(final boolean doClose
) {
788 if (parent
!= null) {
789 parent
.remove(this, doClose
);
794 * Remove a child widget from this container.
796 * @param child the child widget to remove
798 public final void remove(final TWidget child
) {
803 * Remove a child widget from this container.
805 * @param child the child widget to remove
806 * @param doClose if true, call the close() method before removing the
809 public final void remove(final TWidget child
, final boolean doClose
) {
810 if (!children
.contains(child
)) {
811 throw new IndexOutOfBoundsException("child widget is not in " +
812 "list of children of this parent");
817 children
.remove(child
);
820 if (layout
!= null) {
826 * Set this widget's parent to a different widget.
828 * @param newParent new parent widget
829 * @param doClose if true, call the close() method before removing the
830 * child from its existing parent widget
832 public final void setParent(final TWidget newParent
,
833 final boolean doClose
) {
835 if (parent
!= null) {
836 parent
.remove(this, doClose
);
839 assert (parent
== null);
840 assert (window
== null);
842 setWindow(parent
.window
);
843 parent
.addChild(this);
847 * Set this widget's window to a specific window.
849 * Having a null parent with a specified window is only used within Jexer
850 * by TStatusBar because TApplication routes events directly to it and
851 * calls its draw() method. Any other non-parented widgets will require
852 * similar special case functionality to receive events or be drawn to
855 * @param window the window to use
857 public final void setWindow(final TWindow window
) {
858 this.window
= window
;
859 for (TWidget child
: getChildren()) {
860 child
.setWindow(window
);
865 * Remove a child widget from this container, and all of its children
866 * recursively from their parent containers.
868 * @param child the child widget to remove
869 * @param doClose if true, call the close() method before removing each
872 public final void removeAll(final TWidget child
, final boolean doClose
) {
873 remove(child
, doClose
);
874 for (TWidget w
: child
.children
) {
875 child
.removeAll(w
, doClose
);
882 * @return if true, this widget will receive events
884 public final boolean isActive() {
891 * @param active if true, this widget will receive events
893 public final void setActive(final boolean active
) {
894 this.active
= active
;
898 * Get the window this widget is on.
902 public final TWindow
getWindow() {
909 * @return absolute X position of the top-left corner
911 public final int getX() {
918 * @param x absolute X position of the top-left corner
920 public final void setX(final int x
) {
927 * @return absolute Y position of the top-left corner
929 public final int getY() {
936 * @param y absolute Y position of the top-left corner
938 public final void setY(final int y
) {
945 * @return widget width
947 public int getWidth() {
954 * @param width new widget width
956 public void setWidth(final int width
) {
958 if (layout
!= null) {
959 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
967 * @return widget height
969 public int getHeight() {
976 * @param height new widget height
978 public void setHeight(final int height
) {
979 this.height
= height
;
980 if (layout
!= null) {
981 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
987 * Change the dimensions.
989 * @param x absolute X position of the top-left corner
990 * @param y absolute Y position of the top-left corner
991 * @param width new widget width
992 * @param height new widget height
994 public final void setDimensions(final int x
, final int y
, final int width
,
1001 if (layout
!= null) {
1002 layout
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
1008 * Get the layout manager.
1010 * @return the layout manager, or null if not set
1012 public LayoutManager
getLayoutManager() {
1017 * Set the layout manager.
1019 * @param layout the new layout manager
1021 public void setLayoutManager(LayoutManager layout
) {
1022 if (this.layout
!= null) {
1023 for (TWidget w
: children
) {
1024 this.layout
.remove(w
);
1028 this.layout
= layout
;
1029 if (this.layout
!= null) {
1030 for (TWidget w
: children
) {
1039 * @return if true, this widget can be tabbed to or receive events
1041 public final boolean isEnabled() {
1048 * @param enabled if true, this widget can be tabbed to or receive events
1050 public final void setEnabled(final boolean enabled
) {
1051 this.enabled
= enabled
;
1054 // See if there are any active siblings to switch to
1055 boolean foundSibling
= false;
1056 if (parent
!= null) {
1057 for (TWidget w
: parent
.children
) {
1059 && !(this instanceof THScroller
)
1060 && !(this instanceof TVScroller
)
1063 foundSibling
= true;
1067 if (!foundSibling
) {
1068 parent
.activeChild
= null;
1077 * @param visible if true, this widget will be drawn
1079 public final void setVisible(final boolean visible
) {
1080 this.visible
= visible
;
1084 * See if this widget is visible.
1086 * @return if true, this widget will be drawn
1088 public final boolean isVisible() {
1093 * Set visible cursor flag.
1095 * @param cursorVisible if true, this widget has a cursor
1097 public final void setCursorVisible(final boolean cursorVisible
) {
1098 this.cursorVisible
= cursorVisible
;
1102 * See if this widget has a visible cursor.
1104 * @return if true, this widget has a visible cursor
1106 public final boolean isCursorVisible() {
1107 // If cursor is out of my bounds, it is not visible.
1108 if ((cursorX
>= width
)
1110 || (cursorY
>= height
)
1116 assert (window
!= null);
1118 // If cursor is out of my window's bounds, it is not visible.
1119 if ((getCursorAbsoluteX() >= window
.getAbsoluteX()
1120 + window
.getWidth() - 1)
1121 || (getCursorAbsoluteX() < 0)
1122 || (getCursorAbsoluteY() >= window
.getAbsoluteY()
1123 + window
.getHeight() - 1)
1124 || (getCursorAbsoluteY() < 0)
1128 return cursorVisible
;
1132 * Get cursor X value.
1134 * @return cursor column position in relative coordinates
1136 public final int getCursorX() {
1141 * Set cursor X value.
1143 * @param cursorX column position in relative coordinates
1145 public final void setCursorX(final int cursorX
) {
1146 this.cursorX
= cursorX
;
1150 * Get cursor Y value.
1152 * @return cursor row position in relative coordinates
1154 public final int getCursorY() {
1159 * Set cursor Y value.
1161 * @param cursorY row position in relative coordinates
1163 public final void setCursorY(final int cursorY
) {
1164 this.cursorY
= cursorY
;
1168 * Get this TWidget's parent TApplication.
1170 * @return the parent TApplication, or null if not assigned
1172 public TApplication
getApplication() {
1173 if (window
!= null) {
1174 return window
.getApplication();
1182 * @return the Screen, or null if not assigned
1184 public Screen
getScreen() {
1185 if (window
!= null) {
1186 return window
.getScreen();
1192 * Comparison operator. For various subclasses it sorts on:
1194 * <li>tabOrder for TWidgets</li>
1195 * <li>z for TWindows</li>
1196 * <li>text for TTreeItems</li>
1199 * @param that another TWidget, TWindow, or TTreeItem instance
1200 * @return difference between this.tabOrder and that.tabOrder, or
1201 * difference between this.z and that.z, or String.compareTo(text)
1203 public final int compareTo(final TWidget that
) {
1204 if ((this instanceof TWindow
)
1205 && (that
instanceof TWindow
)
1207 return (((TWindow
) this).getZ() - ((TWindow
) that
).getZ());
1209 if ((this instanceof TTreeItem
)
1210 && (that
instanceof TTreeItem
)
1212 return (((TTreeItem
) this).getText().compareTo(
1213 ((TTreeItem
) that
).getText()));
1215 return (this.tabOrder
- that
.tabOrder
);
1219 * See if this widget should render with the active color.
1221 * @return true if this widget is active and all of its parents are
1224 public final boolean isAbsoluteActive() {
1225 if (parent
== this) {
1228 return (active
&& (parent
== null ?
true : parent
.isAbsoluteActive()));
1232 * Returns the cursor X position.
1234 * @return absolute screen column number for the cursor's X position
1236 public final int getCursorAbsoluteX() {
1237 return getAbsoluteX() + cursorX
;
1241 * Returns the cursor Y position.
1243 * @return absolute screen row number for the cursor's Y position
1245 public final int getCursorAbsoluteY() {
1246 return getAbsoluteY() + cursorY
;
1250 * Compute my absolute X position as the sum of my X plus all my parent's
1253 * @return absolute screen column number for my X position
1255 public final int getAbsoluteX() {
1256 assert (parent
!= null);
1257 if (parent
== this) {
1260 if ((parent
instanceof TWindow
)
1261 && !(parent
instanceof TMenu
)
1262 && !(parent
instanceof TDesktop
)
1264 // Widgets on a TWindow have (0,0) as their top-left, but this is
1265 // actually the TWindow's (1,1).
1266 return parent
.getAbsoluteX() + x
+ 1;
1268 return parent
.getAbsoluteX() + x
;
1272 * Compute my absolute Y position as the sum of my Y plus all my parent's
1275 * @return absolute screen row number for my Y position
1277 public final int getAbsoluteY() {
1278 assert (parent
!= null);
1279 if (parent
== this) {
1282 if ((parent
instanceof TWindow
)
1283 && !(parent
instanceof TMenu
)
1284 && !(parent
instanceof TDesktop
)
1286 // Widgets on a TWindow have (0,0) as their top-left, but this is
1287 // actually the TWindow's (1,1).
1288 return parent
.getAbsoluteY() + y
+ 1;
1290 return parent
.getAbsoluteY() + y
;
1294 * Get the global color theme.
1296 * @return the ColorTheme
1298 protected final ColorTheme
getTheme() {
1299 return window
.getApplication().getTheme();
1303 * Draw my specific widget. When called, the screen rectangle I draw
1304 * into is already setup (offset and clipping).
1306 public void draw() {
1307 // Default widget draws nothing.
1311 * Called by parent to render to TWindow. Note package private access.
1313 final void drawChildren() {
1314 // Set my clipping rectangle
1315 assert (window
!= null);
1316 assert (getScreen() != null);
1317 Screen screen
= getScreen();
1319 // Special case: TStatusBar is drawn by TApplication, not anything
1321 if (this instanceof TStatusBar
) {
1325 screen
.setClipRight(width
);
1326 screen
.setClipBottom(height
);
1328 int absoluteRightEdge
= window
.getAbsoluteX() + window
.getWidth();
1329 int absoluteBottomEdge
= window
.getAbsoluteY() + window
.getHeight();
1330 if (!(this instanceof TWindow
) && !(this instanceof TVScroller
)) {
1331 absoluteRightEdge
-= 1;
1333 if (!(this instanceof TWindow
) && !(this instanceof THScroller
)) {
1334 absoluteBottomEdge
-= 1;
1336 int myRightEdge
= getAbsoluteX() + width
;
1337 int myBottomEdge
= getAbsoluteY() + height
;
1338 if (getAbsoluteX() > absoluteRightEdge
) {
1340 screen
.setClipRight(0);
1341 } else if (myRightEdge
> absoluteRightEdge
) {
1342 screen
.setClipRight(screen
.getClipRight()
1343 - (myRightEdge
- absoluteRightEdge
));
1345 if (getAbsoluteY() > absoluteBottomEdge
) {
1347 screen
.setClipBottom(0);
1348 } else if (myBottomEdge
> absoluteBottomEdge
) {
1349 screen
.setClipBottom(screen
.getClipBottom()
1350 - (myBottomEdge
- absoluteBottomEdge
));
1354 screen
.setOffsetX(getAbsoluteX());
1355 screen
.setOffsetY(getAbsoluteY());
1359 assert (visible
== true);
1361 // Continue down the chain. Draw the active child last so that it
1363 for (TWidget widget
: children
) {
1364 if (widget
.isVisible() && (widget
!= activeChild
)) {
1365 widget
.drawChildren();
1368 if (activeChild
!= null) {
1369 activeChild
.drawChildren();
1374 * Repaint the screen on the next update.
1376 protected final void doRepaint() {
1377 window
.getApplication().doRepaint();
1381 * Add a child widget to my list of children. We set its tabOrder to 0
1382 * and increment the tabOrder of all other children.
1384 * @param child TWidget to add
1386 private void addChild(final TWidget child
) {
1387 children
.add(child
);
1390 && !(child
instanceof THScroller
)
1391 && !(child
instanceof TVScroller
)
1393 for (TWidget widget
: children
) {
1394 widget
.active
= false;
1396 child
.active
= true;
1397 activeChild
= child
;
1399 for (int i
= 0; i
< children
.size(); i
++) {
1400 children
.get(i
).tabOrder
= i
;
1402 if (layout
!= null) {
1408 * Reset the tab order of children to match their position in the list.
1409 * Available so that subclasses can re-order their widgets if needed.
1411 protected void resetTabOrder() {
1412 for (int i
= 0; i
< children
.size(); i
++) {
1413 children
.get(i
).tabOrder
= i
;
1418 * Switch the active child.
1420 * @param child TWidget to activate
1422 public final void activate(final TWidget child
) {
1423 assert (child
.enabled
);
1424 if ((child
instanceof THScroller
)
1425 || (child
instanceof TVScroller
)
1430 if (children
.size() == 1) {
1431 if (children
.get(0).enabled
== true) {
1432 child
.active
= true;
1433 activeChild
= child
;
1436 if (child
!= activeChild
) {
1437 if (activeChild
!= null) {
1438 activeChild
.active
= false;
1440 child
.active
= true;
1441 activeChild
= child
;
1447 * Switch the active child.
1449 * @param tabOrder tabOrder of the child to activate. If that child
1450 * isn't enabled, then the next enabled child will be activated.
1452 public final void activate(final int tabOrder
) {
1453 if (children
.size() == 1) {
1454 if (children
.get(0).enabled
== true) {
1455 children
.get(0).active
= true;
1456 activeChild
= children
.get(0);
1461 TWidget child
= null;
1462 for (TWidget widget
: children
) {
1463 if ((widget
.enabled
)
1464 && !(widget
instanceof THScroller
)
1465 && !(widget
instanceof TVScroller
)
1466 && (widget
.tabOrder
>= tabOrder
)
1472 if ((child
!= null) && (child
!= activeChild
)) {
1473 if (activeChild
!= null) {
1474 activeChild
.active
= false;
1476 assert (child
.enabled
);
1477 child
.active
= true;
1478 activeChild
= child
;
1483 * Make this widget the active child of its parent. Note that this is
1484 * not final since TWindow overrides activate().
1486 public void activate() {
1488 if (parent
!= null) {
1489 parent
.activate(this);
1495 * Switch the active widget with the next in the tab order.
1497 * @param forward if true, then switch to the next enabled widget in the
1498 * list, otherwise switch to the previous enabled widget in the list
1500 public final void switchWidget(final boolean forward
) {
1502 // No children: do nothing.
1503 if (children
.size() == 0) {
1507 assert (parent
!= null);
1509 // If there is only one child, make it active if it is enabled.
1510 if (children
.size() == 1) {
1511 if (children
.get(0).enabled
== true) {
1512 activeChild
= children
.get(0);
1513 activeChild
.active
= true;
1515 children
.get(0).active
= false;
1521 // Two or more children: go forward or backward to the next enabled
1524 if (activeChild
!= null) {
1525 tabOrder
= activeChild
.tabOrder
;
1535 // If at the end, pass the switch to my parent.
1536 if ((!forward
) && (parent
!= this)) {
1537 parent
.switchWidget(forward
);
1541 tabOrder
= children
.size() - 1;
1542 } else if (tabOrder
== children
.size()) {
1543 // If at the end, pass the switch to my parent.
1544 if ((forward
) && (parent
!= this)) {
1545 parent
.switchWidget(forward
);
1551 if (activeChild
== null) {
1552 if (tabOrder
== 0) {
1553 // We wrapped around
1556 } else if (activeChild
.tabOrder
== tabOrder
) {
1557 // We wrapped around
1560 } while ((!children
.get(tabOrder
).enabled
)
1561 && !(children
.get(tabOrder
) instanceof THScroller
)
1562 && !(children
.get(tabOrder
) instanceof TVScroller
));
1564 if (activeChild
!= null) {
1565 assert (children
.get(tabOrder
).enabled
);
1567 activeChild
.active
= false;
1569 if (children
.get(tabOrder
).enabled
== true) {
1570 children
.get(tabOrder
).active
= true;
1571 activeChild
= children
.get(tabOrder
);
1576 * Returns my active widget.
1578 * @return widget that is active, or this if no children
1580 public TWidget
getActiveChild() {
1581 if ((this instanceof THScroller
)
1582 || (this instanceof TVScroller
)
1587 for (TWidget widget
: children
) {
1588 if (widget
.active
) {
1589 return widget
.getActiveChild();
1592 // No active children, return me
1596 // ------------------------------------------------------------------------
1597 // Passthru for Screen functions ------------------------------------------
1598 // ------------------------------------------------------------------------
1601 * Get the attributes at one location.
1603 * @param x column coordinate. 0 is the left-most column.
1604 * @param y row coordinate. 0 is the top-most row.
1605 * @return attributes at (x, y)
1607 protected final CellAttributes
getAttrXY(final int x
, final int y
) {
1608 return getScreen().getAttrXY(x
, y
);
1612 * Set the attributes at one location.
1614 * @param x column coordinate. 0 is the left-most column.
1615 * @param y row coordinate. 0 is the top-most row.
1616 * @param attr attributes to use (bold, foreColor, backColor)
1618 protected final void putAttrXY(final int x
, final int y
,
1619 final CellAttributes attr
) {
1621 getScreen().putAttrXY(x
, y
, attr
);
1625 * Set the attributes at one location.
1627 * @param x column coordinate. 0 is the left-most column.
1628 * @param y row coordinate. 0 is the top-most row.
1629 * @param attr attributes to use (bold, foreColor, backColor)
1630 * @param clip if true, honor clipping/offset
1632 protected final void putAttrXY(final int x
, final int y
,
1633 final CellAttributes attr
, final boolean clip
) {
1635 getScreen().putAttrXY(x
, y
, attr
, clip
);
1639 * Fill the entire screen with one character with attributes.
1641 * @param ch character to draw
1642 * @param attr attributes to use (bold, foreColor, backColor)
1644 protected final void putAll(final int ch
, final CellAttributes attr
) {
1645 getScreen().putAll(ch
, attr
);
1649 * Render one character with attributes.
1651 * @param x column coordinate. 0 is the left-most column.
1652 * @param y row coordinate. 0 is the top-most row.
1653 * @param ch character + attributes to draw
1655 protected final void putCharXY(final int x
, final int y
, final Cell ch
) {
1656 getScreen().putCharXY(x
, y
, ch
);
1660 * Render one character with attributes.
1662 * @param x column coordinate. 0 is the left-most column.
1663 * @param y row coordinate. 0 is the top-most row.
1664 * @param ch character to draw
1665 * @param attr attributes to use (bold, foreColor, backColor)
1667 protected final void putCharXY(final int x
, final int y
, final int ch
,
1668 final CellAttributes attr
) {
1670 getScreen().putCharXY(x
, y
, ch
, attr
);
1674 * Render one character without changing the underlying attributes.
1676 * @param x column coordinate. 0 is the left-most column.
1677 * @param y row coordinate. 0 is the top-most row.
1678 * @param ch character to draw
1680 protected final void putCharXY(final int x
, final int y
, final int ch
) {
1681 getScreen().putCharXY(x
, y
, ch
);
1685 * Render a string. Does not wrap if the string exceeds the line.
1687 * @param x column coordinate. 0 is the left-most column.
1688 * @param y row coordinate. 0 is the top-most row.
1689 * @param str string to draw
1690 * @param attr attributes to use (bold, foreColor, backColor)
1692 protected final void putStringXY(final int x
, final int y
, final String str
,
1693 final CellAttributes attr
) {
1695 getScreen().putStringXY(x
, y
, str
, attr
);
1699 * Render a string without changing the underlying attribute. Does not
1700 * wrap if the string exceeds the line.
1702 * @param x column coordinate. 0 is the left-most column.
1703 * @param y row coordinate. 0 is the top-most row.
1704 * @param str string to draw
1706 protected final void putStringXY(final int x
, final int y
, final String str
) {
1707 getScreen().putStringXY(x
, y
, str
);
1711 * Draw a vertical line from (x, y) to (x, y + n).
1713 * @param x column coordinate. 0 is the left-most column.
1714 * @param y row coordinate. 0 is the top-most row.
1715 * @param n number of characters to draw
1716 * @param ch character to draw
1717 * @param attr attributes to use (bold, foreColor, backColor)
1719 protected final void vLineXY(final int x
, final int y
, final int n
,
1720 final int ch
, final CellAttributes attr
) {
1722 getScreen().vLineXY(x
, y
, n
, ch
, attr
);
1726 * Draw a horizontal line from (x, y) to (x + n, y).
1728 * @param x column coordinate. 0 is the left-most column.
1729 * @param y row coordinate. 0 is the top-most row.
1730 * @param n number of characters to draw
1731 * @param ch character to draw
1732 * @param attr attributes to use (bold, foreColor, backColor)
1734 protected final void hLineXY(final int x
, final int y
, final int n
,
1735 final int ch
, final CellAttributes attr
) {
1737 getScreen().hLineXY(x
, y
, n
, ch
, attr
);
1741 * Draw a box with a border and empty background.
1743 * @param left left column of box. 0 is the left-most row.
1744 * @param top top row of the box. 0 is the top-most row.
1745 * @param right right column of box
1746 * @param bottom bottom row of the box
1747 * @param border attributes to use for the border
1748 * @param background attributes to use for the background
1750 protected final void drawBox(final int left
, final int top
,
1751 final int right
, final int bottom
,
1752 final CellAttributes border
, final CellAttributes background
) {
1754 getScreen().drawBox(left
, top
, right
, bottom
, border
, background
);
1758 * Draw a box with a border and empty background.
1760 * @param left left column of box. 0 is the left-most row.
1761 * @param top top row of the box. 0 is the top-most row.
1762 * @param right right column of box
1763 * @param bottom bottom row of the box
1764 * @param border attributes to use for the border
1765 * @param background attributes to use for the background
1766 * @param borderType if 1, draw a single-line border; if 2, draw a
1767 * double-line border; if 3, draw double-line top/bottom edges and
1768 * single-line left/right edges (like Qmodem)
1769 * @param shadow if true, draw a "shadow" on the box
1771 protected final void drawBox(final int left
, final int top
,
1772 final int right
, final int bottom
,
1773 final CellAttributes border
, final CellAttributes background
,
1774 final int borderType
, final boolean shadow
) {
1776 getScreen().drawBox(left
, top
, right
, bottom
, border
, background
,
1777 borderType
, shadow
);
1781 * Draw a box shadow.
1783 * @param left left column of box. 0 is the left-most row.
1784 * @param top top row of the box. 0 is the top-most row.
1785 * @param right right column of box
1786 * @param bottom bottom row of the box
1788 protected final void drawBoxShadow(final int left
, final int top
,
1789 final int right
, final int bottom
) {
1791 getScreen().drawBoxShadow(left
, top
, right
, bottom
);
1794 // ------------------------------------------------------------------------
1795 // Other TWidget constructors ---------------------------------------------
1796 // ------------------------------------------------------------------------
1799 * Convenience function to add a label to this container/window.
1802 * @param x column relative to parent
1803 * @param y row relative to parent
1804 * @return the new label
1806 public final TLabel
addLabel(final String text
, final int x
, final int y
) {
1807 return addLabel(text
, x
, y
, "tlabel");
1811 * Convenience function to add a label to this container/window.
1814 * @param x column relative to parent
1815 * @param y row relative to parent
1816 * @param action to call when shortcut is pressed
1817 * @return the new label
1819 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1820 final TAction action
) {
1822 return addLabel(text
, x
, y
, "tlabel", action
);
1826 * Convenience function to add a label to this container/window.
1829 * @param x column relative to parent
1830 * @param y row relative to parent
1831 * @param colorKey ColorTheme key color to use for foreground text.
1832 * Default is "tlabel"
1833 * @return the new label
1835 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1836 final String colorKey
) {
1838 return new TLabel(this, text
, x
, y
, colorKey
);
1842 * Convenience function to add a label to this container/window.
1845 * @param x column relative to parent
1846 * @param y row relative to parent
1847 * @param colorKey ColorTheme key color to use for foreground text.
1848 * Default is "tlabel"
1849 * @param action to call when shortcut is pressed
1850 * @return the new label
1852 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1853 final String colorKey
, final TAction action
) {
1855 return new TLabel(this, text
, x
, y
, colorKey
, action
);
1859 * Convenience function to add a label to this container/window.
1862 * @param x column relative to parent
1863 * @param y row relative to parent
1864 * @param colorKey ColorTheme key color to use for foreground text.
1865 * Default is "tlabel"
1866 * @param useWindowBackground if true, use the window's background color
1867 * @return the new label
1869 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1870 final String colorKey
, final boolean useWindowBackground
) {
1872 return new TLabel(this, text
, x
, y
, colorKey
, useWindowBackground
);
1876 * Convenience function to add a label to this container/window.
1879 * @param x column relative to parent
1880 * @param y row relative to parent
1881 * @param colorKey ColorTheme key color to use for foreground text.
1882 * Default is "tlabel"
1883 * @param useWindowBackground if true, use the window's background color
1884 * @param action to call when shortcut is pressed
1885 * @return the new label
1887 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1888 final String colorKey
, final boolean useWindowBackground
,
1889 final TAction action
) {
1891 return new TLabel(this, text
, x
, y
, colorKey
, useWindowBackground
,
1896 * Convenience function to add a button to this container/window.
1898 * @param text label on the button
1899 * @param x column relative to parent
1900 * @param y row relative to parent
1901 * @param action action to call when button is pressed
1902 * @return the new button
1904 public final TButton
addButton(final String text
, final int x
, final int y
,
1905 final TAction action
) {
1907 return new TButton(this, text
, x
, y
, action
);
1911 * Convenience function to add a checkbox to this container/window.
1913 * @param x column relative to parent
1914 * @param y row relative to parent
1915 * @param label label to display next to (right of) the checkbox
1916 * @param checked initial check state
1917 * @return the new checkbox
1919 public final TCheckBox
addCheckBox(final int x
, final int y
,
1920 final String label
, final boolean checked
) {
1922 return new TCheckBox(this, x
, y
, label
, checked
);
1926 * Convenience function to add a combobox to this container/window.
1928 * @param x column relative to parent
1929 * @param y row relative to parent
1930 * @param width visible combobox width, including the down-arrow
1931 * @param values the possible values for the box, shown in the drop-down
1932 * @param valuesIndex the initial index in values, or -1 for no default
1934 * @param maxValuesHeight the maximum height of the values drop-down when
1936 * @param updateAction action to call when a new value is selected from
1937 * the list or enter is pressed in the edit field
1938 * @return the new combobox
1940 public final TComboBox
addComboBox(final int x
, final int y
,
1941 final int width
, final List
<String
> values
, final int valuesIndex
,
1942 final int maxValuesHeight
, final TAction updateAction
) {
1944 return new TComboBox(this, x
, y
, width
, values
, valuesIndex
,
1945 maxValuesHeight
, updateAction
);
1949 * Convenience function to add a spinner to this container/window.
1951 * @param x column relative to parent
1952 * @param y row relative to parent
1953 * @param upAction action to call when the up arrow is clicked or pressed
1954 * @param downAction action to call when the down arrow is clicked or
1956 * @return the new spinner
1958 public final TSpinner
addSpinner(final int x
, final int y
,
1959 final TAction upAction
, final TAction downAction
) {
1961 return new TSpinner(this, x
, y
, upAction
, downAction
);
1965 * Convenience function to add a calendar to this container/window.
1967 * @param x column relative to parent
1968 * @param y row relative to parent
1969 * @param updateAction action to call when the user changes the value of
1971 * @return the new calendar
1973 public final TCalendar
addCalendar(final int x
, final int y
,
1974 final TAction updateAction
) {
1976 return new TCalendar(this, x
, y
, updateAction
);
1980 * Convenience function to add a progress bar to this container/window.
1982 * @param x column relative to parent
1983 * @param y row relative to parent
1984 * @param width width of progress bar
1985 * @param value initial value of percent complete
1986 * @return the new progress bar
1988 public final TProgressBar
addProgressBar(final int x
, final int y
,
1989 final int width
, final int value
) {
1991 return new TProgressBar(this, x
, y
, width
, value
);
1995 * Convenience function to add a radio button group to this
1998 * @param x column relative to parent
1999 * @param y row relative to parent
2000 * @param label label to display on the group box
2001 * @return the new radio button group
2003 public final TRadioGroup
addRadioGroup(final int x
, final int y
,
2004 final String label
) {
2006 return new TRadioGroup(this, x
, y
, label
);
2010 * Convenience function to add a text field to this container/window.
2012 * @param x column relative to parent
2013 * @param y row relative to parent
2014 * @param width visible text width
2015 * @param fixed if true, the text cannot exceed the display width
2016 * @return the new text field
2018 public final TField
addField(final int x
, final int y
,
2019 final int width
, final boolean fixed
) {
2021 return new TField(this, x
, y
, width
, fixed
);
2025 * Convenience function to add a text field to this container/window.
2027 * @param x column relative to parent
2028 * @param y row relative to parent
2029 * @param width visible text width
2030 * @param fixed if true, the text cannot exceed the display width
2031 * @param text initial text, default is empty string
2032 * @return the new text field
2034 public final TField
addField(final int x
, final int y
,
2035 final int width
, final boolean fixed
, final String text
) {
2037 return new TField(this, x
, y
, width
, fixed
, text
);
2041 * Convenience function to add a text field to this container/window.
2043 * @param x column relative to parent
2044 * @param y row relative to parent
2045 * @param width visible text width
2046 * @param fixed if true, the text cannot exceed the display width
2047 * @param text initial text, default is empty string
2048 * @param enterAction function to call when enter key is pressed
2049 * @param updateAction function to call when the text is updated
2050 * @return the new text field
2052 public final TField
addField(final int x
, final int y
,
2053 final int width
, final boolean fixed
, final String text
,
2054 final TAction enterAction
, final TAction updateAction
) {
2056 return new TField(this, x
, y
, width
, fixed
, text
, enterAction
,
2061 * Convenience function to add a scrollable text box to this
2064 * @param text text on the screen
2065 * @param x column relative to parent
2066 * @param y row relative to parent
2067 * @param width width of text area
2068 * @param height height of text area
2069 * @param colorKey ColorTheme key color to use for foreground text
2070 * @return the new text box
2072 public final TText
addText(final String text
, final int x
,
2073 final int y
, final int width
, final int height
, final String colorKey
) {
2075 return new TText(this, text
, x
, y
, width
, height
, colorKey
);
2079 * Convenience function to add a scrollable text box to this
2082 * @param text text on the screen
2083 * @param x column relative to parent
2084 * @param y row relative to parent
2085 * @param width width of text area
2086 * @param height height of text area
2087 * @return the new text box
2089 public final TText
addText(final String text
, final int x
, final int y
,
2090 final int width
, final int height
) {
2092 return new TText(this, text
, x
, y
, width
, height
, "ttext");
2096 * Convenience function to add an editable text area box to this
2099 * @param text text on the screen
2100 * @param x column relative to parent
2101 * @param y row relative to parent
2102 * @param width width of text area
2103 * @param height height of text area
2104 * @return the new text box
2106 public final TEditorWidget
addEditor(final String text
, final int x
,
2107 final int y
, final int width
, final int height
) {
2109 return new TEditorWidget(this, text
, x
, y
, width
, height
);
2113 * Convenience function to spawn a message box.
2115 * @param title window title, will be centered along the top border
2116 * @param caption message to display. Use embedded newlines to get a
2118 * @return the new message box
2120 public final TMessageBox
messageBox(final String title
,
2121 final String caption
) {
2123 return getApplication().messageBox(title
, caption
, TMessageBox
.Type
.OK
);
2127 * Convenience function to spawn a message box.
2129 * @param title window title, will be centered along the top border
2130 * @param caption message to display. Use embedded newlines to get a
2132 * @param type one of the TMessageBox.Type constants. Default is
2134 * @return the new message box
2136 public final TMessageBox
messageBox(final String title
,
2137 final String caption
, final TMessageBox
.Type type
) {
2139 return getApplication().messageBox(title
, caption
, type
);
2143 * Convenience function to spawn an input box.
2145 * @param title window title, will be centered along the top border
2146 * @param caption message to display. Use embedded newlines to get a
2148 * @return the new input box
2150 public final TInputBox
inputBox(final String title
, final String caption
) {
2152 return getApplication().inputBox(title
, caption
);
2156 * Convenience function to spawn an input box.
2158 * @param title window title, will be centered along the top border
2159 * @param caption message to display. Use embedded newlines to get a
2161 * @param text initial text to seed the field with
2162 * @return the new input box
2164 public final TInputBox
inputBox(final String title
, final String caption
,
2165 final String text
) {
2167 return getApplication().inputBox(title
, caption
, text
);
2171 * Convenience function to spawn an input box.
2173 * @param title window title, will be centered along the top border
2174 * @param caption message to display. Use embedded newlines to get a
2176 * @param text initial text to seed the field with
2177 * @param type one of the Type constants. Default is Type.OK.
2178 * @return the new input box
2180 public final TInputBox
inputBox(final String title
, final String caption
,
2181 final String text
, final TInputBox
.Type type
) {
2183 return getApplication().inputBox(title
, caption
, text
, type
);
2187 * Convenience function to add a password text field to this
2190 * @param x column relative to parent
2191 * @param y row relative to parent
2192 * @param width visible text width
2193 * @param fixed if true, the text cannot exceed the display width
2194 * @return the new text field
2196 public final TPasswordField
addPasswordField(final int x
, final int y
,
2197 final int width
, final boolean fixed
) {
2199 return new TPasswordField(this, x
, y
, width
, fixed
);
2203 * Convenience function to add a password text field to this
2206 * @param x column relative to parent
2207 * @param y row relative to parent
2208 * @param width visible text width
2209 * @param fixed if true, the text cannot exceed the display width
2210 * @param text initial text, default is empty string
2211 * @return the new text field
2213 public final TPasswordField
addPasswordField(final int x
, final int y
,
2214 final int width
, final boolean fixed
, final String text
) {
2216 return new TPasswordField(this, x
, y
, width
, fixed
, text
);
2220 * Convenience function to add a password text field to this
2223 * @param x column relative to parent
2224 * @param y row relative to parent
2225 * @param width visible text width
2226 * @param fixed if true, the text cannot exceed the display width
2227 * @param text initial text, default is empty string
2228 * @param enterAction function to call when enter key is pressed
2229 * @param updateAction function to call when the text is updated
2230 * @return the new text field
2232 public final TPasswordField
addPasswordField(final int x
, final int y
,
2233 final int width
, final boolean fixed
, final String text
,
2234 final TAction enterAction
, final TAction updateAction
) {
2236 return new TPasswordField(this, x
, y
, width
, fixed
, text
, enterAction
,
2241 * Convenience function to add a scrollable tree view to this
2244 * @param x column relative to parent
2245 * @param y row relative to parent
2246 * @param width width of tree view
2247 * @param height height of tree view
2248 * @return the new tree view
2250 public final TTreeViewWidget
addTreeViewWidget(final int x
, final int y
,
2251 final int width
, final int height
) {
2253 return new TTreeViewWidget(this, x
, y
, width
, height
);
2257 * Convenience function to add a scrollable tree view to this
2260 * @param x column relative to parent
2261 * @param y row relative to parent
2262 * @param width width of tree view
2263 * @param height height of tree view
2264 * @param action action to perform when an item is selected
2265 * @return the new tree view
2267 public final TTreeViewWidget
addTreeViewWidget(final int x
, final int y
,
2268 final int width
, final int height
, final TAction action
) {
2270 return new TTreeViewWidget(this, x
, y
, width
, height
, action
);
2274 * Convenience function to spawn a file open box.
2276 * @param path path of selected file
2277 * @return the result of the new file open box
2278 * @throws IOException if a java.io operation throws
2280 public final String
fileOpenBox(final String path
) throws IOException
{
2281 return getApplication().fileOpenBox(path
);
2285 * Convenience function to spawn a file save box.
2287 * @param path path of selected file
2288 * @return the result of the new file open box
2289 * @throws IOException if a java.io operation throws
2291 public final String
fileSaveBox(final String path
) throws IOException
{
2292 return getApplication().fileOpenBox(path
, TFileOpenBox
.Type
.SAVE
);
2296 * Convenience function to spawn a file open box.
2298 * @param path path of selected file
2299 * @param type one of the Type constants
2300 * @return the result of the new file open box
2301 * @throws IOException if a java.io operation throws
2303 public final String
fileOpenBox(final String path
,
2304 final TFileOpenBox
.Type type
) throws IOException
{
2306 return getApplication().fileOpenBox(path
, type
);
2310 * Convenience function to spawn a file open box.
2312 * @param path path of selected file
2313 * @param type one of the Type constants
2314 * @param filter a string that files must match to be displayed
2315 * @return the result of the new file open box
2316 * @throws IOException of a java.io operation throws
2318 public final String
fileOpenBox(final String path
,
2319 final TFileOpenBox
.Type type
, final String filter
) throws IOException
{
2321 ArrayList
<String
> filters
= new ArrayList
<String
>();
2322 filters
.add(filter
);
2324 return getApplication().fileOpenBox(path
, type
, filters
);
2328 * Convenience function to spawn a file open box.
2330 * @param path path of selected file
2331 * @param type one of the Type constants
2332 * @param filters a list of strings that files must match to be displayed
2333 * @return the result of the new file open box
2334 * @throws IOException of a java.io operation throws
2336 public final String
fileOpenBox(final String path
,
2337 final TFileOpenBox
.Type type
,
2338 final List
<String
> filters
) throws IOException
{
2340 return getApplication().fileOpenBox(path
, type
, filters
);
2344 * Convenience function to add a directory list to this container/window.
2346 * @param path directory path, must be a directory
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 TDirectoryList
addDirectoryList(final String path
, final int x
,
2354 final int y
, final int width
, final int height
) {
2356 return new TDirectoryList(this, path
, x
, y
, width
, height
, null);
2360 * Convenience function to add a directory list to this container/window.
2362 * @param path directory path, must be a directory
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 action action to perform when an item is selected (enter or
2369 * @return the new directory list
2371 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2372 final int y
, final int width
, final int height
, final TAction action
) {
2374 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
);
2378 * Convenience function to add a directory list to this container/window.
2380 * @param path directory path, must be a directory
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 action action to perform when an item is selected (enter or
2387 * @param singleClickAction action to perform when an item is selected
2389 * @return the new directory list
2391 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2392 final int y
, final int width
, final int height
, final TAction action
,
2393 final TAction singleClickAction
) {
2395 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
,
2400 * Convenience function to add a directory list to this container/window.
2402 * @param path directory path, must be a directory
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 action action to perform when an item is selected (enter or
2409 * @param singleClickAction action to perform when an item is selected
2411 * @param filters a list of strings that files must match to be displayed
2412 * @return the new directory list
2414 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
2415 final int y
, final int width
, final int height
, final TAction action
,
2416 final TAction singleClickAction
, final List
<String
> filters
) {
2418 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
,
2419 singleClickAction
, filters
);
2423 * Convenience function to add a list to this container/window.
2425 * @param strings list of strings to show
2426 * @param x column relative to parent
2427 * @param y row relative to parent
2428 * @param width width of text area
2429 * @param height height of text area
2430 * @return the new directory list
2432 public final TList
addList(final List
<String
> strings
, final int x
,
2433 final int y
, final int width
, final int height
) {
2435 return new TList(this, strings
, x
, y
, width
, height
, null);
2439 * Convenience function to add a list to this container/window.
2441 * @param strings list of strings to show
2442 * @param x column relative to parent
2443 * @param y row relative to parent
2444 * @param width width of text area
2445 * @param height height of text area
2446 * @param enterAction action to perform when an item is selected
2447 * @return the new directory list
2449 public final TList
addList(final List
<String
> strings
, final int x
,
2450 final int y
, final int width
, final int height
,
2451 final TAction enterAction
) {
2453 return new TList(this, strings
, x
, y
, width
, height
, enterAction
);
2457 * Convenience function to add a list to this container/window.
2459 * @param strings list of strings to show
2460 * @param x column relative to parent
2461 * @param y row relative to parent
2462 * @param width width of text area
2463 * @param height height of text area
2464 * @param enterAction action to perform when an item is selected
2465 * @param moveAction action to perform when the user navigates to a new
2466 * item with arrow/page keys
2467 * @return the new directory list
2469 public final TList
addList(final List
<String
> strings
, final int x
,
2470 final int y
, final int width
, final int height
,
2471 final TAction enterAction
, final TAction moveAction
) {
2473 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,
2478 * Convenience function to add a list to this container/window.
2480 * @param strings list of strings to show. This is allowed to be null
2481 * and set later with setList() or by subclasses.
2482 * @param x column relative to parent
2483 * @param y row relative to parent
2484 * @param width width of text area
2485 * @param height height of text area
2486 * @param enterAction action to perform when an item is selected
2487 * @param moveAction action to perform when the user navigates to a new
2488 * item with arrow/page keys
2489 * @param singleClickAction action to perform when the user clicks on an
2492 public TList
addList(final List
<String
> strings
, final int x
,
2493 final int y
, final int width
, final int height
,
2494 final TAction enterAction
, final TAction moveAction
,
2495 final TAction singleClickAction
) {
2497 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,
2498 moveAction
, singleClickAction
);
2503 * Convenience function to add an image to this container/window.
2505 * @param x column relative to parent
2506 * @param y row relative to parent
2507 * @param width number of text cells for width of the image
2508 * @param height number of text cells for height of the image
2509 * @param image the image to display
2510 * @param left left column of the image. 0 is the left-most column.
2511 * @param top top row of the image. 0 is the top-most row.
2513 public final TImage
addImage(final int x
, final int y
,
2514 final int width
, final int height
,
2515 final BufferedImage image
, final int left
, final int top
) {
2517 return new TImage(this, x
, y
, width
, height
, image
, left
, top
);
2521 * Convenience function to add an image to this container/window.
2523 * @param x column relative to parent
2524 * @param y row relative to parent
2525 * @param width number of text cells for width of the image
2526 * @param height number of text cells for height of the image
2527 * @param image the image to display
2528 * @param left left column of the image. 0 is the left-most column.
2529 * @param top top row of the image. 0 is the top-most row.
2530 * @param clickAction function to call when mouse is pressed
2532 public final TImage
addImage(final int x
, final int y
,
2533 final int width
, final int height
,
2534 final BufferedImage image
, final int left
, final int top
,
2535 final TAction clickAction
) {
2537 return new TImage(this, x
, y
, width
, height
, image
, left
, top
,
2542 * Convenience function to add an editable 2D data table to this
2545 * @param x column relative to parent
2546 * @param y row relative to parent
2547 * @param width width of widget
2548 * @param height height of widget
2550 public TTableWidget
addTable(final int x
, final int y
, final int width
,
2553 return new TTableWidget(this, x
, y
, width
, height
);
2557 * Convenience function to add an editable 2D data table to this
2560 * @param x column relative to parent
2561 * @param y row relative to parent
2562 * @param width width of widget
2563 * @param height height of widget
2564 * @param gridColumns number of columns in grid
2565 * @param gridRows number of rows in grid
2567 public TTableWidget
addTable(final int x
, final int y
, final int width
,
2568 final int height
, final int gridColumns
, final int gridRows
) {
2570 return new TTableWidget(this, x
, y
, width
, height
, gridColumns
,
2575 * Convenience function to add a panel to this container/window.
2577 * @param x column relative to parent
2578 * @param y row relative to parent
2579 * @param width width of text area
2580 * @param height height of text area
2581 * @return the new panel
2583 public final TPanel
addPanel(final int x
, final int y
, final int width
,
2586 return new TPanel(this, x
, y
, width
, height
);
2590 * Convenience function to add a split pane to this container/window.
2592 * @param x column relative to parent
2593 * @param y row relative to parent
2594 * @param width width of text area
2595 * @param height height of text area
2596 * @param vertical if true, split vertically
2597 * @return the new split pane
2599 public final TSplitPane
addSplitPane(final int x
, final int y
,
2600 final int width
, final int height
, final boolean vertical
) {
2602 return new TSplitPane(this, x
, y
, width
, height
, vertical
);