X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTWidget.java;h=f7a83a193620fa1350bc3905291cd2c2c5815523;hb=00691e80f2f135f92be739e2b7e86775a2357276;hp=7ea1a427cbb78227e40c9b4935139631a66b3919;hpb=7c870d89433346ccb5505f8f9ba62d3fc18fe996;p=nikiroo-utils.git diff --git a/src/jexer/TWidget.java b/src/jexer/TWidget.java index 7ea1a42..f7a83a1 100644 --- a/src/jexer/TWidget.java +++ b/src/jexer/TWidget.java @@ -1,38 +1,40 @@ -/** +/* * Jexer - Java Text User Interface * - * License: LGPLv3 or later - * - * This module is licensed under the GNU Lesser General Public License - * Version 3. Please see the file "COPYING" in this directory for more - * information about the GNU Lesser General Public License Version 3. + * The MIT License (MIT) * - * Copyright (C) 2015 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; either version 3 of - * the License, or (at your option) any later version. + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, see - * http://www.gnu.org/licenses/, or write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. * * @author Kevin Lamonte [kevin.lamonte@gmail.com] * @version 1 */ package jexer; +import java.io.IOException; import java.util.List; -import java.util.LinkedList; +import java.util.ArrayList; +import jexer.backend.Screen; +import jexer.bits.Cell; +import jexer.bits.CellAttributes; import jexer.bits.ColorTheme; import jexer.event.TCommandEvent; import jexer.event.TInputEvent; @@ -40,93 +42,648 @@ import jexer.event.TKeypressEvent; import jexer.event.TMenuEvent; import jexer.event.TMouseEvent; import jexer.event.TResizeEvent; -import jexer.io.Screen; import jexer.menu.TMenu; +import jexer.ttree.TTreeItem; +import jexer.ttree.TTreeView; +import jexer.ttree.TTreeViewWidget; import static jexer.TKeypress.*; -/** - * TWidget is the base class of all objects that can be drawn on screen or - * handle user input events. - */ -public abstract class TWidget implements Comparable { +/** + * TWidget is the base class of all objects that can be drawn on screen or + * handle user input events. + */ +public abstract class TWidget implements Comparable { + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Every widget has a parent widget that it may be "contained" in. For + * example, a TWindow might contain several TFields, or a TComboBox may + * contain a TList that itself contains a TVScroller. + */ + private TWidget parent = null; + + /** + * Child widgets that this widget contains. + */ + private List children; + + /** + * The currently active child widget that will receive keypress events. + */ + private TWidget activeChild = null; + + /** + * If true, this widget will receive events. + */ + private boolean active = false; + + /** + * The window that this widget draws to. + */ + private TWindow window = null; + + /** + * Absolute X position of the top-left corner. + */ + private int x = 0; + + /** + * Absolute Y position of the top-left corner. + */ + private int y = 0; + + /** + * Width. + */ + private int width = 0; + + /** + * Height. + */ + private int height = 0; + + /** + * My tab order inside a window or containing widget. + */ + private int tabOrder = 0; + + /** + * If true, this widget can be tabbed to or receive events. + */ + private boolean enabled = true; + + /** + * If true, this widget will be rendered. + */ + private boolean visible = true; + + /** + * If true, this widget has a cursor. + */ + private boolean cursorVisible = false; + + /** + * Cursor column position in relative coordinates. + */ + private int cursorX = 0; + + /** + * Cursor row position in relative coordinates. + */ + private int cursorY = 0; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Default constructor for subclasses. + */ + protected TWidget() { + children = new ArrayList(); + } + + /** + * Protected constructor. + * + * @param parent parent widget + */ + protected TWidget(final TWidget parent) { + this(parent, true); + } + + /** + * Protected constructor. + * + * @param parent parent widget + * @param x column relative to parent + * @param y row relative to parent + * @param width width of widget + * @param height height of widget + */ + protected TWidget(final TWidget parent, final int x, final int y, + final int width, final int height) { + + this(parent, true, x, y, width, height); + } + + /** + * Protected constructor used by subclasses that are disabled by default. + * + * @param parent parent widget + * @param enabled if true assume enabled + */ + protected TWidget(final TWidget parent, final boolean enabled) { + this.enabled = enabled; + this.parent = parent; + this.window = parent.window; + children = new ArrayList(); + + // Do not add TStatusBars, they are drawn by TApplication. + if (this instanceof TStatusBar) { + // NOP + } else { + parent.addChild(this); + } + } + + /** + * Protected constructor used by subclasses that are disabled by default. + * + * @param parent parent widget + * @param enabled if true assume enabled + * @param x column relative to parent + * @param y row relative to parent + * @param width width of widget + * @param height height of widget + */ + protected TWidget(final TWidget parent, final boolean enabled, + final int x, final int y, final int width, final int height) { + + this.enabled = enabled; + this.parent = parent; + this.window = parent.window; + children = new ArrayList(); + + // Do not add TStatusBars, they are drawn by TApplication. + if (this instanceof TStatusBar) { + // NOP + } else { + parent.addChild(this); + } + + this.x = x; + this.y = y; + this.width = width; + this.height = height; + } + + /** + * Backdoor access for TWindow's constructor. ONLY TWindow USES THIS. + * + * @param window the top-level window + * @param x column relative to parent + * @param y row relative to parent + * @param width width of window + * @param height height of window + */ + protected final void setupForTWindow(final TWindow window, + final int x, final int y, final int width, final int height) { + + this.parent = window; + this.window = window; + this.x = x; + this.y = y; + this.width = width; + this.height = height; + } + + // ------------------------------------------------------------------------ + // Event handlers --------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Subclasses should override this method to cleanup resources. This is + * called by TWindow.onClose(). + */ + protected void close() { + // Default: call close() on children. + for (TWidget w: getChildren()) { + w.close(); + } + } + + /** + * Check if a mouse press/release event coordinate is contained in this + * widget. + * + * @param mouse a mouse-based event + * @return whether or not a mouse click would be sent to this widget + */ + public final boolean mouseWouldHit(final TMouseEvent mouse) { + + if (!enabled) { + return false; + } + + if ((this instanceof TTreeItem) + && ((y < 0) || (y > parent.getHeight() - 1)) + ) { + return false; + } + + if ((mouse.getAbsoluteX() >= getAbsoluteX()) + && (mouse.getAbsoluteX() < getAbsoluteX() + width) + && (mouse.getAbsoluteY() >= getAbsoluteY()) + && (mouse.getAbsoluteY() < getAbsoluteY() + height) + ) { + return true; + } + return false; + } + + /** + * Method that subclasses can override to handle keystrokes. + * + * @param keypress keystroke event + */ + public void onKeypress(final TKeypressEvent keypress) { + + if ((children.size() == 0) + || (this instanceof TTreeView) + || (this instanceof TText) + || (this instanceof TComboBox) + ) { + + // Defaults: + // tab / shift-tab - switch to next/previous widget + // left-arrow or up-arrow: same as shift-tab + if ((keypress.equals(kbTab)) + || (keypress.equals(kbDown) && !(this instanceof TComboBox)) + ) { + parent.switchWidget(true); + return; + } else if ((keypress.equals(kbShiftTab)) + || (keypress.equals(kbBackTab)) + || (keypress.equals(kbUp) && !(this instanceof TComboBox)) + ) { + parent.switchWidget(false); + return; + } + } + + if ((children.size() == 0) + && !(this instanceof TTreeView) + ) { + + // Defaults: + // right-arrow or down-arrow: same as tab + if (keypress.equals(kbRight)) { + parent.switchWidget(true); + return; + } else if (keypress.equals(kbLeft)) { + parent.switchWidget(false); + return; + } + } + + // If I have any buttons on me AND this is an Alt-key that matches + // its mnemonic, send it an Enter keystroke. + for (TWidget widget: children) { + if (widget instanceof TButton) { + TButton button = (TButton) widget; + if (button.isEnabled() + && !keypress.getKey().isFnKey() + && keypress.getKey().isAlt() + && !keypress.getKey().isCtrl() + && (Character.toLowerCase(button.getMnemonic().getShortcut()) + == Character.toLowerCase(keypress.getKey().getChar())) + ) { + + widget.onKeypress(new TKeypressEvent(kbEnter)); + return; + } + } + } + + // If I have any labels on me AND this is an Alt-key that matches + // its mnemonic, call its action. + for (TWidget widget: children) { + if (widget instanceof TLabel) { + TLabel label = (TLabel) widget; + if (!keypress.getKey().isFnKey() + && keypress.getKey().isAlt() + && !keypress.getKey().isCtrl() + && (Character.toLowerCase(label.getMnemonic().getShortcut()) + == Character.toLowerCase(keypress.getKey().getChar())) + ) { + + label.dispatch(); + return; + } + } + } + + // If I have any radiobuttons on me AND this is an Alt-key that + // matches its mnemonic, select it and send a Space to it. + for (TWidget widget: children) { + if (widget instanceof TRadioButton) { + TRadioButton button = (TRadioButton) widget; + if (button.isEnabled() + && !keypress.getKey().isFnKey() + && keypress.getKey().isAlt() + && !keypress.getKey().isCtrl() + && (Character.toLowerCase(button.getMnemonic().getShortcut()) + == Character.toLowerCase(keypress.getKey().getChar())) + ) { + activate(widget); + widget.onKeypress(new TKeypressEvent(kbSpace)); + return; + } + } + if (widget instanceof TRadioGroup) { + for (TWidget child: widget.getChildren()) { + if (child instanceof TRadioButton) { + TRadioButton button = (TRadioButton) child; + if (button.isEnabled() + && !keypress.getKey().isFnKey() + && keypress.getKey().isAlt() + && !keypress.getKey().isCtrl() + && (Character.toLowerCase(button.getMnemonic().getShortcut()) + == Character.toLowerCase(keypress.getKey().getChar())) + ) { + activate(widget); + widget.activate(child); + child.onKeypress(new TKeypressEvent(kbSpace)); + return; + } + } + } + } + } + + // If I have any checkboxes on me AND this is an Alt-key that matches + // its mnemonic, select it and set it to checked. + for (TWidget widget: children) { + if (widget instanceof TCheckBox) { + TCheckBox checkBox = (TCheckBox) widget; + if (checkBox.isEnabled() + && !keypress.getKey().isFnKey() + && keypress.getKey().isAlt() + && !keypress.getKey().isCtrl() + && (Character.toLowerCase(checkBox.getMnemonic().getShortcut()) + == Character.toLowerCase(keypress.getKey().getChar())) + ) { + activate(checkBox); + checkBox.setChecked(true); + return; + } + } + } + + // Dispatch the keypress to an active widget + for (TWidget widget: children) { + if (widget.active) { + widget.onKeypress(keypress); + return; + } + } + } + + /** + * Method that subclasses can override to handle mouse button presses. + * + * @param mouse mouse button event + */ + public void onMouseDown(final TMouseEvent mouse) { + // Default: do nothing, pass to children instead + if (activeChild != null) { + if (activeChild.mouseWouldHit(mouse)) { + // Dispatch to the active child + + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - activeChild.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - activeChild.getAbsoluteY()); + activeChild.onMouseDown(mouse); + return; + } + } + for (int i = children.size() - 1 ; i >= 0 ; i--) { + TWidget widget = children.get(i); + if (widget.mouseWouldHit(mouse)) { + // Dispatch to this child, also activate it + activate(widget); + + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); + widget.onMouseDown(mouse); + return; + } + } + } + + /** + * Method that subclasses can override to handle mouse button releases. + * + * @param mouse mouse button event + */ + public void onMouseUp(final TMouseEvent mouse) { + // Default: do nothing, pass to children instead + if (activeChild != null) { + if (activeChild.mouseWouldHit(mouse)) { + // Dispatch to the active child + + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - activeChild.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - activeChild.getAbsoluteY()); + activeChild.onMouseUp(mouse); + return; + } + } + for (int i = children.size() - 1 ; i >= 0 ; i--) { + TWidget widget = children.get(i); + if (widget.mouseWouldHit(mouse)) { + // Dispatch to this child, also activate it + activate(widget); + + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); + widget.onMouseUp(mouse); + return; + } + } + } /** - * Every widget has a parent widget that it may be "contained" in. For - * example, a TWindow might contain several TTextFields, or a TComboBox - * may contain a TScrollBar. + * Method that subclasses can override to handle mouse movements. + * + * @param mouse mouse motion event */ - private TWidget parent = null; + public void onMouseMotion(final TMouseEvent mouse) { + // Default: do nothing, pass it on to ALL of my children. This way + // the children can see the mouse "leaving" their area. + for (TWidget widget: children) { + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); + widget.onMouseMotion(mouse); + } + } /** - * Get parent widget. + * Method that subclasses can override to handle mouse button + * double-clicks. * - * @return parent widget + * @param mouse mouse button event */ - public final TWidget getParent() { - return parent; + public void onMouseDoubleClick(final TMouseEvent mouse) { + // Default: do nothing, pass to children instead + if (activeChild != null) { + if (activeChild.mouseWouldHit(mouse)) { + // Dispatch to the active child + + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - activeChild.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - activeChild.getAbsoluteY()); + activeChild.onMouseDoubleClick(mouse); + return; + } + } + for (int i = children.size() - 1 ; i >= 0 ; i--) { + TWidget widget = children.get(i); + if (widget.mouseWouldHit(mouse)) { + // Dispatch to this child, also activate it + activate(widget); + + // Set x and y relative to the child's coordinates + mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); + mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); + widget.onMouseDoubleClick(mouse); + return; + } + } } /** - * Backdoor access for TWindow's constructor. ONLY TWindow USES THIS. + * Method that subclasses can override to handle window/screen resize + * events. * - * @param window the top-level window - * @param x column relative to parent - * @param y row relative to parent - * @param width width of window - * @param height height of window + * @param resize resize event */ - protected final void setupForTWindow(final TWindow window, - final int x, final int y, final int width, final int height) { - - this.parent = window; - this.window = window; - this.x = x; - this.y = y; - this.width = width; - this.height = height; + public void onResize(final TResizeEvent resize) { + // Default: change my width/height. + if (resize.getType() == TResizeEvent.Type.WIDGET) { + width = resize.getWidth(); + height = resize.getHeight(); + } else { + // Let children see the screen resize + for (TWidget widget: children) { + widget.onResize(resize); + } + } } /** - * Get this TWidget's parent TApplication. + * Method that subclasses can override to handle posted command events. * - * @return the parent TApplication + * @param command command event */ - public TApplication getApplication() { - return window.getApplication(); + public void onCommand(final TCommandEvent command) { + // Default: do nothing, pass to children instead + for (TWidget widget: children) { + widget.onCommand(command); + } } /** - * Get the Screen. + * Method that subclasses can override to handle menu or posted menu + * events. * - * @return the Screen + * @param menu menu event */ - public Screen getScreen() { - return window.getScreen(); + public void onMenu(final TMenuEvent menu) { + // Default: do nothing, pass to children instead + for (TWidget widget: children) { + widget.onMenu(menu); + } } /** - * Child widgets that this widget contains. + * Method that subclasses can override to do processing when the UI is + * idle. Note that repainting is NOT assumed. To get a refresh after + * onIdle, call doRepaint(). */ - private List children; + public void onIdle() { + // Default: do nothing, pass to children instead + for (TWidget widget: children) { + widget.onIdle(); + } + } /** - * Get the list of child widgets that this widget contains. + * Consume event. Subclasses that want to intercept all events in one go + * can override this method. * - * @return the list of child widgets + * @param event keyboard, mouse, resize, command, or menu event */ - public List getChildren() { - return children; + public void handleEvent(final TInputEvent event) { + /* + System.err.printf("TWidget (%s) event: %s\n", this.getClass().getName(), + event); + */ + + if (!enabled) { + // Discard event + // System.err.println(" -- discard --"); + return; + } + + if (event instanceof TKeypressEvent) { + onKeypress((TKeypressEvent) event); + } else if (event instanceof TMouseEvent) { + + TMouseEvent mouse = (TMouseEvent) event; + + switch (mouse.getType()) { + + case MOUSE_DOWN: + onMouseDown(mouse); + break; + + case MOUSE_UP: + onMouseUp(mouse); + break; + + case MOUSE_MOTION: + onMouseMotion(mouse); + break; + + case MOUSE_DOUBLE_CLICK: + onMouseDoubleClick(mouse); + break; + + default: + throw new IllegalArgumentException("Invalid mouse event type: " + + mouse.getType()); + } + } else if (event instanceof TResizeEvent) { + onResize((TResizeEvent) event); + } else if (event instanceof TCommandEvent) { + onCommand((TCommandEvent) event); + } else if (event instanceof TMenuEvent) { + onMenu((TMenuEvent) event); + } + + // Do nothing else + return; } + // ------------------------------------------------------------------------ + // TWidget ---------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** - * The currently active child widget that will receive keypress events. + * Get parent widget. + * + * @return parent widget */ - private TWidget activeChild = null; + public final TWidget getParent() { + return parent; + } /** - * If true, this widget will receive events. + * Get the list of child widgets that this widget contains. + * + * @return the list of child widgets */ - private boolean active = false; + public List getChildren() { + return children; + } /** * Get active flag. @@ -146,11 +703,6 @@ public abstract class TWidget implements Comparable { this.active = active; } - /** - * The window that this widget draws to. - */ - private TWindow window = null; - /** * Get the window this widget is on. * @@ -160,11 +712,6 @@ public abstract class TWidget implements Comparable { return window; } - /** - * Absolute X position of the top-left corner. - */ - private int x = 0; - /** * Get X position. * @@ -183,11 +730,6 @@ public abstract class TWidget implements Comparable { this.x = x; } - /** - * Absolute Y position of the top-left corner. - */ - private int y = 0; - /** * Get Y position. * @@ -206,11 +748,6 @@ public abstract class TWidget implements Comparable { this.y = y; } - /** - * Width. - */ - private int width = 0; - /** * Get the width. * @@ -229,11 +766,6 @@ public abstract class TWidget implements Comparable { this.width = width; } - /** - * Height. - */ - private int height = 0; - /** * Get the height. * @@ -253,14 +785,21 @@ public abstract class TWidget implements Comparable { } /** - * My tab order inside a window or containing widget. + * Change the dimensions. + * + * @param x absolute X position of the top-left corner + * @param y absolute Y position of the top-left corner + * @param width new widget width + * @param height new widget height */ - private int tabOrder = 0; + public final void setDimensions(final int x, final int y, final int width, + final int height) { - /** - * If true, this widget can be tabbed to or receive events. - */ - private boolean enabled = true; + setX(x); + setY(y); + setWidth(width); + setHeight(height); + } /** * Get enabled flag. @@ -301,9 +840,22 @@ public abstract class TWidget implements Comparable { } /** - * If true, this widget has a cursor. + * Set visible flag. + * + * @param visible if true, this widget will be drawn */ - private boolean cursorVisible = false; + public final void setVisible(final boolean visible) { + this.visible = visible; + } + + /** + * See if this widget is visible. + * + * @return if true, this widget will be drawn + */ + public final boolean isVisible() { + return visible; + } /** * Set visible cursor flag. @@ -320,14 +872,28 @@ public abstract class TWidget implements Comparable { * @return if true, this widget has a visible cursor */ public final boolean isCursorVisible() { + // If cursor is out of my bounds, it is not visible. + if ((cursorX >= width) + || (cursorX < 0) + || (cursorY >= height) + || (cursorY < 0) + ) { + return false; + } + + // If cursor is out of my window's bounds, it is not visible. + if ((getCursorAbsoluteX() >= window.getAbsoluteX() + + window.getWidth() - 1) + || (getCursorAbsoluteX() < 0) + || (getCursorAbsoluteY() >= window.getAbsoluteY() + + window.getHeight() - 1) + || (getCursorAbsoluteY() < 0) + ) { + return false; + } return cursorVisible; } - /** - * Cursor column position in relative coordinates. - */ - private int cursorX = 0; - /** * Get cursor X value. * @@ -347,42 +913,65 @@ public abstract class TWidget implements Comparable { } /** - * Cursor row position in relative coordinates. + * Get cursor Y value. + * + * @return cursor row position in relative coordinates */ - private int cursorY = 0; + public final int getCursorY() { + return cursorY; + } /** - * Get cursor Y value. + * Set cursor Y value. * - * @return cursor row position in relative coordinates + * @param cursorY row position in relative coordinates + */ + public final void setCursorY(final int cursorY) { + this.cursorY = cursorY; + } + + /** + * Get this TWidget's parent TApplication. + * + * @return the parent TApplication */ - public final int getCursorY() { - return cursorY; + public TApplication getApplication() { + return window.getApplication(); } /** - * Set cursor Y value. + * Get the Screen. * - * @param cursorY row position in relative coordinates + * @return the Screen */ - public final void setCursorY(final int cursorY) { - this.cursorY = cursorY; + public Screen getScreen() { + return window.getScreen(); } /** - * Comparison operator sorts on tabOrder for TWidgets and z for TWindows. + * Comparison operator. For various subclasses it sorts on: + *
    + *
  • tabOrder for TWidgets
    • + *
  • z for TWindows
    • + *
  • text for TTreeItems
    • + *
* - * @param that another TWidget or TWindow instance + * @param that another TWidget, TWindow, or TTreeItem instance * @return difference between this.tabOrder and that.tabOrder, or - * difference between this.z and that.z + * difference between this.z and that.z, or String.compareTo(text) */ - @Override public final int compareTo(final TWidget that) { if ((this instanceof TWindow) && (that instanceof TWindow) ) { return (((TWindow) this).getZ() - ((TWindow) that).getZ()); } + if ((this instanceof TTreeItem) + && (that instanceof TTreeItem) + ) { + return (((TTreeItem) this).getText().compareTo( + ((TTreeItem) that).getText())); + } return (this.tabOrder - that.tabOrder); } @@ -405,7 +994,6 @@ public abstract class TWidget implements Comparable { * @return absolute screen column number for the cursor's X position */ public final int getCursorAbsoluteX() { - assert (cursorVisible); return getAbsoluteX() + cursorX; } @@ -415,7 +1003,6 @@ public abstract class TWidget implements Comparable { * @return absolute screen row number for the cursor's Y position */ public final int getCursorAbsoluteY() { - assert (cursorVisible); return getAbsoluteY() + cursorY; } @@ -430,7 +1017,10 @@ public abstract class TWidget implements Comparable { if (parent == this) { return x; } - if ((parent instanceof TWindow) && !(parent instanceof TMenu)) { + if ((parent instanceof TWindow) + && !(parent instanceof TMenu) + && !(parent instanceof TDesktop) + ) { // Widgets on a TWindow have (0,0) as their top-left, but this is // actually the TWindow's (1,1). return parent.getAbsoluteX() + x + 1; @@ -449,7 +1039,10 @@ public abstract class TWidget implements Comparable { if (parent == this) { return y; } - if ((parent instanceof TWindow) && !(parent instanceof TMenu)) { + if ((parent instanceof TWindow) + && !(parent instanceof TMenu) + && !(parent instanceof TDesktop) + ) { // Widgets on a TWindow have (0,0) as their top-left, but this is // actually the TWindow's (1,1). return parent.getAbsoluteY() + y + 1; @@ -462,7 +1055,7 @@ public abstract class TWidget implements Comparable { * * @return the ColorTheme */ - public final ColorTheme getTheme() { + protected final ColorTheme getTheme() { return window.getApplication().getTheme(); } @@ -475,14 +1068,20 @@ public abstract class TWidget implements Comparable { } /** - * Called by parent to render to TWindow. + * Called by parent to render to TWindow. Note package private access. */ - public final void drawChildren() { + final void drawChildren() { // Set my clipping rectangle assert (window != null); assert (getScreen() != null); Screen screen = getScreen(); + // Special case: TStatusBar is drawn by TApplication, not anything + // else. + if (this instanceof TStatusBar) { + return; + } + screen.setClipRight(width); screen.setClipBottom(height); @@ -518,80 +1117,23 @@ public abstract class TWidget implements Comparable { // Draw me draw(); - // Continue down the chain + // Continue down the chain. Draw the active child last so that it + // is on top. for (TWidget widget: children) { - widget.drawChildren(); + if (widget.isVisible() && (widget != activeChild)) { + widget.drawChildren(); + } + } + if (activeChild != null) { + activeChild.drawChildren(); } } /** - * Default constructor for subclasses. - */ - protected TWidget() { - children = new LinkedList(); - } - - /** - * Protected constructor. - * - * @param parent parent widget - */ - protected TWidget(final TWidget parent) { - this(parent, true); - } - - /** - * Protected constructor. - * - * @param parent parent widget - * @param x column relative to parent - * @param y row relative to parent - * @param width width of widget - * @param height height of widget - */ - protected TWidget(final TWidget parent, final int x, final int y, - final int width, final int height) { - - this(parent, true, x, y, width, height); - } - - /** - * Protected constructor used by subclasses that are disabled by default. - * - * @param parent parent widget - * @param enabled if true assume enabled - */ - protected TWidget(final TWidget parent, final boolean enabled) { - this.enabled = enabled; - this.parent = parent; - this.window = parent.window; - children = new LinkedList(); - parent.addChild(this); - } - - /** - * Protected constructor used by subclasses that are disabled by default. - * - * @param parent parent widget - * @param enabled if true assume enabled - * @param x column relative to parent - * @param y row relative to parent - * @param width width of widget - * @param height height of widget + * Repaint the screen on the next update. */ - protected TWidget(final TWidget parent, final boolean enabled, - final int x, final int y, final int width, final int height) { - - this.enabled = enabled; - this.parent = parent; - this.window = parent.window; - children = new LinkedList(); - parent.addChild(this); - - this.x = x; - this.y = y; - this.width = width; - this.height = height; + protected final void doRepaint() { + window.getApplication().doRepaint(); } /** @@ -618,6 +1160,16 @@ public abstract class TWidget implements Comparable { } } + /** + * Reset the tab order of children to match their position in the list. + * Available so that subclasses can re-order their widgets if needed. + */ + protected void resetTabOrder() { + for (int i = 0; i < children.size(); i++) { + children.get(i).tabOrder = i; + } + } + /** * Switch the active child. * @@ -631,12 +1183,19 @@ public abstract class TWidget implements Comparable { return; } - if (child != activeChild) { - if (activeChild != null) { - activeChild.active = false; + if (children.size() == 1) { + if (children.get(0).enabled == true) { + child.active = true; + activeChild = child; + } + } else { + if (child != activeChild) { + if (activeChild != null) { + activeChild.active = false; + } + child.active = true; + activeChild = child; } - child.active = true; - activeChild = child; } } @@ -647,9 +1206,14 @@ public abstract class TWidget implements Comparable { * isn't enabled, then the next enabled child will be activated. */ public final void activate(final int tabOrder) { - if (activeChild == null) { + if (children.size() == 1) { + if (children.get(0).enabled == true) { + children.get(0).active = true; + activeChild = children.get(0); + } return; } + TWidget child = null; for (TWidget widget: children) { if ((widget.enabled) @@ -662,7 +1226,9 @@ public abstract class TWidget implements Comparable { } } if ((child != null) && (child != activeChild)) { - activeChild.active = false; + if (activeChild != null) { + activeChild.active = false; + } assert (child.enabled); child.active = true; activeChild = child; @@ -677,12 +1243,29 @@ public abstract class TWidget implements Comparable { */ public final void switchWidget(final boolean forward) { - // Only switch if there are multiple enabled widgets - if ((children.size() < 2) || (activeChild == null)) { + // No children: do nothing. + if (children.size() == 0) { + return; + } + + // If there is only one child, make it active if it is enabled. + if (children.size() == 1) { + if (children.get(0).enabled == true) { + activeChild = children.get(0); + activeChild.active = true; + } else { + children.get(0).active = false; + activeChild = null; + } return; } - int tabOrder = activeChild.tabOrder; + // Two or more children: go forward or backward to the next enabled + // child. + int tabOrder = 0; + if (activeChild != null) { + tabOrder = activeChild.tabOrder; + } do { if (forward) { tabOrder++; @@ -707,7 +1290,12 @@ public abstract class TWidget implements Comparable { tabOrder = 0; } - if (activeChild.tabOrder == tabOrder) { + if (activeChild == null) { + if (tabOrder == 0) { + // We wrapped around + break; + } + } else if (activeChild.tabOrder == tabOrder) { // We wrapped around break; } @@ -715,11 +1303,15 @@ public abstract class TWidget implements Comparable { && !(children.get(tabOrder) instanceof THScroller) && !(children.get(tabOrder) instanceof TVScroller)); - assert (children.get(tabOrder).enabled); + if (activeChild != null) { + assert (children.get(tabOrder).enabled); - activeChild.active = false; - children.get(tabOrder).active = true; - activeChild = children.get(tabOrder); + activeChild.active = false; + } + if (children.get(tabOrder).enabled == true) { + children.get(tabOrder).active = true; + activeChild = children.get(tabOrder); + } } /** @@ -743,249 +1335,208 @@ public abstract class TWidget implements Comparable { return this; } + // ------------------------------------------------------------------------ + // Passthru for Screen functions ------------------------------------------ + // ------------------------------------------------------------------------ + /** - * Method that subclasses can override to handle keystrokes. + * Get the attributes at one location. * - * @param keypress keystroke event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @return attributes at (x, y) */ - public void onKeypress(final TKeypressEvent keypress) { - - if ((children.size() == 0) - // TODO - // || (cast(TTreeView)this) - || (this instanceof TText) - ) { - - // Defaults: - // tab / shift-tab - switch to next/previous widget - // right-arrow or down-arrow: same as tab - // left-arrow or up-arrow: same as shift-tab - if ((keypress.equals(kbTab)) - || (keypress.equals(kbRight)) - || (keypress.equals(kbDown)) - ) { - parent.switchWidget(true); - return; - } else if ((keypress.equals(kbShiftTab)) - || (keypress.equals(kbBackTab)) - || (keypress.equals(kbLeft)) - || (keypress.equals(kbUp)) - ) { - parent.switchWidget(false); - return; - } - } - - // If I have any buttons on me AND this is an Alt-key that matches - // its mnemonic, send it an Enter keystroke - for (TWidget widget: children) { - if (widget instanceof TButton) { - TButton button = (TButton) widget; - if (button.isEnabled() - && !keypress.getKey().isFnKey() - && keypress.getKey().isAlt() - && !keypress.getKey().isCtrl() - && (Character.toLowerCase(button.getMnemonic().getShortcut()) - == Character.toLowerCase(keypress.getKey().getChar())) - ) { - - widget.handleEvent(new TKeypressEvent(kbEnter)); - return; - } - } - } - - // Dispatch the keypress to an active widget - for (TWidget widget: children) { - if (widget.active) { - widget.handleEvent(keypress); - return; - } - } + protected final CellAttributes getAttrXY(final int x, final int y) { + return getScreen().getAttrXY(x, y); } /** - * Method that subclasses can override to handle mouse button presses. + * Set the attributes at one location. * - * @param mouse mouse button event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param attr attributes to use (bold, foreColor, backColor) */ - public void onMouseDown(final TMouseEvent mouse) { - // Default: do nothing, pass to children instead - for (TWidget widget: children) { - if (widget.mouseWouldHit(mouse)) { - // Dispatch to this child, also activate it - activate(widget); + protected final void putAttrXY(final int x, final int y, + final CellAttributes attr) { - // Set x and y relative to the child's coordinates - mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); - mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); - widget.handleEvent(mouse); - return; - } - } + getScreen().putAttrXY(x, y, attr); } /** - * Method that subclasses can override to handle mouse button releases. + * Set the attributes at one location. * - * @param mouse mouse button event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param attr attributes to use (bold, foreColor, backColor) + * @param clip if true, honor clipping/offset */ - public void onMouseUp(final TMouseEvent mouse) { - // Default: do nothing, pass to children instead - for (TWidget widget: children) { - if (widget.mouseWouldHit(mouse)) { - // Dispatch to this child, also activate it - activate(widget); + protected final void putAttrXY(final int x, final int y, + final CellAttributes attr, final boolean clip) { - // Set x and y relative to the child's coordinates - mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); - mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); - widget.handleEvent(mouse); - return; - } - } + getScreen().putAttrXY(x, y, attr, clip); } /** - * Method that subclasses can override to handle mouse movements. + * Fill the entire screen with one character with attributes. * - * @param mouse mouse motion event + * @param ch character to draw + * @param attr attributes to use (bold, foreColor, backColor) */ - public void onMouseMotion(final TMouseEvent mouse) { - // Default: do nothing, pass it on to ALL of my children. This way - // the children can see the mouse "leaving" their area. - for (TWidget widget: children) { - // Set x and y relative to the child's coordinates - mouse.setX(mouse.getAbsoluteX() - widget.getAbsoluteX()); - mouse.setY(mouse.getAbsoluteY() - widget.getAbsoluteY()); - widget.handleEvent(mouse); - } + protected final void putAll(final char ch, final CellAttributes attr) { + getScreen().putAll(ch, attr); } /** - * Method that subclasses can override to handle window/screen resize - * events. + * Render one character with attributes. * - * @param resize resize event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param ch character + attributes to draw */ - public void onResize(final TResizeEvent resize) { - // Default: do nothing, pass to children instead - for (TWidget widget: children) { - widget.onResize(resize); - } + protected final void putCharXY(final int x, final int y, final Cell ch) { + getScreen().putCharXY(x, y, ch); } /** - * Method that subclasses can override to handle posted command events. + * Render one character with attributes. * - * @param command command event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param ch character to draw + * @param attr attributes to use (bold, foreColor, backColor) */ - public void onCommand(final TCommandEvent command) { - // Default: do nothing, pass to children instead - for (TWidget widget: children) { - widget.onCommand(command); - } + protected final void putCharXY(final int x, final int y, final char ch, + final CellAttributes attr) { + + getScreen().putCharXY(x, y, ch, attr); } /** - * Method that subclasses can override to handle menu or posted menu - * events. + * Render one character without changing the underlying attributes. * - * @param menu menu event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param ch character to draw */ - public void onMenu(final TMenuEvent menu) { - // Default: do nothing, pass to children instead - for (TWidget widget: children) { - widget.onMenu(menu); - } + protected final void putCharXY(final int x, final int y, final char ch) { + getScreen().putCharXY(x, y, ch); } /** - * Method that subclasses can override to do processing when the UI is - * idle. + * Render a string. Does not wrap if the string exceeds the line. + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param str string to draw + * @param attr attributes to use (bold, foreColor, backColor) */ - public void onIdle() { - // Default: do nothing, pass to children instead - for (TWidget widget: children) { - widget.onIdle(); - } + protected final void putStringXY(final int x, final int y, final String str, + final CellAttributes attr) { + + getScreen().putStringXY(x, y, str, attr); } /** - * Consume event. Subclasses that want to intercept all events in one go - * can override this method. + * Render a string without changing the underlying attribute. Does not + * wrap if the string exceeds the line. * - * @param event keyboard, mouse, resize, command, or menu event + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param str string to draw */ - public void handleEvent(final TInputEvent event) { - // System.err.printf("TWidget (%s) event: %s\n", this.getClass().getName(), - // event); - - if (!enabled) { - // Discard event - // System.err.println(" -- discard --"); - return; - } - - if (event instanceof TKeypressEvent) { - onKeypress((TKeypressEvent) event); - } else if (event instanceof TMouseEvent) { - - TMouseEvent mouse = (TMouseEvent) event; + protected final void putStringXY(final int x, final int y, final String str) { + getScreen().putStringXY(x, y, str); + } - switch (mouse.getType()) { + /** + * Draw a vertical line from (x, y) to (x, y + n). + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param n number of characters to draw + * @param ch character to draw + * @param attr attributes to use (bold, foreColor, backColor) + */ + protected final void vLineXY(final int x, final int y, final int n, + final char ch, final CellAttributes attr) { - case MOUSE_DOWN: - onMouseDown(mouse); - break; + getScreen().vLineXY(x, y, n, ch, attr); + } - case MOUSE_UP: - onMouseUp(mouse); - break; + /** + * Draw a horizontal line from (x, y) to (x + n, y). + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param n number of characters to draw + * @param ch character to draw + * @param attr attributes to use (bold, foreColor, backColor) + */ + protected final void hLineXY(final int x, final int y, final int n, + final char ch, final CellAttributes attr) { - case MOUSE_MOTION: - onMouseMotion(mouse); - break; + getScreen().hLineXY(x, y, n, ch, attr); + } - default: - throw new IllegalArgumentException("Invalid mouse event type: " - + mouse.getType()); - } - } else if (event instanceof TResizeEvent) { - onResize((TResizeEvent) event); - } else if (event instanceof TCommandEvent) { - onCommand((TCommandEvent) event); - } else if (event instanceof TMenuEvent) { - onMenu((TMenuEvent) event); - } + /** + * Draw a box with a border and empty background. + * + * @param left left column of box. 0 is the left-most row. + * @param top top row of the box. 0 is the top-most row. + * @param right right column of box + * @param bottom bottom row of the box + * @param border attributes to use for the border + * @param background attributes to use for the background + */ + protected final void drawBox(final int left, final int top, + final int right, final int bottom, + final CellAttributes border, final CellAttributes background) { - // Do nothing else - return; + getScreen().drawBox(left, top, right, bottom, border, background); } /** - * Check if a mouse press/release event coordinate is contained in this - * widget. + * Draw a box with a border and empty background. * - * @param mouse a mouse-based event - * @return whether or not a mouse click would be sent to this widget + * @param left left column of box. 0 is the left-most row. + * @param top top row of the box. 0 is the top-most row. + * @param right right column of box + * @param bottom bottom row of the box + * @param border attributes to use for the border + * @param background attributes to use for the background + * @param borderType if 1, draw a single-line border; if 2, draw a + * double-line border; if 3, draw double-line top/bottom edges and + * single-line left/right edges (like Qmodem) + * @param shadow if true, draw a "shadow" on the box */ - public final boolean mouseWouldHit(final TMouseEvent mouse) { + protected final void drawBox(final int left, final int top, + final int right, final int bottom, + final CellAttributes border, final CellAttributes background, + final int borderType, final boolean shadow) { - if (!enabled) { - return false; - } + getScreen().drawBox(left, top, right, bottom, border, background, + borderType, shadow); + } - if ((mouse.getAbsoluteX() >= getAbsoluteX()) - && (mouse.getAbsoluteX() < getAbsoluteX() + width) - && (mouse.getAbsoluteY() >= getAbsoluteY()) - && (mouse.getAbsoluteY() < getAbsoluteY() + height) - ) { - return true; - } - return false; + /** + * Draw a box shadow. + * + * @param left left column of box. 0 is the left-most row. + * @param top top row of the box. 0 is the top-most row. + * @param right right column of box + * @param bottom bottom row of the box + */ + protected final void drawBoxShadow(final int left, final int top, + final int right, final int bottom) { + + getScreen().drawBoxShadow(left, top, right, bottom); } + // ------------------------------------------------------------------------ + // Other TWidget constructors --------------------------------------------- + // ------------------------------------------------------------------------ + /** * Convenience function to add a label to this container/window. * @@ -998,6 +1549,21 @@ public abstract class TWidget implements Comparable { return addLabel(text, x, y, "tlabel"); } + /** + * Convenience function to add a label to this container/window. + * + * @param text label + * @param x column relative to parent + * @param y row relative to parent + * @param action to call when shortcut is pressed + * @return the new label + */ + public final TLabel addLabel(final String text, final int x, final int y, + final TAction action) { + + return addLabel(text, x, y, "tlabel", action); + } + /** * Convenience function to add a label to this container/window. * @@ -1014,13 +1580,67 @@ public abstract class TWidget implements Comparable { return new TLabel(this, text, x, y, colorKey); } + /** + * Convenience function to add a label to this container/window. + * + * @param text label + * @param x column relative to parent + * @param y row relative to parent + * @param colorKey ColorTheme key color to use for foreground text. + * Default is "tlabel" + * @param action to call when shortcut is pressed + * @return the new label + */ + public final TLabel addLabel(final String text, final int x, final int y, + final String colorKey, final TAction action) { + + return new TLabel(this, text, x, y, colorKey, action); + } + + /** + * Convenience function to add a label to this container/window. + * + * @param text label + * @param x column relative to parent + * @param y row relative to parent + * @param colorKey ColorTheme key color to use for foreground text. + * Default is "tlabel" + * @param useWindowBackground if true, use the window's background color + * @return the new label + */ + public final TLabel addLabel(final String text, final int x, final int y, + final String colorKey, final boolean useWindowBackground) { + + return new TLabel(this, text, x, y, colorKey, useWindowBackground); + } + + /** + * Convenience function to add a label to this container/window. + * + * @param text label + * @param x column relative to parent + * @param y row relative to parent + * @param colorKey ColorTheme key color to use for foreground text. + * Default is "tlabel" + * @param useWindowBackground if true, use the window's background color + * @param action to call when shortcut is pressed + * @return the new label + */ + public final TLabel addLabel(final String text, final int x, final int y, + final String colorKey, final boolean useWindowBackground, + final TAction action) { + + return new TLabel(this, text, x, y, colorKey, useWindowBackground, + action); + } + /** * Convenience function to add a button to this container/window. * * @param text label on the button * @param x column relative to parent * @param y row relative to parent - * @param action to call when button is pressed + * @param action action to call when button is pressed * @return the new button */ public final TButton addButton(final String text, final int x, final int y, @@ -1038,10 +1658,64 @@ public abstract class TWidget implements Comparable { * @param checked initial check state * @return the new checkbox */ - public final TCheckbox addCheckbox(final int x, final int y, + public final TCheckBox addCheckBox(final int x, final int y, final String label, final boolean checked) { - return new TCheckbox(this, x, y, label, checked); + return new TCheckBox(this, x, y, label, checked); + } + + /** + * Convenience function to add a combobox to this container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width visible combobox width, including the down-arrow + * @param values the possible values for the box, shown in the drop-down + * @param valuesIndex the initial index in values, or -1 for no default + * value + * @param valuesHeight the height of the values drop-down when it is + * visible + * @param updateAction action to call when a new value is selected from + * the list or enter is pressed in the edit field + * @return the new combobox + */ + public final TComboBox addComboBox(final int x, final int y, + final int width, final List values, final int valuesIndex, + final int valuesHeight, final TAction updateAction) { + + return new TComboBox(this, x, y, width, values, valuesIndex, + valuesHeight, updateAction); + } + + /** + * Convenience function to add a spinner to this container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param upAction action to call when the up arrow is clicked or pressed + * @param downAction action to call when the down arrow is clicked or + * pressed + * @return the new spinner + */ + public final TSpinner addSpinner(final int x, final int y, + final TAction upAction, final TAction downAction) { + + return new TSpinner(this, x, y, upAction, downAction); + } + + /** + * Convenience function to add a calendar to this container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param updateAction action to call when the user changes the value of + * the calendar + * @return the new calendar + */ + public final TCalendar addCalendar(final int x, final int y, + final TAction updateAction) { + + return new TCalendar(this, x, y, updateAction); } /** @@ -1160,6 +1834,23 @@ public abstract class TWidget implements Comparable { return new TText(this, text, x, y, width, height, "ttext"); } + /** + * Convenience function to add an editable text area box to this + * container/window. + * + * @param text text on the screen + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @return the new text box + */ + public final TEditorWidget addEditor(final String text, final int x, + final int y, final int width, final int height) { + + return new TEditorWidget(this, text, x, y, width, height); + } + /** * Convenience function to spawn a message box. * @@ -1272,4 +1963,241 @@ public abstract class TWidget implements Comparable { updateAction); } + /** + * Convenience function to add a scrollable tree view to this + * container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width width of tree view + * @param height height of tree view + * @return the new tree view + */ + public final TTreeViewWidget addTreeViewWidget(final int x, final int y, + final int width, final int height) { + + return new TTreeViewWidget(this, x, y, width, height); + } + + /** + * Convenience function to add a scrollable tree view to this + * container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width width of tree view + * @param height height of tree view + * @param action action to perform when an item is selected + * @return the new tree view + */ + public final TTreeViewWidget addTreeViewWidget(final int x, final int y, + final int width, final int height, final TAction action) { + + return new TTreeViewWidget(this, x, y, width, height, action); + } + + /** + * Convenience function to spawn a file open box. + * + * @param path path of selected file + * @return the result of the new file open box + * @throws IOException if a java.io operation throws + */ + public final String fileOpenBox(final String path) throws IOException { + return getApplication().fileOpenBox(path); + } + + /** + * Convenience function to spawn a file save box. + * + * @param path path of selected file + * @return the result of the new file open box + * @throws IOException if a java.io operation throws + */ + public final String fileSaveBox(final String path) throws IOException { + return getApplication().fileOpenBox(path, TFileOpenBox.Type.SAVE); + } + + /** + * Convenience function to spawn a file open box. + * + * @param path path of selected file + * @param type one of the Type constants + * @return the result of the new file open box + * @throws IOException if a java.io operation throws + */ + public final String fileOpenBox(final String path, + final TFileOpenBox.Type type) throws IOException { + + return getApplication().fileOpenBox(path, type); + } + + /** + * Convenience function to spawn a file open box. + * + * @param path path of selected file + * @param type one of the Type constants + * @param filter a string that files must match to be displayed + * @return the result of the new file open box + * @throws IOException of a java.io operation throws + */ + public final String fileOpenBox(final String path, + final TFileOpenBox.Type type, final String filter) throws IOException { + + ArrayList filters = new ArrayList(); + filters.add(filter); + + return getApplication().fileOpenBox(path, type, filters); + } + + /** + * Convenience function to spawn a file open box. + * + * @param path path of selected file + * @param type one of the Type constants + * @param filters a list of strings that files must match to be displayed + * @return the result of the new file open box + * @throws IOException of a java.io operation throws + */ + public final String fileOpenBox(final String path, + final TFileOpenBox.Type type, + final List filters) throws IOException { + + return getApplication().fileOpenBox(path, type, filters); + } + + /** + * Convenience function to add a directory list to this container/window. + * + * @param path directory path, must be a directory + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @return the new directory list + */ + public final TDirectoryList addDirectoryList(final String path, final int x, + final int y, final int width, final int height) { + + return new TDirectoryList(this, path, x, y, width, height, null); + } + + /** + * Convenience function to add a directory list to this container/window. + * + * @param path directory path, must be a directory + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @param action action to perform when an item is selected (enter or + * double-click) + * @return the new directory list + */ + public final TDirectoryList addDirectoryList(final String path, final int x, + final int y, final int width, final int height, final TAction action) { + + return new TDirectoryList(this, path, x, y, width, height, action); + } + + /** + * Convenience function to add a directory list to this container/window. + * + * @param path directory path, must be a directory + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @param action action to perform when an item is selected (enter or + * double-click) + * @param singleClickAction action to perform when an item is selected + * (single-click) + * @return the new directory list + */ + public final TDirectoryList addDirectoryList(final String path, final int x, + final int y, final int width, final int height, final TAction action, + final TAction singleClickAction) { + + return new TDirectoryList(this, path, x, y, width, height, action, + singleClickAction); + } + + /** + * Convenience function to add a directory list to this container/window. + * + * @param path directory path, must be a directory + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @param action action to perform when an item is selected (enter or + * double-click) + * @param singleClickAction action to perform when an item is selected + * (single-click) + * @param filters a list of strings that files must match to be displayed + * @return the new directory list + */ + public final TDirectoryList addDirectoryList(final String path, final int x, + final int y, final int width, final int height, final TAction action, + final TAction singleClickAction, final List filters) { + + return new TDirectoryList(this, path, x, y, width, height, action, + singleClickAction, filters); + } + + /** + * Convenience function to add a list to this container/window. + * + * @param strings list of strings to show + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @return the new directory list + */ + public final TList addList(final List strings, final int x, + final int y, final int width, final int height) { + + return new TList(this, strings, x, y, width, height, null); + } + + /** + * Convenience function to add a list to this container/window. + * + * @param strings list of strings to show + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @param enterAction action to perform when an item is selected + * @return the new directory list + */ + public final TList addList(final List strings, final int x, + final int y, final int width, final int height, + final TAction enterAction) { + + return new TList(this, strings, x, y, width, height, enterAction); + } + + /** + * Convenience function to add a list to this container/window. + * + * @param strings list of strings to show + * @param x column relative to parent + * @param y row relative to parent + * @param width width of text area + * @param height height of text area + * @param enterAction action to perform when an item is selected + * @param moveAction action to perform when the user navigates to a new + * item with arrow/page keys + * @return the new directory list + */ + public final TList addList(final List strings, final int x, + final int y, final int width, final int height, + final TAction enterAction, final TAction moveAction) { + + return new TList(this, strings, x, y, width, height, enterAction, + moveAction); + } + }