src/jexer/TInputBox.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2019 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 = 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     // Variables --------------------------------------------------------------
  49     // ------------------------------------------------------------------------
  50
  51     /**
  52      * The input field.
  53      */
  54     private TField field;
  55
  56     // ------------------------------------------------------------------------
  57     // Constructors -----------------------------------------------------------
  58     // ------------------------------------------------------------------------
  59
  60     /**
  61      * Public constructor.  The input box will be centered on screen.
  62      *
  63      * @param application TApplication that manages this window
  64      * @param title window title, will be centered along the top border
  65      * @param caption message to display.  Use embedded newlines to get a
  66      * multi-line box.
  67      */
  68     public TInputBox(final TApplication application, final String title,
  69         final String caption) {
  70
  71         this(application, title, caption, "", Type.OK);
  72     }
  73
  74     /**
  75      * Public constructor.  The input box will be centered on screen.
  76      *
  77      * @param application TApplication that manages this window
  78      * @param title window title, will be centered along the top border
  79      * @param caption message to display.  Use embedded newlines to get a
  80      * multi-line box.
  81      * @param text initial text to seed the field with
  82      */
  83     public TInputBox(final TApplication application, final String title,
  84         final String caption, final String text) {
  85
  86         this(application, title, caption, text, Type.OK);
  87     }
  88
  89     /**
  90      * Public constructor.  The input box will be centered on screen.
  91      *
  92      * @param application TApplication that manages this window
  93      * @param title window title, will be centered along the top border
  94      * @param caption message to display.  Use embedded newlines to get a
  95      * multi-line box.
  96      * @param text initial text to seed the field with
  97      * @param type one of the Type constants.  Default is Type.OK.
  98      */
  99     public TInputBox(final TApplication application, final String title,
 100         final String caption, final String text, final Type type) {
 101
 102         super(application, title, caption, type, false);
 103
 104         for (TWidget widget: getChildren()) {
 105             if (widget instanceof TButton) {
 106                 widget.setY(widget.getY() + 2);
 107             }
 108         }
 109
 110         setHeight(getHeight() + 2);
 111         field = addField(1, getHeight() - 6, getWidth() - 4, false, text);
 112
 113         // Set the secondaryThread to run me
 114         getApplication().enableSecondaryEventReceiver(this);
 115
 116         // Yield to the secondary thread.  When I come back from the
 117         // constructor response will already be set.
 118         getApplication().yield();
 119     }
 120
 121     // ------------------------------------------------------------------------
 122     // TMessageBox ------------------------------------------------------------
 123     // ------------------------------------------------------------------------
 124
 125     // ------------------------------------------------------------------------
 126     // TInputBox --------------------------------------------------------------
 127     // ------------------------------------------------------------------------
 128
 129     /**
 130      * Retrieve the answer text.
 131      *
 132      * @return the answer text
 133      */
 134     public String getText() {
 135         return field.getText();
 136     }
 137
 138 }