X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTList.java;h=12e0b8a33cce977e93ce4a6fd30080adeb75e8dc;hb=HEAD;hp=e47d7512e48cd175e480298daa6488824c84335b;hpb=b6faeac0d9c3e3ae3376ed28b54ec6ea6408ad7a;p=fanfix.git diff --git a/src/jexer/TList.java b/src/jexer/TList.java index e47d751..12e0b8a 100644 --- a/src/jexer/TList.java +++ b/src/jexer/TList.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"), @@ -32,6 +32,7 @@ import java.util.ArrayList; import java.util.List; import jexer.bits.CellAttributes; +import jexer.bits.StringUtils; import jexer.event.TKeypressEvent; import jexer.event.TMouseEvent; import static jexer.TKeypress.*; @@ -41,6 +42,10 @@ import static jexer.TKeypress.*; */ public class TList extends TScrollableWidget { + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * The list of strings to display. */ @@ -51,135 +56,64 @@ public class TList extends TScrollableWidget { */ private int selectedString = -1; - /** - * Get the selection index. - * - * @return -1 if nothing is selected, otherwise the index into the list - */ - public final int getSelectedIndex() { - return selectedString; - } - - /** - * Set the selected string index. - * - * @param index -1 to unselect, otherwise the index into the list - */ - public final void setSelectedIndex(final int index) { - selectedString = index; - } - - /** - * Get the selected string. - * - * @return the selected string, or null of nothing is selected yet - */ - public final String getSelected() { - if ((selectedString >= 0) && (selectedString <= strings.size() - 1)) { - return strings.get(selectedString); - } - return null; - } - - /** - * Get the maximum selection index value. - * - * @return -1 if the list is empty - */ - public final int getMaxSelectedIndex() { - return strings.size() - 1; - } - - /** - * Set the new list of strings to display. - * - * @param list new list of strings - */ - public final void setList(final List list) { - strings.clear(); - strings.addAll(list); - reflowData(); - } - /** * Maximum width of a single line. */ private int maxLineWidth; /** - * The action to perform when the user selects an item (clicks or enter). + * The action to perform when the user selects an item (double-clicks or + * enter). */ - private TAction enterAction = null; + protected TAction enterAction = null; /** - * The action to perform when the user navigates with keyboard. + * The action to perform when the user selects an item (single-click). */ - private TAction moveAction = null; + protected TAction singleClickAction = null; /** - * Perform user selection action. + * The action to perform when the user navigates with keyboard. */ - public void dispatchEnter() { - assert (selectedString >= 0); - assert (selectedString < strings.size()); - if (enterAction != null) { - enterAction.DO(); - } - } + protected TAction moveAction = null; - /** - * Perform list movement action. - */ - public void dispatchMove() { - assert (selectedString >= 0); - assert (selectedString < strings.size()); - if (moveAction != null) { - moveAction.DO(); - } - } + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Resize for a new width/height. + * Public constructor. + * + * @param parent parent widget + * @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 */ - @Override - public void reflowData() { - - // Reset the lines - selectedString = -1; - maxLineWidth = 0; - - for (int i = 0; i < strings.size(); i++) { - String line = strings.get(i); - if (line.length() > maxLineWidth) { - maxLineWidth = line.length(); - } - } - - setBottomValue(strings.size() - getHeight() + 1); - if (getBottomValue() < 0) { - setBottomValue(0); - } + public TList(final TWidget parent, final List strings, final int x, + final int y, final int width, final int height) { - setRightValue(maxLineWidth - getWidth() + 1); - if (getRightValue() < 0) { - setRightValue(0); - } + this(parent, strings, x, y, width, height, null, null, null); } /** * Public constructor. * * @param parent parent widget - * @param strings list of strings to show + * @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 */ public TList(final TWidget parent, final List strings, final int x, - final int y, final int width, final int height) { + final int y, final int width, final int height, + final TAction enterAction) { - this(parent, strings, x, y, width, height, null); + this(parent, strings, x, y, width, height, enterAction, null, null); } /** @@ -193,21 +127,15 @@ public class TList extends TScrollableWidget { * @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 */ public TList(final TWidget parent, final List strings, final int x, final int y, final int width, final int height, - final TAction enterAction) { - - super(parent, x, y, width, height); - this.enterAction = enterAction; - this.strings = new ArrayList(); - if (strings != null) { - this.strings.addAll(strings); - } + final TAction enterAction, final TAction moveAction) { - hScroller = new THScroller(this, 0, getHeight() - 1, getWidth() - 1); - vScroller = new TVScroller(this, getWidth() - 1, 0, getHeight() - 1); - reflowData(); + this(parent, strings, x, y, width, height, enterAction, moveAction, + null); } /** @@ -223,14 +151,18 @@ public class TList extends TScrollableWidget { * @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(final TWidget parent, final List strings, final int x, final int y, final int width, final int height, - final TAction enterAction, final TAction moveAction) { + final TAction enterAction, final TAction moveAction, + final TAction singleClickAction) { super(parent, x, y, width, height); this.enterAction = enterAction; this.moveAction = moveAction; + this.singleClickAction = singleClickAction; this.strings = new ArrayList(); if (strings != null) { this.strings.addAll(strings); @@ -241,48 +173,9 @@ public class TList extends TScrollableWidget { reflowData(); } - /** - * Draw the files list. - */ - @Override - public void draw() { - CellAttributes color = null; - int begin = getVerticalValue(); - int topY = 0; - for (int i = begin; i < strings.size(); i++) { - String line = strings.get(i); - if (getHorizontalValue() < line.length()) { - line = line.substring(getHorizontalValue()); - } else { - line = ""; - } - if (i == selectedString) { - color = getTheme().getColor("tlist.selected"); - } else if (isAbsoluteActive()) { - color = getTheme().getColor("tlist"); - } else { - color = getTheme().getColor("tlist.inactive"); - } - String formatString = "%-" + Integer.toString(getWidth() - 1) + "s"; - getScreen().putStringXY(0, topY, String.format(formatString, line), - color); - topY++; - if (topY >= getHeight() - 1) { - break; - } - } - - if (isAbsoluteActive()) { - color = getTheme().getColor("tlist"); - } else { - color = getTheme().getColor("tlist.inactive"); - } - - // Pad the rest with blank lines - for (int i = topY; i < getHeight() - 1; i++) { - getScreen().hLineXY(0, i, getWidth() - 1, ' ', color); - } - } + // ------------------------------------------------------------------------ + // Event handlers --------------------------------------------------------- + // ------------------------------------------------------------------------ /** * Handle mouse press events. @@ -301,9 +194,11 @@ public class TList extends TScrollableWidget { } if ((mouse.getX() < getWidth() - 1) - && (mouse.getY() < getHeight() - 1)) { + && (mouse.getY() < getHeight() - 1) + ) { if (getVerticalValue() + mouse.getY() < strings.size()) { selectedString = getVerticalValue() + mouse.getY(); + dispatchSingleClick(); } return; } @@ -320,7 +215,8 @@ public class TList extends TScrollableWidget { @Override public void onMouseDoubleClick(final TMouseEvent mouse) { if ((mouse.getX() < getWidth() - 1) - && (mouse.getY() < getHeight() - 1)) { + && (mouse.getY() < getHeight() - 1) + ) { if (getVerticalValue() + mouse.getY() < strings.size()) { selectedString = getVerticalValue() + mouse.getY(); dispatchEnter(); @@ -427,4 +323,224 @@ public class TList extends TScrollableWidget { } } + // ------------------------------------------------------------------------ + // TScrollableWidget ------------------------------------------------------ + // ------------------------------------------------------------------------ + + /** + * Override TWidget's width: we need to set child widget widths. + * + * @param width new widget width + */ + @Override + public void setWidth(final int width) { + super.setWidth(width); + if (hScroller != null) { + hScroller.setWidth(getWidth() - 1); + } + if (vScroller != null) { + vScroller.setX(getWidth() - 1); + } + } + + /** + * Override TWidget's height: we need to set child widget heights. + * + * @param height new widget height + */ + @Override + public void setHeight(final int height) { + super.setHeight(height); + if (hScroller != null) { + hScroller.setY(getHeight() - 1); + } + if (vScroller != null) { + vScroller.setHeight(getHeight() - 1); + } + } + + /** + * Resize for a new width/height. + */ + @Override + public void reflowData() { + + // Reset the lines + selectedString = -1; + maxLineWidth = 0; + + for (int i = 0; i < strings.size(); i++) { + String line = strings.get(i); + int lineLength = StringUtils.width(line); + if (lineLength > maxLineWidth) { + maxLineWidth = lineLength; + } + } + + setBottomValue(strings.size() - getHeight() + 1); + if (getBottomValue() < 0) { + setBottomValue(0); + } + + setRightValue(maxLineWidth - getWidth() + 1); + if (getRightValue() < 0) { + setRightValue(0); + } + } + + /** + * Draw the list. + */ + @Override + public void draw() { + CellAttributes color = null; + int begin = getVerticalValue(); + int topY = 0; + for (int i = begin; i < strings.size(); i++) { + String line = strings.get(i); + if (line == null) { + line = ""; + } + if (getHorizontalValue() < line.length()) { + line = line.substring(getHorizontalValue()); + } else { + line = ""; + } + if (i == selectedString) { + if (isAbsoluteActive()) { + color = getTheme().getColor("tlist.selected"); + } else { + color = getTheme().getColor("tlist.selected.inactive"); + } + } else if (isAbsoluteActive()) { + color = getTheme().getColor("tlist"); + } else { + color = getTheme().getColor("tlist.inactive"); + } + String formatString = "%-" + Integer.toString(getWidth() - 1) + "s"; + putStringXY(0, topY, String.format(formatString, line), color); + topY++; + if (topY >= getHeight() - 1) { + break; + } + } + + if (isAbsoluteActive()) { + color = getTheme().getColor("tlist"); + } else { + color = getTheme().getColor("tlist.inactive"); + } + + // Pad the rest with blank lines + for (int i = topY; i < getHeight() - 1; i++) { + hLineXY(0, i, getWidth() - 1, ' ', color); + } + } + + // ------------------------------------------------------------------------ + // TList ------------------------------------------------------------------ + // ------------------------------------------------------------------------ + + /** + * Get the selection index. + * + * @return -1 if nothing is selected, otherwise the index into the list + */ + public final int getSelectedIndex() { + return selectedString; + } + + /** + * Set the selected string index. + * + * @param index -1 to unselect, otherwise the index into the list + */ + public final void setSelectedIndex(final int index) { + selectedString = index; + } + + /** + * Get a selectable string by index. + * + * @param idx index into list + * @return the string at idx in the list + */ + public final String getListItem(final int idx) { + return strings.get(idx); + } + + /** + * Get the selected string. + * + * @return the selected string, or null of nothing is selected yet + */ + public final String getSelected() { + if ((selectedString >= 0) && (selectedString <= strings.size() - 1)) { + return strings.get(selectedString); + } + return null; + } + + /** + * Get the maximum selection index value. + * + * @return -1 if the list is empty + */ + public final int getMaxSelectedIndex() { + return strings.size() - 1; + } + + /** + * Get a copy of the list of strings to display. + * + * @return the list of strings + */ + public final List getList() { + return new ArrayList(strings); + } + + /** + * Set the new list of strings to display. + * + * @param list new list of strings + */ + public final void setList(final List list) { + strings.clear(); + strings.addAll(list); + reflowData(); + } + + /** + * Perform user selection action. + */ + public void dispatchEnter() { + assert (selectedString >= 0); + assert (selectedString < strings.size()); + if (enterAction != null) { + enterAction.DO(this); + } + } + + /** + * Perform list movement action. + */ + public void dispatchMove() { + assert (selectedString >= 0); + assert (selectedString < strings.size()); + if (moveAction != null) { + moveAction.DO(this); + } + } + + /** + * Perform single-click action. + */ + public void dispatchSingleClick() { + assert (selectedString >= 0); + assert (selectedString < strings.size()); + if (singleClickAction != null) { + singleClickAction.DO(this); + } + } + }