update README
[fanfix.git] / src / jexer / TInputBox.java
CommitLineData
daa4106c 1/*
c6940ed9
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
c6940ed9 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
c6940ed9 7 *
e16dda65
KL
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:
c6940ed9 14 *
e16dda65
KL
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
c6940ed9 17 *
e16dda65
KL
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.
c6940ed9
KL
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29package jexer;
30
31/**
32 * TInputBox is a system-modal dialog with an OK button and a text input
33 * field. Call it like:
34 *
c6940ed9
KL
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 */
051e2913 45public class TInputBox extends TMessageBox {
c6940ed9 46
615a0d99
KL
47 // ------------------------------------------------------------------------
48 // Variables --------------------------------------------------------------
49 // ------------------------------------------------------------------------
50
c6940ed9
KL
51 /**
52 * The input field.
53 */
54 private TField field;
55
615a0d99
KL
56 // ------------------------------------------------------------------------
57 // Constructors -----------------------------------------------------------
58 // ------------------------------------------------------------------------
c6940ed9
KL
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
72b6bd90 71 this(application, title, caption, "", Type.OK);
c6940ed9
KL
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
72b6bd90
KL
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);
c6940ed9
KL
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
a69ed767
KL
113 // Set the secondaryThread to run me
114 getApplication().enableSecondaryEventReceiver(this);
115
c6940ed9
KL
116 // Yield to the secondary thread. When I come back from the
117 // constructor response will already be set.
118 getApplication().yield();
119 }
120
615a0d99 121 // ------------------------------------------------------------------------
a69ed767 122 // TMessageBox ------------------------------------------------------------
615a0d99
KL
123 // ------------------------------------------------------------------------
124
125 // ------------------------------------------------------------------------
a69ed767 126 // TInputBox --------------------------------------------------------------
615a0d99
KL
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
c6940ed9 138}