import jexer.backend.Screen;
import jexer.bits.Cell;
import jexer.bits.CellAttributes;
+import jexer.bits.Clipboard;
import jexer.bits.ColorTheme;
import jexer.event.TCommandEvent;
import jexer.event.TInputEvent;
* @param enabled if true assume enabled
*/
protected TWidget(final TWidget parent, final boolean enabled) {
- this.enabled = enabled;
- this.parent = parent;
- children = new ArrayList<TWidget>();
-
- if (parent != null) {
- this.window = parent.window;
- parent.addChild(this);
- }
+ this(parent, enabled, 0, 0, 0, 0);
}
/**
* @param command command event
*/
public void onCommand(final TCommandEvent command) {
- // Default: do nothing, pass to children instead
- for (TWidget widget: children) {
- widget.onCommand(command);
+ if (activeChild != null) {
+ activeChild.onCommand(command);
}
}
* @param menu menu event
*/
public void onMenu(final TMenuEvent menu) {
-
- // Special case: if a split command comes in, insert a TPanel and
- // TSplitPane in the hierarchy here.
- TPanel panel = null;
- TSplitPane pane = null;
- List<TWidget> widgets = null;
- switch (menu.getId()) {
- case TMenu.MID_SPLIT_VERTICAL:
- if (children.size() == 0) {
- break;
- }
- panel = new TPanel(null, x, y, width, height);
- pane = new TSplitPane(null, x, y, width, height, true);
- widgets = new ArrayList<TWidget>(children);
- for (TWidget w: widgets) {
- w.setParent(panel, false);
- }
- children.clear();
- pane.setParent(this, false);
- pane.setLeft(panel);
- activate(pane);
- for (TWidget w: widgets) {
- assert (w.window != null);
- assert (w.parent != null);
- }
- assert (pane.getWindow() != null);
- assert (pane.getParent() != null);
- assert (panel.getWindow() != null);
- assert (panel.getParent() != null);
- assert (pane.isActive() == true);
- assert (panel.isActive() == true);
- return;
- case TMenu.MID_SPLIT_HORIZONTAL:
- if (children.size() == 0) {
- break;
- }
- panel = new TPanel(null, x, y, width, height);
- pane = new TSplitPane(null, x, y, width, height, false);
- widgets = new ArrayList<TWidget>(children);
- for (TWidget w: widgets) {
- w.setParent(panel, false);
- }
- children.clear();
- pane.setParent(this, false);
- pane.setTop(panel);
- activate(pane);
- for (TWidget w: widgets) {
- assert (w.window != null);
- assert (w.parent != null);
- }
- assert (pane.getWindow() != null);
- assert (pane.getParent() != null);
- assert (panel.getWindow() != null);
- assert (panel.getParent() != null);
- assert (pane.isActive() == true);
- assert (panel.isActive() == true);
- return;
- default:
- break;
- }
-
// Default: do nothing, pass to children instead
for (TWidget widget: children) {
widget.onMenu(menu);
public final void setDimensions(final int x, final int y, final int width,
final int height) {
- setX(x);
- setY(y);
+ this.x = x;
+ this.y = y;
+ // Call the functions so that subclasses can choose how to handle it.
setWidth(width);
setHeight(height);
if (layout != null) {
assert (window != null);
+ if (window instanceof TDesktop) {
+ // Desktop doesn't have a window border.
+ return cursorVisible;
+ }
+
// If cursor is out of my window's bounds, it is not visible.
if ((getCursorAbsoluteX() >= window.getAbsoluteX()
+ window.getWidth() - 1)
return null;
}
+ /**
+ * Get the Clipboard.
+ *
+ * @return the Clipboard, or null if not assigned
+ */
+ public Clipboard getClipboard() {
+ if (window != null) {
+ return window.getApplication().getClipboard();
+ }
+ return null;
+ }
+
/**
* Comparison operator. For various subclasses it sorts on:
* <ul>
* @return difference between this.tabOrder and that.tabOrder, or
* difference between this.z and that.z, or String.compareTo(text)
*/
- public final int compareTo(final TWidget that) {
+ @Override
+ public int compareTo(final TWidget that) {
if ((this instanceof TWindow)
&& (that instanceof TWindow)
) {
return window.getApplication().getTheme();
}
+ /**
+ * See if this widget can be drawn onto a screen.
+ *
+ * @return true if this widget is part of the hierarchy that can draw to
+ * a screen
+ */
+ public final boolean isDrawable() {
+ if ((window == null)
+ || (window.getScreen() == null)
+ || (parent == null)
+ ) {
+ return false;
+ }
+ if (parent == this) {
+ return true;
+ }
+ return (parent.isDrawable());
+ }
+
/**
* Draw my specific widget. When called, the screen rectangle I draw
* into is already setup (offset and clipping).
* Called by parent to render to TWindow. Note package private access.
*/
final void drawChildren() {
+ if (!isDrawable()) {
+ return;
+ }
+
// Set my clipping rectangle
assert (window != null);
assert (getScreen() != null);
int absoluteRightEdge = window.getAbsoluteX() + window.getWidth();
int absoluteBottomEdge = window.getAbsoluteY() + window.getHeight();
- if (!(this instanceof TWindow) && !(this instanceof TVScroller)) {
+ if (!(this instanceof TWindow)
+ && !(this instanceof TVScroller)
+ && !(window instanceof TDesktop)
+ ) {
absoluteRightEdge -= 1;
}
- if (!(this instanceof TWindow) && !(this instanceof THScroller)) {
+ if (!(this instanceof TWindow)
+ && !(this instanceof THScroller)
+ && !(window instanceof TDesktop)
+ ) {
absoluteBottomEdge -= 1;
}
int myRightEdge = getAbsoluteX() + width;
// Draw me
draw();
+ if (!isDrawable()) {
+ // An action taken by a draw method unhooked me from the UI.
+ // Bail out.
+ return;
+ }
+
assert (visible == true);
// Continue down the chain. Draw the active child last so that it
for (TWidget widget: children) {
if (widget.isVisible() && (widget != activeChild)) {
widget.drawChildren();
+ if (!isDrawable()) {
+ // An action taken by a draw method unhooked me from the UI.
+ // Bail out.
+ return;
+ }
}
}
if (activeChild != null) {
*
* @param child TWidget to add
*/
- private void addChild(final TWidget child) {
+ public void addChild(final TWidget child) {
children.add(child);
if ((child.enabled)
children.get(i).tabOrder = i;
}
}
+
+ /**
+ * Remove and {@link TWidget#close()} the given child from this {@link TWidget}.
+ * <p>
+ * Will also reorder the tab values of the remaining children.
+ *
+ * @param child the child to remove
+ *
+ * @return TRUE if the child was removed, FALSE if it was not found
+ */
+ public boolean removeChild(final TWidget child) {
+ if (children.remove(child)) {
+ child.close();
+ child.parent = null;
+ child.window = null;
+
+ resetTabOrder();
+
+ return true;
+ }
+
+ return false;
+ }
/**
* Switch the active child.
if (activeChild != null) {
activeChild.active = false;
}
- child.active = true;
- activeChild = child;
}
+ child.active = true;
+ activeChild = child;
}
}
}
}
+ /**
+ * Make this widget, all of its parents, the active child.
+ */
+ public final void activateAll() {
+ activate();
+ if (parent == this) {
+ return;
+ }
+ if (parent != null) {
+ parent.activateAll();
+ }
+ }
+
/**
* Switch the active widget with the next in the tab order.
*
return this;
}
+ /**
+ * Insert a vertical split between this widget and parent, and optionally
+ * put another widget in the other side of the split.
+ *
+ * @param newWidgetOnLeft if true, the new widget (if specified) will be
+ * on the left pane, and this widget will be placed on the right pane
+ * @param newWidget the new widget to add to the other pane, or null
+ * @return the new split pane widget
+ */
+ public TSplitPane splitVertical(final boolean newWidgetOnLeft,
+ final TWidget newWidget) {
+
+ TSplitPane splitPane = new TSplitPane(null, x, y, width, height, true);
+ TWidget myParent = parent;
+ remove(false);
+ if (myParent instanceof TSplitPane) {
+ // TSplitPane has a left/right/top/bottom link to me somewhere,
+ // replace it with a link to splitPane.
+ ((TSplitPane) myParent).replaceWidget(this, splitPane);
+ }
+ splitPane.setParent(myParent, false);
+ if (newWidgetOnLeft) {
+ splitPane.setLeft(newWidget);
+ splitPane.setRight(this);
+ } else {
+ splitPane.setLeft(this);
+ splitPane.setRight(newWidget);
+ }
+ if (newWidget != null) {
+ newWidget.activateAll();
+ } else {
+ activateAll();
+ }
+
+ assert (parent != null);
+ assert (window != null);
+ assert (splitPane.getWindow() != null);
+ assert (splitPane.getParent() != null);
+ assert (splitPane.isActive() == true);
+ assert (parent == splitPane);
+ if (newWidget != null) {
+ assert (newWidget.parent == parent);
+ assert (newWidget.active == true);
+ assert (active == false);
+ } else {
+ assert (active == true);
+ }
+ return splitPane;
+ }
+
+ /**
+ * Insert a horizontal split between this widget and parent, and
+ * optionally put another widget in the other side of the split.
+ *
+ * @param newWidgetOnTop if true, the new widget (if specified) will be
+ * on the top pane, and this widget's children will be placed on the
+ * bottom pane
+ * @param newWidget the new widget to add to the other pane, or null
+ * @return the new split pane widget
+ */
+ public TSplitPane splitHorizontal(final boolean newWidgetOnTop,
+ final TWidget newWidget) {
+
+ TSplitPane splitPane = new TSplitPane(null, x, y, width, height, false);
+ TWidget myParent = parent;
+ remove(false);
+ if (myParent instanceof TSplitPane) {
+ // TSplitPane has a left/right/top/bottom link to me somewhere,
+ // replace it with a link to splitPane.
+ ((TSplitPane) myParent).replaceWidget(this, splitPane);
+ }
+ splitPane.setParent(myParent, false);
+ if (newWidgetOnTop) {
+ splitPane.setTop(newWidget);
+ splitPane.setBottom(this);
+ } else {
+ splitPane.setTop(this);
+ splitPane.setBottom(newWidget);
+ }
+ if (newWidget != null) {
+ newWidget.activateAll();
+ } else {
+ activateAll();
+ }
+
+ assert (parent != null);
+ assert (window != null);
+ assert (splitPane.getWindow() != null);
+ assert (splitPane.getParent() != null);
+ assert (splitPane.isActive() == true);
+ assert (parent == splitPane);
+ if (newWidget != null) {
+ assert (newWidget.parent == parent);
+ assert (newWidget.active == true);
+ assert (active == false);
+ } else {
+ assert (active == true);
+ }
+ return splitPane;
+ }
+
+ /**
+ * Generate a human-readable string for this widget.
+ *
+ * @return a human-readable string
+ */
+ @Override
+ public String toString() {
+ return String.format("%s(%8x) position (%d, %d) geometry %dx%d " +
+ "active %s enabled %s visible %s", getClass().getName(),
+ hashCode(), x, y, width, height, active, enabled, visible);
+ }
+
+ /**
+ * Generate a string for this widget's hierarchy.
+ *
+ * @param prefix a prefix to use for this widget's place in the hierarchy
+ * @return a pretty-printable string of this hierarchy
+ */
+ protected String toPrettyString(final String prefix) {
+ StringBuilder sb = new StringBuilder(prefix);
+ sb.append(toString());
+ String newPrefix = "";
+ for (int i = 0; i < prefix.length(); i++) {
+ newPrefix += " ";
+ }
+ for (int i = 0; i < children.size(); i++) {
+ TWidget child= children.get(i);
+ sb.append("\n");
+ if (i == children.size() - 1) {
+ sb.append(child.toPrettyString(newPrefix + " \u2514\u2500"));
+ } else {
+ sb.append(child.toPrettyString(newPrefix + " \u251c\u2500"));
+ }
+ }
+ return sb.toString();
+ }
+
+ /**
+ * Generate a string for this widget's hierarchy.
+ *
+ * @return a pretty-printable string of this hierarchy
+ */
+ public String toPrettyString() {
+ return toPrettyString("");
+ }
+
// ------------------------------------------------------------------------
// Passthru for Screen functions ------------------------------------------
// ------------------------------------------------------------------------
return new TRadioGroup(this, x, y, label);
}
+ /**
+ * Convenience function to add a radio button group to this
+ * container/window.
+ *
+ * @param x column relative to parent
+ * @param y row relative to parent
+ * @param width width of group
+ * @param label label to display on the group box
+ */
+ public final TRadioGroup addRadioGroup(final int x, final int y,
+ final int width, final String label) {
+
+ return new TRadioGroup(this, x, y, width, label);
+ }
+
/**
* Convenience function to add a text field to this container/window.
*