X-Git-Url: http://git.nikiroo.be/?p=jvcard.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Fjvcard%2Ftui%2FMainWindow.java;h=236289904a07297401e35754a8f0d1babc98e12e;hp=7f438d918a717792f2686d6a86379c8949d74dd2;hb=7da41ecd30228908bf2afcd07ff7943ab59d4c01;hpb=fae07ea7af01c64ca1a858db75a615555318d5e2 diff --git a/src/be/nikiroo/jvcard/tui/MainWindow.java b/src/be/nikiroo/jvcard/tui/MainWindow.java index 7f438d9..2362899 100644 --- a/src/be/nikiroo/jvcard/tui/MainWindow.java +++ b/src/be/nikiroo/jvcard/tui/MainWindow.java @@ -1,16 +1,17 @@ package be.nikiroo.jvcard.tui; +import java.util.ArrayList; import java.util.Arrays; import java.util.LinkedList; import java.util.List; -import be.nikiroo.jvcard.Card; -import be.nikiroo.jvcard.Contact; -import be.nikiroo.jvcard.i18n.Trans; -import be.nikiroo.jvcard.i18n.Trans.StringId; +import be.nikiroo.jvcard.launcher.Main; +import be.nikiroo.jvcard.resources.StringUtils; +import be.nikiroo.jvcard.resources.Trans.StringId; import be.nikiroo.jvcard.tui.KeyAction.Mode; import be.nikiroo.jvcard.tui.UiColors.Element; import be.nikiroo.jvcard.tui.panes.ContactDetails; +import be.nikiroo.jvcard.tui.panes.ContactDetailsRaw; import be.nikiroo.jvcard.tui.panes.ContactList; import be.nikiroo.jvcard.tui.panes.MainContent; @@ -23,26 +24,24 @@ import com.googlecode.lanterna.gui2.Label; import com.googlecode.lanterna.gui2.LinearLayout; import com.googlecode.lanterna.gui2.Panel; import com.googlecode.lanterna.gui2.TextBox; -import com.googlecode.lanterna.gui2.TextGUIGraphics; import com.googlecode.lanterna.gui2.Window; import com.googlecode.lanterna.input.KeyStroke; import com.googlecode.lanterna.input.KeyType; /** - * This is the main "window" of the program. It will host one - * {@link MainContent} at any one time. + * This is the main "window" of the program. It can show up to one + * {@link MainContent} at any one time, but keeps a stack of contents. * * @author niki * */ + public class MainWindow extends BasicWindow { private List defaultActions = new LinkedList(); private List actions = new LinkedList(); - private List content = new LinkedList(); - private boolean actionsPadded; - private Boolean waitForOneKeyAnswer; // true, false, (null = do not wait for - // an answer) - private String title; + private List contentStack = new LinkedList(); + private UserQuestion userQuestion; + private String titleCache; private Panel titlePanel; private Panel mainPanel; private Panel contentPanel; @@ -50,10 +49,81 @@ public class MainWindow extends BasicWindow { private Panel messagePanel; private TextBox text; + /** + * Information about a question to ask the user and its answer. + * + * @author niki + * + */ + private class UserQuestion { + private boolean oneKeyAnswer; + private KeyAction action; + private String answer; + + /** + * Create a new {@link UserQuestion}. + * + * @param action + * the action that triggered the question + * @param oneKeyAnswer + * TRUE if we expect a one-key answer + */ + public UserQuestion(KeyAction action, boolean oneKeyAnswer) { + this.action = action; + this.oneKeyAnswer = oneKeyAnswer; + } + + /** + * Return the {@link KeyAction} that triggered the question. + * + * @return the {@link KeyAction} + */ + public KeyAction getAction() { + return action; + } + + /** + * Check if a one-key answer is expected. + * + * @return TRUE if a one-key answer is expected + */ + public boolean isOneKeyAnswer() { + return oneKeyAnswer; + } + + /** + * Return the user answer. + * + * @return the user answer + */ + public String getAnswer() { + return answer; + } + + /** + * Set the user answer. + * + * @param answer + * the new answer + */ + public void setAnswer(String answer) { + this.answer = answer; + } + } + + /** + * Create a new, empty window. + */ public MainWindow() { this(null); } + /** + * Create a new window hosting the given content. + * + * @param content + * the content to host + */ public MainWindow(MainContent content) { super(content == null ? "" : content.getTitle()); @@ -80,15 +150,14 @@ public class MainWindow extends BasicWindow { llayout.setSpacing(0); actionPanel.setLayoutManager(llayout); - llayout = new LinearLayout(Direction.VERTICAL); - llayout.setSpacing(0); - titlePanel.setLayoutManager(llayout); + BorderLayout blayout = new BorderLayout(); + titlePanel.setLayoutManager(blayout); llayout = new LinearLayout(Direction.VERTICAL); llayout.setSpacing(0); messagePanel.setLayoutManager(llayout); - BorderLayout blayout = new BorderLayout(); + blayout = new BorderLayout(); mainPanel.setLayoutManager(blayout); blayout = new BorderLayout(); @@ -112,77 +181,314 @@ public class MainWindow extends BasicWindow { setComponent(mainPanel); } + /** + * "push" some content to the window stack. + * + * @param content + * the new top-of-the-stack content + */ public void pushContent(MainContent content) { List actions = null; - String title = null; contentPanel.removeAllComponents(); if (content != null) { - title = content.getTitle(); actions = content.getKeyBindings(); contentPanel.addComponent(content, BorderLayout.Location.CENTER); - this.content.add(content); + this.contentStack.add(content); + + Interactable focus = content.nextFocus(null); + if (focus != null) + focus.takeFocus(); } - setTitle(title); - setActions(actions, true, true); - invalidate(); + setTitle(); + setActions(actions, true); } /** - * Set the application title. + * "pop" the latest, top-of-the-stack content from the window stack. * - * @param title - * the new title or NULL for the default title + * @return the removed content if any */ - public void setTitle(String title) { - if (title == null) { - title = Trans.StringId.TITLE.trans(); + public MainContent popContent() { + MainContent removed = null; + MainContent prev = null; + + MainContent content = getContent(); + if (content != null) + removed = contentStack.remove(contentStack.size() - 1); + + if (contentStack.size() > 0) + prev = contentStack.remove(contentStack.size() - 1); + + pushContent(prev); + + return removed; + } + + /** + * Show the given message on screen. It will disappear at the next action. + * + * @param mess + * the message to display + * @param error + * TRUE for an error message, FALSE for an information message + * + * @return TRUE if changes were performed + */ + public boolean setMessage(String mess, boolean error) { + if (mess != null || messagePanel.getChildCount() > 0) { + messagePanel.removeAllComponents(); + if (mess != null) { + Element element = (error ? UiColors.Element.LINE_MESSAGE_ERR + : UiColors.Element.LINE_MESSAGE); + Label lbl = element.createLabel(" " + mess + " "); + messagePanel.addComponent(lbl, LinearLayout + .createLayoutData(LinearLayout.Alignment.Center)); + } + return true; } - if (!title.equals(this.title)) { - super.setTitle(title); - this.title = title; + return false; + } + + /** + * Show a question to the user and switch to "ask for answer" mode see + * {@link MainWindow#handleQuestion}. The user will be asked to enter some + * answer and confirm with ENTER. + * + * @param action + * the related action + * @param question + * the question to ask + * @param initial + * the initial answer if any (to be edited by the user) + */ + public void setQuestion(KeyAction action, String question, String initial) { + setQuestion(action, question, initial, false); + } + + /** + * Show a question to the user and switch to "ask for answer" mode see + * {@link MainWindow#handleQuestion}. The user will be asked to hit one key + * as an answer. + * + * @param action + * the related action + * @param question + * the question to ask + */ + public void setQuestion(KeyAction action, String question) { + setQuestion(action, question, null, true); + } + + /** + * Show a question to the user and switch to "ask for answer" mode see + * {@link MainWindow#handleQuestion}. + * + * @param action + * the related action + * @param question + * the question to ask + * @param initial + * the initial answer if any (to be edited by the user) + * @param oneKey + * TRUE for a one-key answer, FALSE for a text answer validated + * by ENTER + */ + private void setQuestion(KeyAction action, String question, String initial, + boolean oneKey) { + userQuestion = new UserQuestion(action, oneKey); + + messagePanel.removeAllComponents(); + + Panel hpanel = new Panel(); + LinearLayout llayout = new LinearLayout(Direction.HORIZONTAL); + llayout.setSpacing(0); + hpanel.setLayoutManager(llayout); + + Label lbl = UiColors.Element.LINE_MESSAGE_QUESTION.createLabel(" " + + question + " "); + text = new TextBox(new TerminalSize(getSize().getColumns() + - lbl.getSize().getColumns(), 1)); + + if (initial != null) { + // add all chars one by one so the caret is at the end + for (int index = 0; index < initial.length(); index++) { + text.handleInput(new KeyStroke(initial.charAt(index), false, + false)); + } } - Label lbl = new Label(title); - titlePanel.removeAllComponents(); + hpanel.addComponent(lbl, + LinearLayout.createLayoutData(LinearLayout.Alignment.Beginning)); + hpanel.addComponent(text, + LinearLayout.createLayoutData(LinearLayout.Alignment.Fill)); + + messagePanel + .addComponent(hpanel, LinearLayout + .createLayoutData(LinearLayout.Alignment.Beginning)); - titlePanel.addComponent(lbl, LinearLayout - .createLayoutData(LinearLayout.Alignment.Center)); + text.takeFocus(); + } + + /** + * Refresh the window and the empty-space handling. You should call this + * method when the window size changed. + * + * @param size + * the new size of the window + */ + public void refresh(TerminalSize size) { + if (size == null) + return; + + if (getSize() == null || !getSize().equals(size)) + setSize(size); + + setTitle(); + + if (actions != null) + setActions(new ArrayList(actions), false); + + invalidate(); } @Override - public void draw(TextGUIGraphics graphics) { - setTitle(title); - if (!actionsPadded) { - // fill with "desc" colour - actionPanel.addComponent(UiColors.Element.ACTION_DESC - .createLabel(StringUtils.padString("", graphics.getSize() - .getColumns()))); - actionsPadded = true; + public void invalidate() { + super.invalidate(); + for (MainContent content : contentStack) { + content.invalidate(); } - super.draw(graphics); } - public MainContent popContent() { - MainContent removed = null; - MainContent prev = null; - if (content.size() > 0) - removed = content.remove(content.size() - 1); - if (content.size() > 0) - prev = content.remove(content.size() - 1); - pushContent(prev); + @Override + public boolean handleInput(KeyStroke key) { + boolean handled = false; - return removed; + if (userQuestion != null) { + handled = handleQuestion(userQuestion, key); + if (handled) { + if (userQuestion.getAnswer() != null) { + handleAction(userQuestion.getAction(), + userQuestion.getAnswer()); + + userQuestion = null; + } + } + } else { + handled = handleKey(key); + } + + if (!handled) { + handled = super.handleInput(key); + } + + return handled; } - private void setActions(List actions, boolean allowKeys, - boolean enableDefaultactions) { + /** + * Actually set the title inside the window. Will also call + * {@link BasicWindow#setTitle} with the computed parameters. + */ + private void setTitle() { + String prefix = " " + Main.APPLICATION_TITLE + " (version " + + Main.APPLICATION_VERSION + ")"; + + String title = null; + int count = -1; + MainContent content = getContent(); + if (content != null) { + title = content.getTitle(); + count = content.getCount(); + } + + if (title == null) + title = ""; + + if (title.length() > 0) { + prefix = prefix + ": "; + title = StringUtils.sanitize(title, Main.isUnicode()); + } + + String countStr = ""; + if (count > -1) { + countStr = "[" + count + "]"; + } + + int width = -1; + if (getSize() != null) { + width = getSize().getColumns(); + } + + if (width > 0) { + int padding = width - prefix.length() - title.length() + - countStr.length(); + if (padding > 0) { + if (title.length() > 0) + title = StringUtils.padString(title, title.length() + + padding); + else + prefix = StringUtils.padString(prefix, prefix.length() + + padding); + } + } + + String titleCache = prefix + title + count; + if (!titleCache.equals(this.titleCache)) { + super.setTitle(prefix); + + Label lblPrefix = new Label(prefix); + UiColors.Element.TITLE_MAIN.themeLabel(lblPrefix); + + Label lblTitle = null; + if (title.length() > 0) { + lblTitle = new Label(title); + UiColors.Element.TITLE_VARIABLE.themeLabel(lblTitle); + } + + Label lblCount = null; + if (countStr != null) { + lblCount = new Label(countStr); + UiColors.Element.TITLE_COUNT.themeLabel(lblCount); + } + + titlePanel.removeAllComponents(); + + titlePanel.addComponent(lblPrefix, BorderLayout.Location.LEFT); + if (lblTitle != null) + titlePanel.addComponent(lblTitle, BorderLayout.Location.CENTER); + if (lblCount != null) + titlePanel.addComponent(lblCount, BorderLayout.Location.RIGHT); + } + } + + /** + * Return the current {@link MainContent} from the stack if any. + * + * @return the current {@link MainContent} + */ + private MainContent getContent() { + if (contentStack.size() > 0) { + return contentStack.get(contentStack.size() - 1); + } + + return null; + } + + /** + * Update the list of actions and refresh the action panel. + * + * @param actions + * the list of actions to support + * @param enableDefaultactions + * TRUE to enable the default actions + */ + private void setActions(List actions, + boolean enableDefaultactions) { this.actions.clear(); - actionsPadded = false; - + if (enableDefaultactions) this.actions.addAll(defaultActions); @@ -191,34 +497,12 @@ public class MainWindow extends BasicWindow { actionPanel.removeAllComponents(); for (KeyAction action : this.actions) { - String trans = " " + action.getStringId().trans() + " "; + String trans = " " + Main.trans(action.getStringId()) + " "; if (" ".equals(trans)) continue; - String keyTrans = ""; - switch (action.getKey().getKeyType()) { - case Enter: - keyTrans = " ⤶ "; - break; - case Tab: - keyTrans = " ↹ "; - break; - case Character: - keyTrans = " " + action.getKey().getCharacter() + " "; - break; - default: - keyTrans = "" + action.getKey().getKeyType(); - int width = 3; - if (keyTrans.length() > width) { - keyTrans = keyTrans.substring(0, width); - } else if (keyTrans.length() < width) { - keyTrans = keyTrans - + new String(new char[width - keyTrans.length()]) - .replace('\0', ' '); - } - break; - } + String keyTrans = KeyAction.trans(action.getKey()); Panel kPane = new Panel(); LinearLayout layout = new LinearLayout(Direction.HORIZONTAL); @@ -231,162 +515,212 @@ public class MainWindow extends BasicWindow { actionPanel.addComponent(kPane); } - } - /** - * Show the given message on screen. It will disappear at the next action. - * - * @param mess - * the message to display - * @param error - * TRUE for an error message, FALSE for an information message - */ - public void setMessage(String mess, boolean error) { - messagePanel.removeAllComponents(); - if (mess != null) { - Element element = (error ? UiColors.Element.LINE_MESSAGE_ERR - : UiColors.Element.LINE_MESSAGE); - Label lbl = element.createLabel(" " + mess + " "); - messagePanel.addComponent(lbl, LinearLayout - .createLayoutData(LinearLayout.Alignment.Center)); + // fill with "desc" colour + int width = -1; + if (getSize() != null) { + width = getSize().getColumns(); } - } - - public void setQuestion(String mess, boolean oneKey) { - messagePanel.removeAllComponents(); - if (mess != null) { - waitForOneKeyAnswer = oneKey; - - Panel hpanel = new Panel(); - LinearLayout llayout = new LinearLayout(Direction.HORIZONTAL); - llayout.setSpacing(0); - hpanel.setLayoutManager(llayout); - - Label lbl = UiColors.Element.LINE_MESSAGE_QUESTION.createLabel(" " - + mess + " "); - text = new TextBox(new TerminalSize(getSize().getColumns() - - lbl.getSize().getColumns(), 1)); - - hpanel.addComponent(lbl, LinearLayout - .createLayoutData(LinearLayout.Alignment.Beginning)); - hpanel.addComponent(text, LinearLayout - .createLayoutData(LinearLayout.Alignment.Fill)); - - messagePanel.addComponent(hpanel, LinearLayout - .createLayoutData(LinearLayout.Alignment.Beginning)); - text.takeFocus(); + if (width > 0) { + actionPanel.addComponent(UiColors.Element.ACTION_DESC + .createLabel(StringUtils.padString("", width))); } } - private String handleQuestion(KeyStroke key) { - String answer = null; + /** + * Handle user input when in "ask for question" mode (see + * {@link MainWindow#userQuestion}). + * + * @param userQuestion + * the question data + * @param key + * the key that has been pressed by the user + * + * @return TRUE if the {@link KeyStroke} was handled + */ + private boolean handleQuestion(UserQuestion userQuestion, KeyStroke key) { + userQuestion.setAnswer(null); - if (waitForOneKeyAnswer) { - answer = "" + key.getCharacter(); + if (userQuestion.isOneKeyAnswer()) { + userQuestion.setAnswer("" + key.getCharacter()); } else { - if (key.getKeyType() == KeyType.Enter) { + // ^h == Backspace + if (key.isCtrlDown() && key.getCharacter() == 'h') { + key = new KeyStroke(KeyType.Backspace); + } + + switch (key.getKeyType()) { + case Enter: if (text != null) - answer = text.getText(); + userQuestion.setAnswer(text.getText()); else - answer = ""; + userQuestion.setAnswer(""); + break; + case Backspace: + int pos = text.getCaretPosition().getColumn(); + if (pos > 0) { + String current = text.getText(); + // force caret one space before: + text.setText(current.substring(0, pos - 1)); + // re-add full text: + text.setText(current.substring(0, pos - 1) + + current.substring(pos)); + } + return true; + default: + // Do nothing (continue entering text) + break; } } - if (answer != null) { + if (userQuestion.getAnswer() != null) { Interactable focus = null; - if (this.content.size() > 0) - // focus = content.get(0).getDefaultFocusElement(); - focus = content.get(0).nextFocus(null); + MainContent content = getContent(); + if (content != null) + focus = content.nextFocus(null); focus.takeFocus(); + + return true; } - return answer; + return false; } - @Override - public boolean handleInput(KeyStroke key) { + /** + * Handle the input in case of "normal" (not "ask for answer") mode. + * + * @param key + * the key that was pressed + * @param answer + * the answer given for this key + * + * @return if the window handled the input + */ + private boolean handleKey(KeyStroke key) { boolean handled = false; - if (waitForOneKeyAnswer != null) { - String answer = handleQuestion(key); - if (answer != null) { - waitForOneKeyAnswer = null; - setMessage("ANS: " + answer, false); + if (setMessage(null, false)) + return true; + + for (KeyAction action : actions) { + if (!action.match(key)) + continue; + + handled = true; - handled = true; + if (action.onAction()) { + handleAction(action, null); } - } else { - setMessage(null, false); - - for (KeyAction action : actions) { - if (!action.match(key)) - continue; - - handled = true; - - if (action.onAction()) { - switch (action.getMode()) { - case MOVE: - int x = 0; - int y = 0; - - if (action.getKey().getKeyType() == KeyType.ArrowUp) - x = -1; - if (action.getKey().getKeyType() == KeyType.ArrowDown) - x = 1; - if (action.getKey().getKeyType() == KeyType.ArrowLeft) - y = -1; - if (action.getKey().getKeyType() == KeyType.ArrowRight) - y = 1; - - if (content.size() > 0) { - String err = content.get(content.size() - 1).move( - x, y); - if (err != null) - setMessage(err, true); - } - - break; - // mode with windows: - case CONTACT_LIST: - Card card = action.getCard(); - if (card != null) { - pushContent(new ContactList(card)); - } - break; - case CONTACT_DETAILS: - Contact contact = action.getContact(); - if (contact != null) { - pushContent(new ContactDetails(contact)); - } - break; - // mode interpreted by MainWindow: - case HELP: - // TODO - // setMessage("Help! I need somebody! Help!", false); - setQuestion("Test question?", false); - handled = true; - break; - case BACK: + + break; + } + + return handled; + } + + /** + * Handle the input in case of "normal" (not "ask for answer") mode. + * + * @param key + * the key that was pressed + * @param answer + * the answer given for this key + * + * @return if the window handled the input + */ + private void handleAction(KeyAction action, String answer) { + MainContent content = getContent(); + + switch (action.getMode()) { + case MOVE: + int x = 0; + int y = 0; + + if (action.getKey().getKeyType() == KeyType.ArrowUp) + x = -1; + if (action.getKey().getKeyType() == KeyType.ArrowDown) + x = 1; + if (action.getKey().getKeyType() == KeyType.ArrowLeft) + y = -1; + if (action.getKey().getKeyType() == KeyType.ArrowRight) + y = 1; + + if (content != null) { + String err = content.move(x, y); + if (err != null) + setMessage(err, true); + } + + break; + // mode with windows: + case CONTACT_LIST: + if (action.getCard() != null) { + pushContent(new ContactList(action.getCard())); + } + break; + case CONTACT_DETAILS: + if (action.getContact() != null) { + pushContent(new ContactDetails(action.getContact())); + } + break; + case CONTACT_DETAILS_RAW: + if (action.getContact() != null) { + pushContent(new ContactDetailsRaw(action.getContact())); + } + break; + // mode interpreted by MainWindow: + case HELP: + // TODO + setMessage("Help! I need somebody! Help!", false); + + break; + case BACK: + String warning = content.getExitWarning(); + if (warning != null) { + if (answer == null) { + setQuestion(action, warning); + } else { + setMessage(null, false); + if (answer.equalsIgnoreCase("y")) { popContent(); - if (content.size() == 0) - close(); - break; - default: - case NONE: - break; } } - - break; + } else { + popContent(); } - } - if (!handled) - handled = super.handleInput(key); + if (contentStack.size() == 0) { + close(); + } - return handled; + break; + // action modes: + case ASK_USER: + if (answer == null) { + setQuestion(action, action.getQuestion(), + action.getDefaultAnswer()); + } else { + setMessage(action.callback(answer), true); + content.refreshData(); + invalidate(); + setTitle(); + } + break; + case ASK_USER_KEY: + if (answer == null) { + setQuestion(action, action.getQuestion()); + } else { + setMessage(action.callback(answer), true); + content.refreshData(); + invalidate(); + setTitle(); + } + break; + default: + case NONE: + break; + } } }