2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 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
.io
.IOException
;
32 import java
.util
.List
;
33 import java
.util
.ArrayList
;
35 import jexer
.backend
.Screen
;
36 import jexer
.bits
.ColorTheme
;
37 import jexer
.event
.TCommandEvent
;
38 import jexer
.event
.TInputEvent
;
39 import jexer
.event
.TKeypressEvent
;
40 import jexer
.event
.TMenuEvent
;
41 import jexer
.event
.TMouseEvent
;
42 import jexer
.event
.TResizeEvent
;
43 import jexer
.menu
.TMenu
;
44 import static jexer
.TKeypress
.*;
47 * TWidget is the base class of all objects that can be drawn on screen or
48 * handle user input events.
50 public abstract class TWidget
implements Comparable
<TWidget
> {
52 // ------------------------------------------------------------------------
53 // Common widget attributes -----------------------------------------------
54 // ------------------------------------------------------------------------
57 * Every widget has a parent widget that it may be "contained" in. For
58 * example, a TWindow might contain several TTextFields, or a TComboBox
59 * may contain a TScrollBar.
61 private TWidget parent
= null;
66 * @return parent widget
68 public final TWidget
getParent() {
73 * Child widgets that this widget contains.
75 private List
<TWidget
> children
;
78 * Get the list of child widgets that this widget contains.
80 * @return the list of child widgets
82 public List
<TWidget
> getChildren() {
87 * The currently active child widget that will receive keypress events.
89 private TWidget activeChild
= null;
92 * If true, this widget will receive events.
94 private boolean active
= false;
99 * @return if true, this widget will receive events
101 public final boolean isActive() {
108 * @param active if true, this widget will receive events
110 public final void setActive(final boolean active
) {
111 this.active
= active
;
115 * The window that this widget draws to.
117 private TWindow window
= null;
120 * Get the window this widget is on.
124 public final TWindow
getWindow() {
129 * Absolute X position of the top-left corner.
136 * @return absolute X position of the top-left corner
138 public final int getX() {
145 * @param x absolute X position of the top-left corner
147 public final void setX(final int x
) {
152 * Absolute Y position of the top-left corner.
159 * @return absolute Y position of the top-left corner
161 public final int getY() {
168 * @param y absolute Y position of the top-left corner
170 public final void setY(final int y
) {
177 private int width
= 0;
182 * @return widget width
184 public final int getWidth() {
191 * @param width new widget width
193 public final void setWidth(final int width
) {
200 private int height
= 0;
205 * @return widget height
207 public final int getHeight() {
214 * @param height new widget height
216 public final void setHeight(final int height
) {
217 this.height
= height
;
221 * Change the dimensions.
223 * @param x absolute X position of the top-left corner
224 * @param y absolute Y position of the top-left corner
225 * @param width new widget width
226 * @param height new widget height
228 public final void setDimensions(final int x
, final int y
, final int width
,
238 * My tab order inside a window or containing widget.
240 private int tabOrder
= 0;
243 * If true, this widget can be tabbed to or receive events.
245 private boolean enabled
= true;
250 * @return if true, this widget can be tabbed to or receive events
252 public final boolean isEnabled() {
259 * @param enabled if true, this widget can be tabbed to or receive events
261 public final void setEnabled(final boolean enabled
) {
262 this.enabled
= enabled
;
265 // See if there are any active siblings to switch to
266 boolean foundSibling
= false;
267 if (parent
!= null) {
268 for (TWidget w
: parent
.children
) {
270 && !(this instanceof THScroller
)
271 && !(this instanceof TVScroller
)
279 parent
.activeChild
= null;
286 * If true, this widget has a cursor.
288 private boolean cursorVisible
= false;
291 * Set visible cursor flag.
293 * @param cursorVisible if true, this widget has a cursor
295 public final void setCursorVisible(final boolean cursorVisible
) {
296 this.cursorVisible
= cursorVisible
;
300 * See if this widget has a visible cursor.
302 * @return if true, this widget has a visible cursor
304 public final boolean isCursorVisible() {
305 // If cursor is out of my bounds, it is not visible.
306 if ((cursorX
>= width
)
308 || (cursorY
>= height
)
314 // If cursor is out of my window's bounds, it is not visible.
315 if ((getCursorAbsoluteX() >= window
.getAbsoluteX()
316 + window
.getWidth() - 1)
317 || (getCursorAbsoluteX() < 0)
318 || (getCursorAbsoluteY() >= window
.getAbsoluteY()
319 + window
.getHeight() - 1)
320 || (getCursorAbsoluteY() < 0)
324 return cursorVisible
;
328 * Cursor column position in relative coordinates.
330 private int cursorX
= 0;
333 * Get cursor X value.
335 * @return cursor column position in relative coordinates
337 public final int getCursorX() {
342 * Set cursor X value.
344 * @param cursorX column position in relative coordinates
346 public final void setCursorX(final int cursorX
) {
347 this.cursorX
= cursorX
;
351 * Cursor row position in relative coordinates.
353 private int cursorY
= 0;
356 * Get cursor Y value.
358 * @return cursor row position in relative coordinates
360 public final int getCursorY() {
365 * Set cursor Y value.
367 * @param cursorY row position in relative coordinates
369 public final void setCursorY(final int cursorY
) {
370 this.cursorY
= cursorY
;
373 // ------------------------------------------------------------------------
374 // TApplication integration -----------------------------------------------
375 // ------------------------------------------------------------------------
378 * Get this TWidget's parent TApplication.
380 * @return the parent TApplication
382 public TApplication
getApplication() {
383 return window
.getApplication();
391 public Screen
getScreen() {
392 return window
.getScreen();
396 * Comparison operator. For various subclasses it sorts on:
398 * <li>tabOrder for TWidgets</li>
399 * <li>z for TWindows</li>
400 * <li>text for TTreeItems</li>
403 * @param that another TWidget, TWindow, or TTreeItem instance
404 * @return difference between this.tabOrder and that.tabOrder, or
405 * difference between this.z and that.z, or String.compareTo(text)
407 public final int compareTo(final TWidget that
) {
408 if ((this instanceof TWindow
)
409 && (that
instanceof TWindow
)
411 return (((TWindow
) this).getZ() - ((TWindow
) that
).getZ());
413 if ((this instanceof TTreeItem
)
414 && (that
instanceof TTreeItem
)
416 return (((TTreeItem
) this).getText().compareTo(
417 ((TTreeItem
) that
).getText()));
419 return (this.tabOrder
- that
.tabOrder
);
423 * See if this widget should render with the active color.
425 * @return true if this widget is active and all of its parents are
428 public final boolean isAbsoluteActive() {
429 if (parent
== this) {
432 return (active
&& parent
.isAbsoluteActive());
436 * Returns the cursor X position.
438 * @return absolute screen column number for the cursor's X position
440 public final int getCursorAbsoluteX() {
441 assert (cursorVisible
);
442 return getAbsoluteX() + cursorX
;
446 * Returns the cursor Y position.
448 * @return absolute screen row number for the cursor's Y position
450 public final int getCursorAbsoluteY() {
451 assert (cursorVisible
);
452 return getAbsoluteY() + cursorY
;
456 * Compute my absolute X position as the sum of my X plus all my parent's
459 * @return absolute screen column number for my X position
461 public final int getAbsoluteX() {
462 assert (parent
!= null);
463 if (parent
== this) {
466 if ((parent
instanceof TWindow
)
467 && !(parent
instanceof TMenu
)
468 && !(parent
instanceof TDesktop
)
470 // Widgets on a TWindow have (0,0) as their top-left, but this is
471 // actually the TWindow's (1,1).
472 return parent
.getAbsoluteX() + x
+ 1;
474 return parent
.getAbsoluteX() + x
;
478 * Compute my absolute Y position as the sum of my Y plus all my parent's
481 * @return absolute screen row number for my Y position
483 public final int getAbsoluteY() {
484 assert (parent
!= null);
485 if (parent
== this) {
488 if ((parent
instanceof TWindow
)
489 && !(parent
instanceof TMenu
)
490 && !(parent
instanceof TDesktop
)
492 // Widgets on a TWindow have (0,0) as their top-left, but this is
493 // actually the TWindow's (1,1).
494 return parent
.getAbsoluteY() + y
+ 1;
496 return parent
.getAbsoluteY() + y
;
500 * Get the global color theme.
502 * @return the ColorTheme
504 public final ColorTheme
getTheme() {
505 return window
.getApplication().getTheme();
509 * Draw my specific widget. When called, the screen rectangle I draw
510 * into is already setup (offset and clipping).
513 // Default widget draws nothing.
517 * Called by parent to render to TWindow.
519 public final void drawChildren() {
520 // Set my clipping rectangle
521 assert (window
!= null);
522 assert (getScreen() != null);
523 Screen screen
= getScreen();
525 // Special case: TStatusBar is drawn by TApplication, not anything
527 if (this instanceof TStatusBar
) {
531 screen
.setClipRight(width
);
532 screen
.setClipBottom(height
);
534 int absoluteRightEdge
= window
.getAbsoluteX() + window
.getWidth();
535 int absoluteBottomEdge
= window
.getAbsoluteY() + window
.getHeight();
536 if (!(this instanceof TWindow
) && !(this instanceof TVScroller
)) {
537 absoluteRightEdge
-= 1;
539 if (!(this instanceof TWindow
) && !(this instanceof THScroller
)) {
540 absoluteBottomEdge
-= 1;
542 int myRightEdge
= getAbsoluteX() + width
;
543 int myBottomEdge
= getAbsoluteY() + height
;
544 if (getAbsoluteX() > absoluteRightEdge
) {
546 screen
.setClipRight(0);
547 } else if (myRightEdge
> absoluteRightEdge
) {
548 screen
.setClipRight(screen
.getClipRight()
549 - (myRightEdge
- absoluteRightEdge
));
551 if (getAbsoluteY() > absoluteBottomEdge
) {
553 screen
.setClipBottom(0);
554 } else if (myBottomEdge
> absoluteBottomEdge
) {
555 screen
.setClipBottom(screen
.getClipBottom()
556 - (myBottomEdge
- absoluteBottomEdge
));
560 screen
.setOffsetX(getAbsoluteX());
561 screen
.setOffsetY(getAbsoluteY());
566 // Continue down the chain
567 for (TWidget widget
: children
) {
568 widget
.drawChildren();
573 * Repaint the screen on the next update.
575 public void doRepaint() {
576 window
.getApplication().doRepaint();
579 // ------------------------------------------------------------------------
580 // Constructors -----------------------------------------------------------
581 // ------------------------------------------------------------------------
584 * Default constructor for subclasses.
586 protected TWidget() {
587 children
= new ArrayList
<TWidget
>();
591 * Protected constructor.
593 * @param parent parent widget
595 protected TWidget(final TWidget parent
) {
600 * Protected constructor.
602 * @param parent parent widget
603 * @param x column relative to parent
604 * @param y row relative to parent
605 * @param width width of widget
606 * @param height height of widget
608 protected TWidget(final TWidget parent
, final int x
, final int y
,
609 final int width
, final int height
) {
611 this(parent
, true, x
, y
, width
, height
);
615 * Protected constructor used by subclasses that are disabled by default.
617 * @param parent parent widget
618 * @param enabled if true assume enabled
620 protected TWidget(final TWidget parent
, final boolean enabled
) {
621 this.enabled
= enabled
;
622 this.parent
= parent
;
623 this.window
= parent
.window
;
624 children
= new ArrayList
<TWidget
>();
625 parent
.addChild(this);
629 * Protected constructor used by subclasses that are disabled by default.
631 * @param parent parent widget
632 * @param enabled if true assume enabled
633 * @param x column relative to parent
634 * @param y row relative to parent
635 * @param width width of widget
636 * @param height height of widget
638 protected TWidget(final TWidget parent
, final boolean enabled
,
639 final int x
, final int y
, final int width
, final int height
) {
641 this.enabled
= enabled
;
642 this.parent
= parent
;
643 this.window
= parent
.window
;
644 children
= new ArrayList
<TWidget
>();
645 parent
.addChild(this);
650 this.height
= height
;
654 * Backdoor access for TWindow's constructor. ONLY TWindow USES THIS.
656 * @param window the top-level window
657 * @param x column relative to parent
658 * @param y row relative to parent
659 * @param width width of window
660 * @param height height of window
662 protected final void setupForTWindow(final TWindow window
,
663 final int x
, final int y
, final int width
, final int height
) {
665 this.parent
= window
;
666 this.window
= window
;
670 this.height
= height
;
673 // ------------------------------------------------------------------------
674 // General behavior -------------------------------------------------------
675 // ------------------------------------------------------------------------
678 * Add a child widget to my list of children. We set its tabOrder to 0
679 * and increment the tabOrder of all other children.
681 * @param child TWidget to add
683 private void addChild(final TWidget child
) {
687 && !(child
instanceof THScroller
)
688 && !(child
instanceof TVScroller
)
690 for (TWidget widget
: children
) {
691 widget
.active
= false;
696 for (int i
= 0; i
< children
.size(); i
++) {
697 children
.get(i
).tabOrder
= i
;
702 * Switch the active child.
704 * @param child TWidget to activate
706 public final void activate(final TWidget child
) {
707 assert (child
.enabled
);
708 if ((child
instanceof THScroller
)
709 || (child
instanceof TVScroller
)
714 if (child
!= activeChild
) {
715 if (activeChild
!= null) {
716 activeChild
.active
= false;
724 * Switch the active child.
726 * @param tabOrder tabOrder of the child to activate. If that child
727 * isn't enabled, then the next enabled child will be activated.
729 public final void activate(final int tabOrder
) {
730 if (activeChild
== null) {
733 TWidget child
= null;
734 for (TWidget widget
: children
) {
736 && !(widget
instanceof THScroller
)
737 && !(widget
instanceof TVScroller
)
738 && (widget
.tabOrder
>= tabOrder
)
744 if ((child
!= null) && (child
!= activeChild
)) {
745 activeChild
.active
= false;
746 assert (child
.enabled
);
753 * Switch the active widget with the next in the tab order.
755 * @param forward if true, then switch to the next enabled widget in the
756 * list, otherwise switch to the previous enabled widget in the list
758 public final void switchWidget(final boolean forward
) {
760 // Only switch if there are multiple enabled widgets
761 if ((children
.size() < 2) || (activeChild
== null)) {
765 int tabOrder
= activeChild
.tabOrder
;
774 // If at the end, pass the switch to my parent.
775 if ((!forward
) && (parent
!= this)) {
776 parent
.switchWidget(forward
);
780 tabOrder
= children
.size() - 1;
781 } else if (tabOrder
== children
.size()) {
782 // If at the end, pass the switch to my parent.
783 if ((forward
) && (parent
!= this)) {
784 parent
.switchWidget(forward
);
790 if (activeChild
.tabOrder
== tabOrder
) {
794 } while ((!children
.get(tabOrder
).enabled
)
795 && !(children
.get(tabOrder
) instanceof THScroller
)
796 && !(children
.get(tabOrder
) instanceof TVScroller
));
798 assert (children
.get(tabOrder
).enabled
);
800 activeChild
.active
= false;
801 children
.get(tabOrder
).active
= true;
802 activeChild
= children
.get(tabOrder
);
806 * Returns my active widget.
808 * @return widget that is active, or this if no children
810 public TWidget
getActiveChild() {
811 if ((this instanceof THScroller
)
812 || (this instanceof TVScroller
)
817 for (TWidget widget
: children
) {
819 return widget
.getActiveChild();
822 // No active children, return me
826 // ------------------------------------------------------------------------
827 // Event handlers ---------------------------------------------------------
828 // ------------------------------------------------------------------------
831 * Check if a mouse press/release event coordinate is contained in this
834 * @param mouse a mouse-based event
835 * @return whether or not a mouse click would be sent to this widget
837 public final boolean mouseWouldHit(final TMouseEvent mouse
) {
843 if ((mouse
.getAbsoluteX() >= getAbsoluteX())
844 && (mouse
.getAbsoluteX() < getAbsoluteX() + width
)
845 && (mouse
.getAbsoluteY() >= getAbsoluteY())
846 && (mouse
.getAbsoluteY() < getAbsoluteY() + height
)
854 * Method that subclasses can override to handle keystrokes.
856 * @param keypress keystroke event
858 public void onKeypress(final TKeypressEvent keypress
) {
860 if ((children
.size() == 0)
861 || (this instanceof TTreeView
)
862 || (this instanceof TText
)
866 // tab / shift-tab - switch to next/previous widget
867 // right-arrow or down-arrow: same as tab
868 // left-arrow or up-arrow: same as shift-tab
869 if ((keypress
.equals(kbTab
))
870 || (keypress
.equals(kbRight
))
871 || (keypress
.equals(kbDown
))
873 parent
.switchWidget(true);
875 } else if ((keypress
.equals(kbShiftTab
))
876 || (keypress
.equals(kbBackTab
))
877 || (keypress
.equals(kbLeft
))
878 || (keypress
.equals(kbUp
))
880 parent
.switchWidget(false);
885 // If I have any buttons on me AND this is an Alt-key that matches
886 // its mnemonic, send it an Enter keystroke
887 for (TWidget widget
: children
) {
888 if (widget
instanceof TButton
) {
889 TButton button
= (TButton
) widget
;
890 if (button
.isEnabled()
891 && !keypress
.getKey().isFnKey()
892 && keypress
.getKey().isAlt()
893 && !keypress
.getKey().isCtrl()
894 && (Character
.toLowerCase(button
.getMnemonic().getShortcut())
895 == Character
.toLowerCase(keypress
.getKey().getChar()))
898 widget
.handleEvent(new TKeypressEvent(kbEnter
));
904 // Dispatch the keypress to an active widget
905 for (TWidget widget
: children
) {
907 widget
.handleEvent(keypress
);
914 * Method that subclasses can override to handle mouse button presses.
916 * @param mouse mouse button event
918 public void onMouseDown(final TMouseEvent mouse
) {
919 // Default: do nothing, pass to children instead
920 for (int i
= children
.size() - 1 ; i
>= 0 ; i
--) {
921 TWidget widget
= children
.get(i
);
922 if (widget
.mouseWouldHit(mouse
)) {
923 // Dispatch to this child, also activate it
926 // Set x and y relative to the child's coordinates
927 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
928 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
929 widget
.handleEvent(mouse
);
936 * Method that subclasses can override to handle mouse button releases.
938 * @param mouse mouse button event
940 public void onMouseUp(final TMouseEvent mouse
) {
941 // Default: do nothing, pass to children instead
942 for (int i
= children
.size() - 1 ; i
>= 0 ; i
--) {
943 TWidget widget
= children
.get(i
);
944 if (widget
.mouseWouldHit(mouse
)) {
945 // Dispatch to this child, also activate it
948 // Set x and y relative to the child's coordinates
949 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
950 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
951 widget
.handleEvent(mouse
);
958 * Method that subclasses can override to handle mouse movements.
960 * @param mouse mouse motion event
962 public void onMouseMotion(final TMouseEvent mouse
) {
963 // Default: do nothing, pass it on to ALL of my children. This way
964 // the children can see the mouse "leaving" their area.
965 for (TWidget widget
: children
) {
966 // Set x and y relative to the child's coordinates
967 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
968 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
969 widget
.handleEvent(mouse
);
974 * Method that subclasses can override to handle window/screen resize
977 * @param resize resize event
979 public void onResize(final TResizeEvent resize
) {
980 // Default: change my width/height.
981 if (resize
.getType() == TResizeEvent
.Type
.WIDGET
) {
982 width
= resize
.getWidth();
983 height
= resize
.getHeight();
985 // Let children see the screen resize
986 for (TWidget widget
: children
) {
987 widget
.onResize(resize
);
993 * Method that subclasses can override to handle posted command events.
995 * @param command command event
997 public void onCommand(final TCommandEvent command
) {
998 // Default: do nothing, pass to children instead
999 for (TWidget widget
: children
) {
1000 widget
.onCommand(command
);
1005 * Method that subclasses can override to handle menu or posted menu
1008 * @param menu menu event
1010 public void onMenu(final TMenuEvent menu
) {
1011 // Default: do nothing, pass to children instead
1012 for (TWidget widget
: children
) {
1013 widget
.onMenu(menu
);
1018 * Method that subclasses can override to do processing when the UI is
1019 * idle. Note that repainting is NOT assumed. To get a refresh after
1020 * onIdle, call doRepaint().
1022 public void onIdle() {
1023 // Default: do nothing, pass to children instead
1024 for (TWidget widget
: children
) {
1030 * Consume event. Subclasses that want to intercept all events in one go
1031 * can override this method.
1033 * @param event keyboard, mouse, resize, command, or menu event
1035 public void handleEvent(final TInputEvent event
) {
1036 // System.err.printf("TWidget (%s) event: %s\n", this.getClass().getName(),
1041 // System.err.println(" -- discard --");
1045 if (event
instanceof TKeypressEvent
) {
1046 onKeypress((TKeypressEvent
) event
);
1047 } else if (event
instanceof TMouseEvent
) {
1049 TMouseEvent mouse
= (TMouseEvent
) event
;
1051 switch (mouse
.getType()) {
1062 onMouseMotion(mouse
);
1066 throw new IllegalArgumentException("Invalid mouse event type: "
1069 } else if (event
instanceof TResizeEvent
) {
1070 onResize((TResizeEvent
) event
);
1071 } else if (event
instanceof TCommandEvent
) {
1072 onCommand((TCommandEvent
) event
);
1073 } else if (event
instanceof TMenuEvent
) {
1074 onMenu((TMenuEvent
) event
);
1081 // ------------------------------------------------------------------------
1082 // Other TWidget constructors ---------------------------------------------
1083 // ------------------------------------------------------------------------
1086 * Convenience function to add a label to this container/window.
1089 * @param x column relative to parent
1090 * @param y row relative to parent
1091 * @return the new label
1093 public final TLabel
addLabel(final String text
, final int x
, final int y
) {
1094 return addLabel(text
, x
, y
, "tlabel");
1098 * Convenience function to add a label to this container/window.
1101 * @param x column relative to parent
1102 * @param y row relative to parent
1103 * @param colorKey ColorTheme key color to use for foreground text.
1104 * Default is "tlabel"
1105 * @return the new label
1107 public final TLabel
addLabel(final String text
, final int x
, final int y
,
1108 final String colorKey
) {
1110 return new TLabel(this, text
, x
, y
, colorKey
);
1114 * Convenience function to add a button to this container/window.
1116 * @param text label on the button
1117 * @param x column relative to parent
1118 * @param y row relative to parent
1119 * @param action to call when button is pressed
1120 * @return the new button
1122 public final TButton
addButton(final String text
, final int x
, final int y
,
1123 final TAction action
) {
1125 return new TButton(this, text
, x
, y
, action
);
1129 * Convenience function to add a checkbox to this container/window.
1131 * @param x column relative to parent
1132 * @param y row relative to parent
1133 * @param label label to display next to (right of) the checkbox
1134 * @param checked initial check state
1135 * @return the new checkbox
1137 public final TCheckbox
addCheckbox(final int x
, final int y
,
1138 final String label
, final boolean checked
) {
1140 return new TCheckbox(this, x
, y
, label
, checked
);
1144 * Convenience function to add a progress bar to this container/window.
1146 * @param x column relative to parent
1147 * @param y row relative to parent
1148 * @param width width of progress bar
1149 * @param value initial value of percent complete
1150 * @return the new progress bar
1152 public final TProgressBar
addProgressBar(final int x
, final int y
,
1153 final int width
, final int value
) {
1155 return new TProgressBar(this, x
, y
, width
, value
);
1159 * Convenience function to add a radio button group to this
1162 * @param x column relative to parent
1163 * @param y row relative to parent
1164 * @param label label to display on the group box
1165 * @return the new radio button group
1167 public final TRadioGroup
addRadioGroup(final int x
, final int y
,
1168 final String label
) {
1170 return new TRadioGroup(this, x
, y
, label
);
1174 * Convenience function to add a text field to this container/window.
1176 * @param x column relative to parent
1177 * @param y row relative to parent
1178 * @param width visible text width
1179 * @param fixed if true, the text cannot exceed the display width
1180 * @return the new text field
1182 public final TField
addField(final int x
, final int y
,
1183 final int width
, final boolean fixed
) {
1185 return new TField(this, x
, y
, width
, fixed
);
1189 * Convenience function to add a text field to this container/window.
1191 * @param x column relative to parent
1192 * @param y row relative to parent
1193 * @param width visible text width
1194 * @param fixed if true, the text cannot exceed the display width
1195 * @param text initial text, default is empty string
1196 * @return the new text field
1198 public final TField
addField(final int x
, final int y
,
1199 final int width
, final boolean fixed
, final String text
) {
1201 return new TField(this, x
, y
, width
, fixed
, text
);
1205 * Convenience function to add a text field to this container/window.
1207 * @param x column relative to parent
1208 * @param y row relative to parent
1209 * @param width visible text width
1210 * @param fixed if true, the text cannot exceed the display width
1211 * @param text initial text, default is empty string
1212 * @param enterAction function to call when enter key is pressed
1213 * @param updateAction function to call when the text is updated
1214 * @return the new text field
1216 public final TField
addField(final int x
, final int y
,
1217 final int width
, final boolean fixed
, final String text
,
1218 final TAction enterAction
, final TAction updateAction
) {
1220 return new TField(this, x
, y
, width
, fixed
, text
, enterAction
,
1225 * Convenience function to add a scrollable text box to this
1228 * @param text text on the screen
1229 * @param x column relative to parent
1230 * @param y row relative to parent
1231 * @param width width of text area
1232 * @param height height of text area
1233 * @param colorKey ColorTheme key color to use for foreground text
1234 * @return the new text box
1236 public final TText
addText(final String text
, final int x
,
1237 final int y
, final int width
, final int height
, final String colorKey
) {
1239 return new TText(this, text
, x
, y
, width
, height
, colorKey
);
1243 * Convenience function to add a scrollable text box to this
1246 * @param text text on the screen
1247 * @param x column relative to parent
1248 * @param y row relative to parent
1249 * @param width width of text area
1250 * @param height height of text area
1251 * @return the new text box
1253 public final TText
addText(final String text
, final int x
, final int y
,
1254 final int width
, final int height
) {
1256 return new TText(this, text
, x
, y
, width
, height
, "ttext");
1260 * Convenience function to add an editable text area box to this
1263 * @param text text on the screen
1264 * @param x column relative to parent
1265 * @param y row relative to parent
1266 * @param width width of text area
1267 * @param height height of text area
1268 * @return the new text box
1270 public final TEditorWidget
addEditor(final String text
, final int x
,
1271 final int y
, final int width
, final int height
) {
1273 return new TEditorWidget(this, text
, x
, y
, width
, height
);
1277 * Convenience function to spawn a message box.
1279 * @param title window title, will be centered along the top border
1280 * @param caption message to display. Use embedded newlines to get a
1282 * @return the new message box
1284 public final TMessageBox
messageBox(final String title
,
1285 final String caption
) {
1287 return getApplication().messageBox(title
, caption
, TMessageBox
.Type
.OK
);
1291 * Convenience function to spawn a message box.
1293 * @param title window title, will be centered along the top border
1294 * @param caption message to display. Use embedded newlines to get a
1296 * @param type one of the TMessageBox.Type constants. Default is
1298 * @return the new message box
1300 public final TMessageBox
messageBox(final String title
,
1301 final String caption
, final TMessageBox
.Type type
) {
1303 return getApplication().messageBox(title
, caption
, type
);
1307 * Convenience function to spawn an input box.
1309 * @param title window title, will be centered along the top border
1310 * @param caption message to display. Use embedded newlines to get a
1312 * @return the new input box
1314 public final TInputBox
inputBox(final String title
, final String caption
) {
1316 return getApplication().inputBox(title
, caption
);
1320 * Convenience function to spawn an input box.
1322 * @param title window title, will be centered along the top border
1323 * @param caption message to display. Use embedded newlines to get a
1325 * @param text initial text to seed the field with
1326 * @return the new input box
1328 public final TInputBox
inputBox(final String title
, final String caption
,
1329 final String text
) {
1331 return getApplication().inputBox(title
, caption
, text
);
1335 * Convenience function to add a password text field to this
1338 * @param x column relative to parent
1339 * @param y row relative to parent
1340 * @param width visible text width
1341 * @param fixed if true, the text cannot exceed the display width
1342 * @return the new text field
1344 public final TPasswordField
addPasswordField(final int x
, final int y
,
1345 final int width
, final boolean fixed
) {
1347 return new TPasswordField(this, x
, y
, width
, fixed
);
1351 * Convenience function to add a password text field to this
1354 * @param x column relative to parent
1355 * @param y row relative to parent
1356 * @param width visible text width
1357 * @param fixed if true, the text cannot exceed the display width
1358 * @param text initial text, default is empty string
1359 * @return the new text field
1361 public final TPasswordField
addPasswordField(final int x
, final int y
,
1362 final int width
, final boolean fixed
, final String text
) {
1364 return new TPasswordField(this, x
, y
, width
, fixed
, text
);
1368 * Convenience function to add a password text field to this
1371 * @param x column relative to parent
1372 * @param y row relative to parent
1373 * @param width visible text width
1374 * @param fixed if true, the text cannot exceed the display width
1375 * @param text initial text, default is empty string
1376 * @param enterAction function to call when enter key is pressed
1377 * @param updateAction function to call when the text is updated
1378 * @return the new text field
1380 public final TPasswordField
addPasswordField(final int x
, final int y
,
1381 final int width
, final boolean fixed
, final String text
,
1382 final TAction enterAction
, final TAction updateAction
) {
1384 return new TPasswordField(this, x
, y
, width
, fixed
, text
, enterAction
,
1389 * Convenience function to add a tree view to this container/window.
1391 * @param x column relative to parent
1392 * @param y row relative to parent
1393 * @param width width of tree view
1394 * @param height height of tree view
1395 * @return the new tree view
1397 public final TTreeView
addTreeView(final int x
, final int y
,
1398 final int width
, final int height
) {
1400 return new TTreeView(this, x
, y
, width
, height
);
1404 * Convenience function to add a tree view to this container/window.
1406 * @param x column relative to parent
1407 * @param y row relative to parent
1408 * @param width width of tree view
1409 * @param height height of tree view
1410 * @param action action to perform when an item is selected
1411 * @return the new tree view
1413 public final TTreeView
addTreeView(final int x
, final int y
,
1414 final int width
, final int height
, final TAction action
) {
1416 return new TTreeView(this, x
, y
, width
, height
, action
);
1420 * Convenience function to spawn a file open box.
1422 * @param path path of selected file
1423 * @return the result of the new file open box
1424 * @throws IOException if a java.io operation throws
1426 public final String
fileOpenBox(final String path
) throws IOException
{
1427 return getApplication().fileOpenBox(path
);
1431 * Convenience function to spawn a file open box.
1433 * @param path path of selected file
1434 * @param type one of the Type constants
1435 * @return the result of the new file open box
1436 * @throws IOException if a java.io operation throws
1438 public final String
fileOpenBox(final String path
,
1439 final TFileOpenBox
.Type type
) throws IOException
{
1441 return getApplication().fileOpenBox(path
, type
);
1444 * Convenience function to add a directory list to this container/window.
1446 * @param path directory path, must be a directory
1447 * @param x column relative to parent
1448 * @param y row relative to parent
1449 * @param width width of text area
1450 * @param height height of text area
1451 * @return the new directory list
1453 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
1454 final int y
, final int width
, final int height
) {
1456 return new TDirectoryList(this, path
, x
, y
, width
, height
, null);
1460 * Convenience function to add a directory list to this container/window.
1462 * @param path directory path, must be a directory
1463 * @param x column relative to parent
1464 * @param y row relative to parent
1465 * @param width width of text area
1466 * @param height height of text area
1467 * @param action action to perform when an item is selected
1468 * @return the new directory list
1470 public final TDirectoryList
addDirectoryList(final String path
, final int x
,
1471 final int y
, final int width
, final int height
, final TAction action
) {
1473 return new TDirectoryList(this, path
, x
, y
, width
, height
, action
);
1477 * Convenience function to add a directory list to this container/window.
1479 * @param strings list of strings to show
1480 * @param x column relative to parent
1481 * @param y row relative to parent
1482 * @param width width of text area
1483 * @param height height of text area
1484 * @return the new directory list
1486 public final TList
addList(final List
<String
> strings
, final int x
,
1487 final int y
, final int width
, final int height
) {
1489 return new TList(this, strings
, x
, y
, width
, height
, null);
1493 * Convenience function to add a directory list to this container/window.
1495 * @param strings list of strings to show
1496 * @param x column relative to parent
1497 * @param y row relative to parent
1498 * @param width width of text area
1499 * @param height height of text area
1500 * @param enterAction action to perform when an item is selected
1501 * @return the new directory list
1503 public final TList
addList(final List
<String
> strings
, final int x
,
1504 final int y
, final int width
, final int height
,
1505 final TAction enterAction
) {
1507 return new TList(this, strings
, x
, y
, width
, height
, enterAction
);
1511 * Convenience function to add a directory list to this container/window.
1513 * @param strings list of strings to show
1514 * @param x column relative to parent
1515 * @param y row relative to parent
1516 * @param width width of text area
1517 * @param height height of text area
1518 * @param enterAction action to perform when an item is selected
1519 * @param moveAction action to perform when the user navigates to a new
1520 * item with arrow/page keys
1521 * @return the new directory list
1523 public final TList
addList(final List
<String
> strings
, final int x
,
1524 final int y
, final int width
, final int height
,
1525 final TAction enterAction
, final TAction moveAction
) {
1527 return new TList(this, strings
, x
, y
, width
, height
, enterAction
,