src/jexer/TInputBox.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2017 Kevin Lamonte
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer;
  30
  31 /**
  32  * TInputBox is a system-modal dialog with an OK button and a text input
  33  * field.  Call it like:
  34  *
  35  * <pre>
  36  * {@code
  37  *     box = application.inputBox(title, caption);
  38  *     if (box.getText().equals("yes")) {
  39  *         ... the user entered "yes", do stuff ...
  40  *     }
  41  * }
  42  * </pre>
  43  *
  44  */
  45 public class TInputBox extends TMessageBox {
  46
  47     /**
  48      * The input field.
  49      */
  50     private TField field;
  51
  52     /**
  53      * Retrieve the answer text.
  54      *
  55      * @return the answer text
  56      */
  57     public String getText() {
  58         return field.getText();
  59     }
  60
  61     /**
  62      * Public constructor.  The input box will be centered on screen.
  63      *
  64      * @param application TApplication that manages this window
  65      * @param title window title, will be centered along the top border
  66      * @param caption message to display.  Use embedded newlines to get a
  67      * multi-line box.
  68      */
  69     public TInputBox(final TApplication application, final String title,
  70         final String caption) {
  71
  72         this(application, title, caption, "");
  73     }
  74
  75     /**
  76      * Public constructor.  The input box will be centered on screen.
  77      *
  78      * @param application TApplication that manages this window
  79      * @param title window title, will be centered along the top border
  80      * @param caption message to display.  Use embedded newlines to get a
  81      * multi-line box.
  82      * @param text initial text to seed the field with
  83      */
  84     public TInputBox(final TApplication application, final String title,
  85         final String caption, final String text) {
  86
  87         super(application, title, caption, Type.OK, false);
  88
  89         for (TWidget widget: getChildren()) {
  90             if (widget instanceof TButton) {
  91                 widget.setY(widget.getY() + 2);
  92             }
  93         }
  94
  95         setHeight(getHeight() + 2);
  96         field = addField(1, getHeight() - 6, getWidth() - 4, false, text);
  97
  98         // Yield to the secondary thread.  When I come back from the
  99         // constructor response will already be set.
 100         getApplication().yield();
 101     }
 102
 103 }