X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTWidget.java;h=b17b73f67b1c49f92c831591a62e5ef8452bd05d;hb=8ab60a33f89f656b71751a45967c79179415f652;hp=6d5d147b3174ea39ab80da901dbc362a47c442b3;hpb=051e29138b18fb4b731a72f8727475b10e4c74e4;p=fanfix.git diff --git a/src/jexer/TWidget.java b/src/jexer/TWidget.java index 6d5d147..b17b73f 100644 --- a/src/jexer/TWidget.java +++ b/src/jexer/TWidget.java @@ -3,7 +3,7 @@ * * The MIT License (MIT) * - * Copyright (C) 2017 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), @@ -28,11 +28,14 @@ */ package jexer; +import java.awt.image.BufferedImage; import java.io.IOException; import java.util.List; 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; @@ -177,12 +180,10 @@ public abstract class TWidget implements Comparable { 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) { - } else { + if (parent != null) { + this.window = parent.window; parent.addChild(this); } } @@ -200,14 +201,19 @@ public abstract class TWidget implements Comparable { protected TWidget(final TWidget parent, final boolean enabled, final int x, final int y, final int width, final int height) { + if (width < 0) { + throw new IllegalArgumentException("width cannot be negative"); + } + if (height < 0) { + throw new IllegalArgumentException("height cannot be negative"); + } + 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) { - } else { + if (parent != null) { + this.window = parent.window; parent.addChild(this); } @@ -229,6 +235,13 @@ public abstract class TWidget implements Comparable { protected final void setupForTWindow(final TWindow window, final int x, final int y, final int width, final int height) { + if (width < 0) { + throw new IllegalArgumentException("width cannot be negative"); + } + if (height < 0) { + throw new IllegalArgumentException("height cannot be negative"); + } + this.parent = window; this.window = window; this.x = x; @@ -241,6 +254,17 @@ public abstract class TWidget implements Comparable { // 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. @@ -276,23 +300,25 @@ public abstract class TWidget implements Comparable { * @param keypress keystroke event */ public void onKeypress(final TKeypressEvent keypress) { + assert (parent != null); 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)) + || (keypress.equals(kbDown) && !(this instanceof TComboBox)) ) { parent.switchWidget(true); return; } else if ((keypress.equals(kbShiftTab)) || (keypress.equals(kbBackTab)) - || (keypress.equals(kbUp)) + || (keypress.equals(kbUp) && !(this instanceof TComboBox)) ) { parent.switchWidget(false); return; @@ -315,7 +341,7 @@ public abstract class TWidget implements Comparable { } // If I have any buttons on me AND this is an Alt-key that matches - // its mnemonic, send it an Enter keystroke + // its mnemonic, send it an Enter keystroke. for (TWidget widget: children) { if (widget instanceof TButton) { TButton button = (TButton) widget; @@ -333,6 +359,81 @@ public abstract class TWidget implements Comparable { } } + // 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) { @@ -349,6 +450,17 @@ public abstract class TWidget implements Comparable { */ 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)) { @@ -371,6 +483,17 @@ public abstract class TWidget implements Comparable { */ 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)) { @@ -410,6 +533,17 @@ public abstract class TWidget implements Comparable { */ 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)) { @@ -561,6 +695,97 @@ public abstract class TWidget implements Comparable { return children; } + /** + * Remove this widget from its parent container. close() will be called + * before it is removed. + */ + public final void remove() { + remove(true); + } + + /** + * Remove this widget from its parent container. + * + * @param doClose if true, call the close() method before removing the + * child + */ + public final void remove(final boolean doClose) { + if (parent != null) { + parent.remove(this, doClose); + } + } + + /** + * Remove a child widget from this container. + * + * @param child the child widget to remove + * @param doClose if true, call the close() method before removing the + * child + */ + public final void remove(final TWidget child, final boolean doClose) { + if (!children.contains(child)) { + throw new IndexOutOfBoundsException("child widget is not in " + + "list of children of this parent"); + } + if (doClose) { + child.close(); + } + children.remove(child); + child.parent = null; + } + + /** + * Set this widget's parent to a different widget. + * + * @param newParent new parent widget + * @param doClose if true, call the close() method before removing the + * child from its existing parent widget + */ + public final void setParent(final TWidget newParent, + final boolean doClose) { + + if (parent != null) { + parent.remove(this, doClose); + } + assert (parent == null); + window = newParent.window; + newParent.addChild(this); + } + + /** + * Set this widget's window to a specific window. Parent must already be + * null. Having a null parent with a specified window is only used + * within Jexer by TStatusBar because TApplication routes events directly + * to it and calls its draw() method. Any other non-parented widgets + * will require similar special case functionality to receive events or + * be drawn to screen. + * + * @param window the window to use + */ + public final void setWindow(final TWindow window) { + + if (parent != null) { + throw new IllegalArgumentException("Cannot have different " + + "windows for parent and child"); + } + this.window = window; + } + + /** + * Remove a child widget from this container, and all of its children + * recursively from their parent containers. + * + * @param child the child widget to remove + * @param doClose if true, call the close() method before removing each + * child + */ + public final void removeAll(final TWidget child, final boolean doClose) { + remove(child, doClose); + for (TWidget w: child.children) { + child.removeAll(w, doClose); + } + } + /** * Get active flag. * @@ -757,6 +982,8 @@ public abstract class TWidget implements Comparable { return false; } + assert (window != null); + // If cursor is out of my window's bounds, it is not visible. if ((getCursorAbsoluteX() >= window.getAbsoluteX() + window.getWidth() - 1) @@ -861,7 +1088,7 @@ public abstract class TWidget implements Comparable { if (parent == this) { return active; } - return (active && parent.isAbsoluteActive()); + return (active && (parent == null ? true : parent.isAbsoluteActive())); } /** @@ -931,7 +1158,7 @@ public abstract class TWidget implements Comparable { * * @return the ColorTheme */ - public final ColorTheme getTheme() { + protected final ColorTheme getTheme() { return window.getApplication().getTheme(); } @@ -944,9 +1171,9 @@ 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); @@ -992,19 +1219,24 @@ public abstract class TWidget implements Comparable { // Draw me draw(); + assert (visible == true); - // Continue down the chain + // Continue down the chain. Draw the active child last so that it + // is on top. for (TWidget widget: children) { - if (widget.isVisible()) { + if (widget.isVisible() && (widget != activeChild)) { widget.drawChildren(); } } + if (activeChild != null) { + activeChild.drawChildren(); + } } /** * Repaint the screen on the next update. */ - public final void doRepaint() { + protected final void doRepaint() { window.getApplication().doRepaint(); } @@ -1032,6 +1264,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. * @@ -1045,12 +1287,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; } } @@ -1061,9 +1310,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) @@ -1076,13 +1330,27 @@ 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; } } + /** + * Make this widget the active child of its parent. Note that this is + * not final since TWindow overrides activate(). + */ + public void activate() { + if (enabled) { + if (parent != null) { + parent.activate(this); + } + } + } + /** * Switch the active widget with the next in the tab order. * @@ -1091,12 +1359,31 @@ 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; } - int tabOrder = activeChild.tabOrder; + assert (parent != null); + + // 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; + } + + // 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++; @@ -1121,7 +1408,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; } @@ -1129,11 +1421,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); + } } /** @@ -1157,6 +1453,204 @@ public abstract class TWidget implements Comparable { return this; } + // ------------------------------------------------------------------------ + // Passthru for Screen functions ------------------------------------------ + // ------------------------------------------------------------------------ + + /** + * Get the attributes at one location. + * + * @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) + */ + protected final CellAttributes getAttrXY(final int x, final int y) { + return getScreen().getAttrXY(x, y); + } + + /** + * Set the attributes at one location. + * + * @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) + */ + protected final void putAttrXY(final int x, final int y, + final CellAttributes attr) { + + getScreen().putAttrXY(x, y, attr); + } + + /** + * Set the attributes at one location. + * + * @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 + */ + protected final void putAttrXY(final int x, final int y, + final CellAttributes attr, final boolean clip) { + + getScreen().putAttrXY(x, y, attr, clip); + } + + /** + * Fill the entire screen with one character with attributes. + * + * @param ch character to draw + * @param attr attributes to use (bold, foreColor, backColor) + */ + protected final void putAll(final int ch, final CellAttributes attr) { + getScreen().putAll(ch, attr); + } + + /** + * Render one character with attributes. + * + * @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 + */ + protected final void putCharXY(final int x, final int y, final Cell ch) { + getScreen().putCharXY(x, y, ch); + } + + /** + * Render one character with attributes. + * + * @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) + */ + protected final void putCharXY(final int x, final int y, final int ch, + final CellAttributes attr) { + + getScreen().putCharXY(x, y, ch, attr); + } + + /** + * Render one character without changing the underlying attributes. + * + * @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 + */ + protected final void putCharXY(final int x, final int y, final int ch) { + getScreen().putCharXY(x, y, ch); + } + + /** + * 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) + */ + protected final void putStringXY(final int x, final int y, final String str, + final CellAttributes attr) { + + getScreen().putStringXY(x, y, str, attr); + } + + /** + * Render a string without changing the underlying attribute. 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 + */ + protected final void putStringXY(final int x, final int y, final String str) { + getScreen().putStringXY(x, y, str); + } + + /** + * 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 int ch, final CellAttributes attr) { + + getScreen().vLineXY(x, y, n, ch, attr); + } + + /** + * 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 int ch, final CellAttributes attr) { + + getScreen().hLineXY(x, y, n, ch, attr); + } + + /** + * 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) { + + getScreen().drawBox(left, top, right, bottom, border, background); + } + + /** + * 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 + * @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 + */ + 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) { + + getScreen().drawBox(left, top, right, bottom, border, background, + borderType, shadow); + } + + /** + * 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 --------------------------------------------- // ------------------------------------------------------------------------ @@ -1173,6 +1667,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. * @@ -1189,6 +1698,23 @@ 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. * @@ -1206,6 +1732,26 @@ public abstract class TWidget implements Comparable { 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. * @@ -1245,18 +1791,18 @@ public abstract class TWidget implements Comparable { * @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 maxValuesHeight the maximum 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) { + final int maxValuesHeight, final TAction updateAction) { return new TComboBox(this, x, y, width, values, valuesIndex, - valuesHeight, updateAction); + maxValuesHeight, updateAction); } /** @@ -1481,6 +2027,22 @@ public abstract class TWidget implements Comparable { return getApplication().inputBox(title, caption, text); } + /** + * Convenience function to spawn an input box. + * + * @param title window title, will be centered along the top border + * @param caption message to display. Use embedded newlines to get a + * multi-line box. + * @param text initial text to seed the field with + * @param type one of the Type constants. Default is Type.OK. + * @return the new input box + */ + public final TInputBox inputBox(final String title, final String caption, + final String text, final TInputBox.Type type) { + + return getApplication().inputBox(title, caption, text, type); + } + /** * Convenience function to add a password text field to this * container/window. @@ -1579,6 +2141,17 @@ public abstract class TWidget implements Comparable { 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. * @@ -1592,6 +2165,41 @@ public abstract class TWidget implements Comparable { 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. * @@ -1616,7 +2224,8 @@ public abstract class TWidget implements Comparable { * @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 + * @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, @@ -1628,6 +2237,51 @@ public abstract class TWidget implements Comparable { /** * 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 @@ -1642,7 +2296,7 @@ public abstract class TWidget implements Comparable { } /** - * Convenience function to add a directory list to this container/window. + * Convenience function to add a list to this container/window. * * @param strings list of strings to show * @param x column relative to parent @@ -1660,7 +2314,7 @@ public abstract class TWidget implements Comparable { } /** - * Convenience function to add a directory list to this container/window. + * Convenience function to add a list to this container/window. * * @param strings list of strings to show * @param x column relative to parent @@ -1680,4 +2334,101 @@ public abstract class TWidget implements Comparable { moveAction); } + /** + * Convenience function to add a list to this container/window. + * + * @param strings list of strings to show. This is allowed to be null + * and set later with setList() or by subclasses. + * @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 + * @param singleClickAction action to perform when the user clicks on an + * item + */ + public TList addList(final List strings, final int x, + final int y, final int width, final int height, + final TAction enterAction, final TAction moveAction, + final TAction singleClickAction) { + + return new TList(this, strings, x, y, width, height, enterAction, + moveAction, singleClickAction); + } + + + /** + * Convenience function to add an image to this container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width number of text cells for width of the image + * @param height number of text cells for height of the image + * @param image the image to display + * @param left left column of the image. 0 is the left-most column. + * @param top top row of the image. 0 is the top-most row. + */ + public final TImage addImage(final int x, final int y, + final int width, final int height, + final BufferedImage image, final int left, final int top) { + + return new TImage(this, x, y, width, height, image, left, top); + } + + /** + * Convenience function to add an image to this container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width number of text cells for width of the image + * @param height number of text cells for height of the image + * @param image the image to display + * @param left left column of the image. 0 is the left-most column. + * @param top top row of the image. 0 is the top-most row. + * @param clickAction function to call when mouse is pressed + */ + public final TImage addImage(final int x, final int y, + final int width, final int height, + final BufferedImage image, final int left, final int top, + final TAction clickAction) { + + return new TImage(this, x, y, width, height, image, left, top, + clickAction); + } + + /** + * Convenience function to add an editable 2D data table to this + * container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width width of widget + * @param height height of widget + */ + public TTableWidget addTable(final int x, final int y, final int width, + final int height) { + + return new TTableWidget(this, x, y, width, height); + } + + /** + * Convenience function to add an editable 2D data table to this + * container/window. + * + * @param x column relative to parent + * @param y row relative to parent + * @param width width of widget + * @param height height of widget + * @param gridColumns number of columns in grid + * @param gridRows number of rows in grid + */ + public TTableWidget addTable(final int x, final int y, final int width, + final int height, final int gridColumns, final int gridRows) { + + return new TTableWidget(this, x, y, width, height, gridColumns, + gridRows); + } + }