[fanfix.git] / src / jexer / TMessageBox.java

/*
 * Jexer - Java Text User Interface
 *
 * The MIT License (MIT)
 *
 * Copyright (C) 2017 Kevin Lamonte
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
 * @version 1
 */
package jexer;

import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;

import jexer.event.TKeypressEvent;
import static jexer.TKeypress.*;

/**
 * TMessageBox is a system-modal dialog with buttons for OK, Cancel, Yes, or
 * No.  Call it like:
 *
 * <p>
 * <pre>
 * {@code
 *     box = application.messageBox(title, caption,
 *         TMessageBox.Type.OK | TMessageBox.Type.CANCEL);
 *
 *     if (box.getResult() == TMessageBox.OK) {
 *         ... the user pressed OK, do stuff ...
 *     }
 * }
 * </pre>
 *
 */
public class TMessageBox extends TWindow {

    /**
     * Translated strings.
     */
    private static final ResourceBundle i18n = ResourceBundle.getBundle(TMessageBox.class.getName());

    /**
     * Message boxes have these supported types.
     */
    public enum Type {
        /**
         * Show an OK button.
         */
        OK,

        /**
         * Show both OK and Cancel buttons.
         */
        OKCANCEL,

        /**
         * Show both Yes and No buttons.
         */
        YESNO,

        /**
         * Show Yes, No, and Cancel buttons.
         */
        YESNOCANCEL
    };

    /**
     * The type of this message box.
     */
    private Type type;

    /**
     * My buttons.
     */
    private List<TButton> buttons;

    /**
     * Message boxes have these possible results.
     */
    public enum Result {
        /**
         * User clicked "OK".
         */
        OK,

        /**
         * User clicked "Cancel".
         */
        CANCEL,

        /**
         * User clicked "Yes".
         */
        YES,

        /**
         * User clicked "No".
         */
        NO
    };

    /**
     * Which button was clicked: OK, CANCEL, YES, or NO.
     */
    private Result result = Result.OK;

    /**
     * Get the result.
     *
     * @return the result: OK, CANCEL, YES, or NO.
     */
    public final Result getResult() {
        return result;
    }

    /**
     * Public constructor.  The message box will be centered on screen.
     *
     * @param application TApplication that manages this window
     * @param title window title, will be centered along the top border
     * @param caption message to display.  Use embedded newlines to get a
     * multi-line box.
     */
    public TMessageBox(final TApplication application, final String title,
        final String caption) {

        this(application, title, caption, Type.OK, true);
    }

    /**
     * Public constructor.  The message box will be centered on screen.
     *
     * @param application TApplication that manages this window
     * @param title window title, will be centered along the top border
     * @param caption message to display.  Use embedded newlines to get a
     * multi-line box.
     * @param type one of the Type constants.  Default is Type.OK.
     */
    public TMessageBox(final TApplication application, final String title,
        final String caption, final Type type) {

        this(application, title, caption, type, true);
    }

    /**
     * Public constructor.  The message box will be centered on screen.
     *
     * @param application TApplication that manages this window
     * @param title window title, will be centered along the top border
     * @param caption message to display.  Use embedded newlines to get a
     * multi-line box.
     * @param type one of the Type constants.  Default is Type.OK.
     * @param yield if true, yield this Thread.  Subclasses need to set this
     * to false and yield at their end of their constructor intead.
     */
    protected TMessageBox(final TApplication application, final String title,
        final String caption, final Type type, final boolean yield) {

        // Start as 50x50 at (1, 1).  These will be changed later.
        super(application, title, 1, 1, 100, 100, CENTERED | MODAL);

        // Hang onto type so that we can provide more convenience in
        // onKeypress().
        this.type = type;

        // Determine width and height
        String [] lines = caption.split("\n");
        int width = title.length() + 12;
        setHeight(6 + lines.length);
        for (String line: lines) {
            if (line.length() + 4 > width) {
                width = line.length() + 4;
            }
        }
        setWidth(width);
        if (getWidth() > getScreen().getWidth()) {
            setWidth(getScreen().getWidth());
        }
        // Re-center window to get an appropriate (x, y)
        center();

        // Now add my elements
        int lineI = 1;
        for (String line: lines) {
            addLabel(line, 1, lineI, "twindow.background.modal");
            lineI++;
        }

        // The button line
        lineI++;
        buttons = new ArrayList<TButton>();

        int buttonX = 0;

        // Setup button actions
        switch (type) {

        case OK:
            result = Result.OK;
            if (getWidth() < 15) {
                setWidth(15);
            }
            buttonX = (getWidth() - 11) / 2;
            buttons.add(addButton(i18n.getString("okButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.OK;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            break;

        case OKCANCEL:
            result = Result.CANCEL;
            if (getWidth() < 26) {
                setWidth(26);
            }
            buttonX = (getWidth() - 22) / 2;
            buttons.add(addButton(i18n.getString("okButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.OK;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            buttonX += 8 + 4;
            buttons.add(addButton(i18n.getString("cancelButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.CANCEL;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            break;

        case YESNO:
            result = Result.NO;
            if (getWidth() < 20) {
                setWidth(20);
            }
            buttonX = (getWidth() - 16) / 2;
            buttons.add(addButton(i18n.getString("yesButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.YES;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            buttonX += 5 + 4;
            buttons.add(addButton(i18n.getString("noButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.NO;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            break;

        case YESNOCANCEL:
            result = Result.CANCEL;
            if (getWidth() < 31) {
                setWidth(31);
            }
            buttonX = (getWidth() - 27) / 2;
            buttons.add(addButton(i18n.getString("yesButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.YES;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            buttonX += 5 + 4;
            buttons.add(addButton(i18n.getString("noButton"), buttonX, lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.NO;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            buttonX += 4 + 4;
            buttons.add(addButton(i18n.getString("cancelButton"), buttonX,
                    lineI,
                    new TAction() {
                        public void DO() {
                            result = Result.CANCEL;
                            getApplication().closeWindow(TMessageBox.this);
                        }
                    }
                )
            );
            break;

        default:
            throw new IllegalArgumentException("Invalid message box type: " + type);
        }

        // Set the secondaryThread to run me
        getApplication().enableSecondaryEventReceiver(this);

        if (yield) {
            // Yield to the secondary thread.  When I come back from the
            // constructor response will already be set.
            getApplication().yield();
        }
    }

    /**
     * Handle keystrokes.
     *
     * @param keypress keystroke event
     */
    @Override
    public void onKeypress(final TKeypressEvent keypress) {

        if (this instanceof TInputBox) {
            super.onKeypress(keypress);
            return;
        }

        // Some convenience for message boxes: Alt won't be needed for the
        // buttons.
        switch (type) {

        case OK:
            if (keypress.equals(kbO)) {
                buttons.get(0).dispatch();
                return;
            }
            break;

        case OKCANCEL:
            if (keypress.equals(kbO)) {
                buttons.get(0).dispatch();
                return;
            } else if (keypress.equals(kbC)) {
                buttons.get(1).dispatch();
                return;
            }
            break;

        case YESNO:
            if (keypress.equals(kbY)) {
                buttons.get(0).dispatch();
                return;
            } else if (keypress.equals(kbN)) {
                buttons.get(1).dispatch();
                return;
            }
            break;

        case YESNOCANCEL:
            if (keypress.equals(kbY)) {
                buttons.get(0).dispatch();
                return;
            } else if (keypress.equals(kbN)) {
                buttons.get(1).dispatch();
                return;
            } else if (keypress.equals(kbC)) {
                buttons.get(2).dispatch();
                return;
            }
            break;

        default:
            throw new IllegalArgumentException("Invalid message box type: " + type);
        }

        super.onKeypress(keypress);
    }

}
Commit	Line	Data
daa4106c	1	/*
c6940ed9 KL	2	* Jexer - Java Text User Interface
c6940ed9 KL	3	*
e16dda65	4	* The MIT License (MIT)
c6940ed9	5	*
a2018e99	6	* Copyright (C) 2017 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
e16dda65 KL	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	*/
	29	package jexer;
	30
	31	import java.util.ArrayList;
	32	import java.util.List;
339652cc	33	import java.util.ResourceBundle;
c6940ed9	34
91c9a837 KL	35	import jexer.event.TKeypressEvent;
	36	import static jexer.TKeypress.*;
	37
c6940ed9 KL	38	/**
	39	* TMessageBox is a system-modal dialog with buttons for OK, Cancel, Yes, or
	40	* No. Call it like:
	41	*
	42	* <p>
	43	* <pre>
	44	* {@code
	45	* box = application.messageBox(title, caption,
	46	* TMessageBox.Type.OK \| TMessageBox.Type.CANCEL);
	47	*
	48	* if (box.getResult() == TMessageBox.OK) {
	49	* ... the user pressed OK, do stuff ...
	50	* }
	51	* }
	52	* </pre>
	53	*
	54	*/
	55	public class TMessageBox extends TWindow {
	56
339652cc KL	57	/**
	58	* Translated strings.
	59	*/
	60	private static final ResourceBundle i18n = ResourceBundle.getBundle(TMessageBox.class.getName());
	61
c6940ed9 KL	62	/**
	63	* Message boxes have these supported types.
	64	*/
	65	public enum Type {
	66	/**
	67	* Show an OK button.
	68	*/
	69	OK,
	70
	71	/**
	72	* Show both OK and Cancel buttons.
	73	*/
	74	OKCANCEL,
	75
	76	/**
	77	* Show both Yes and No buttons.
	78	*/
	79	YESNO,
	80
	81	/**
	82	* Show Yes, No, and Cancel buttons.
	83	*/
	84	YESNOCANCEL
	85	};
	86
91c9a837 KL	87	/**
	88	* The type of this message box.
	89	*/
	90	private Type type;
	91
	92	/**
	93	* My buttons.
	94	*/
329fd62e	95	private List<TButton> buttons;
91c9a837	96
c6940ed9 KL	97	/**
	98	* Message boxes have these possible results.
	99	*/
	100	public enum Result {
	101	/**
	102	* User clicked "OK".
	103	*/
	104	OK,
	105
	106	/**
	107	* User clicked "Cancel".
	108	*/
	109	CANCEL,
	110
	111	/**
	112	* User clicked "Yes".
	113	*/
	114	YES,
	115
	116	/**
	117	* User clicked "No".
	118	*/
	119	NO
	120	};
	121
c6940ed9 KL	122	/**
	123	* Which button was clicked: OK, CANCEL, YES, or NO.
	124	*/
	125	private Result result = Result.OK;
	126
	127	/**
	128	* Get the result.
	129	*
	130	* @return the result: OK, CANCEL, YES, or NO.
	131	*/
	132	public final Result getResult() {
	133	return result;
	134	}
	135
	136	/**
	137	* Public constructor. The message box will be centered on screen.
	138	*
	139	* @param application TApplication that manages this window
	140	* @param title window title, will be centered along the top border
	141	* @param caption message to display. Use embedded newlines to get a
	142	* multi-line box.
	143	*/
	144	public TMessageBox(final TApplication application, final String title,
	145	final String caption) {
	146
	147	this(application, title, caption, Type.OK, true);
	148	}
	149
	150	/**
	151	* Public constructor. The message box will be centered on screen.
	152	*
	153	* @param application TApplication that manages this window
	154	* @param title window title, will be centered along the top border
	155	* @param caption message to display. Use embedded newlines to get a
	156	* multi-line box.
	157	* @param type one of the Type constants. Default is Type.OK.
	158	*/
	159	public TMessageBox(final TApplication application, final String title,
	160	final String caption, final Type type) {
	161
	162	this(application, title, caption, type, true);
	163	}
	164
	165	/**
	166	* Public constructor. The message box will be centered on screen.
	167	*
	168	* @param application TApplication that manages this window
	169	* @param title window title, will be centered along the top border
	170	* @param caption message to display. Use embedded newlines to get a
	171	* multi-line box.
	172	* @param type one of the Type constants. Default is Type.OK.
	173	* @param yield if true, yield this Thread. Subclasses need to set this
	174	* to false and yield at their end of their constructor intead.
	175	*/
	176	protected TMessageBox(final TApplication application, final String title,
	177	final String caption, final Type type, final boolean yield) {
	178
	179	// Start as 50x50 at (1, 1). These will be changed later.
	180	super(application, title, 1, 1, 100, 100, CENTERED \| MODAL);
	181
91c9a837 KL	182	// Hang onto type so that we can provide more convenience in
	183	// onKeypress().
	184	this.type = type;
	185
c6940ed9 KL	186	// Determine width and height
	187	String [] lines = caption.split("\n");
	188	int width = title.length() + 12;
	189	setHeight(6 + lines.length);
	190	for (String line: lines) {
	191	if (line.length() + 4 > width) {
	192	width = line.length() + 4;
	193	}
	194	}
	195	setWidth(width);
	196	if (getWidth() > getScreen().getWidth()) {
	197	setWidth(getScreen().getWidth());
	198	}
	199	// Re-center window to get an appropriate (x, y)
	200	center();
	201
	202	// Now add my elements
	203	int lineI = 1;
	204	for (String line: lines) {
	205	addLabel(line, 1, lineI, "twindow.background.modal");
	206	lineI++;
	207	}
	208
	209	// The button line
	210	lineI++;
91c9a837	211	buttons = new ArrayList<TButton>();
c6940ed9 KL	212
	213	int buttonX = 0;
	214
	215	// Setup button actions
	216	switch (type) {
	217
	218	case OK:
	219	result = Result.OK;
	220	if (getWidth() < 15) {
	221	setWidth(15);
	222	}
	223	buttonX = (getWidth() - 11) / 2;
339652cc	224	buttons.add(addButton(i18n.getString("okButton"), buttonX, lineI,
c6940ed9 KL	225	new TAction() {
	226	public void DO() {
	227	result = Result.OK;
	228	getApplication().closeWindow(TMessageBox.this);
	229	}
	230	}
	231	)
	232	);
	233	break;
	234
	235	case OKCANCEL:
	236	result = Result.CANCEL;
	237	if (getWidth() < 26) {
	238	setWidth(26);
	239	}
	240	buttonX = (getWidth() - 22) / 2;
339652cc	241	buttons.add(addButton(i18n.getString("okButton"), buttonX, lineI,
c6940ed9 KL	242	new TAction() {
	243	public void DO() {
	244	result = Result.OK;
	245	getApplication().closeWindow(TMessageBox.this);
	246	}
	247	}
	248	)
	249	);
	250	buttonX += 8 + 4;
339652cc	251	buttons.add(addButton(i18n.getString("cancelButton"), buttonX, lineI,
c6940ed9 KL	252	new TAction() {
	253	public void DO() {
	254	result = Result.CANCEL;
	255	getApplication().closeWindow(TMessageBox.this);
	256	}
	257	}
	258	)
	259	);
	260	break;
	261
	262	case YESNO:
	263	result = Result.NO;
	264	if (getWidth() < 20) {
	265	setWidth(20);
	266	}
	267	buttonX = (getWidth() - 16) / 2;
339652cc	268	buttons.add(addButton(i18n.getString("yesButton"), buttonX, lineI,
c6940ed9 KL	269	new TAction() {
	270	public void DO() {
	271	result = Result.YES;
	272	getApplication().closeWindow(TMessageBox.this);
	273	}
	274	}
	275	)
	276	);
	277	buttonX += 5 + 4;
339652cc	278	buttons.add(addButton(i18n.getString("noButton"), buttonX, lineI,
c6940ed9 KL	279	new TAction() {
	280	public void DO() {
	281	result = Result.NO;
	282	getApplication().closeWindow(TMessageBox.this);
	283	}
	284	}
	285	)
	286	);
	287	break;
	288
	289	case YESNOCANCEL:
	290	result = Result.CANCEL;
	291	if (getWidth() < 31) {
	292	setWidth(31);
	293	}
	294	buttonX = (getWidth() - 27) / 2;
339652cc	295	buttons.add(addButton(i18n.getString("yesButton"), buttonX, lineI,
c6940ed9 KL	296	new TAction() {
	297	public void DO() {
	298	result = Result.YES;
	299	getApplication().closeWindow(TMessageBox.this);
	300	}
	301	}
	302	)
	303	);
	304	buttonX += 5 + 4;
339652cc	305	buttons.add(addButton(i18n.getString("noButton"), buttonX, lineI,
c6940ed9 KL	306	new TAction() {
	307	public void DO() {
	308	result = Result.NO;
	309	getApplication().closeWindow(TMessageBox.this);
	310	}
	311	}
	312	)
	313	);
	314	buttonX += 4 + 4;
339652cc KL	315	buttons.add(addButton(i18n.getString("cancelButton"), buttonX,
339652cc KL	316	lineI,
c6940ed9 KL	317	new TAction() {
	318	public void DO() {
	319	result = Result.CANCEL;
	320	getApplication().closeWindow(TMessageBox.this);
	321	}
	322	}
	323	)
	324	);
	325	break;
	326
	327	default:
	328	throw new IllegalArgumentException("Invalid message box type: " + type);
	329	}
	330
	331	// Set the secondaryThread to run me
	332	getApplication().enableSecondaryEventReceiver(this);
	333
	334	if (yield) {
	335	// Yield to the secondary thread. When I come back from the
	336	// constructor response will already be set.
	337	getApplication().yield();
	338	}
	339	}
	340
91c9a837 KL	341	/**
	342	* Handle keystrokes.
	343	*
	344	* @param keypress keystroke event
	345	*/
	346	@Override
	347	public void onKeypress(final TKeypressEvent keypress) {
	348
	349	if (this instanceof TInputBox) {
	350	super.onKeypress(keypress);
	351	return;
	352	}
	353
	354	// Some convenience for message boxes: Alt won't be needed for the
	355	// buttons.
	356	switch (type) {
	357
	358	case OK:
	359	if (keypress.equals(kbO)) {
	360	buttons.get(0).dispatch();
	361	return;
	362	}
	363	break;
	364
	365	case OKCANCEL:
	366	if (keypress.equals(kbO)) {
	367	buttons.get(0).dispatch();
	368	return;
	369	} else if (keypress.equals(kbC)) {
	370	buttons.get(1).dispatch();
	371	return;
	372	}
	373	break;
	374
	375	case YESNO:
	376	if (keypress.equals(kbY)) {
	377	buttons.get(0).dispatch();
	378	return;
	379	} else if (keypress.equals(kbN)) {
	380	buttons.get(1).dispatch();
	381	return;
	382	}
	383	break;
	384
	385	case YESNOCANCEL:
	386	if (keypress.equals(kbY)) {
	387	buttons.get(0).dispatch();
	388	return;
	389	} else if (keypress.equals(kbN)) {
	390	buttons.get(1).dispatch();
	391	return;
	392	} else if (keypress.equals(kbC)) {
	393	buttons.get(2).dispatch();
	394	return;
	395	}
	396	break;
	397
	398	default:
	399	throw new IllegalArgumentException("Invalid message box type: " + type);
	400	}
	401
	402	super.onKeypress(keypress);
	403	}
	404
c6940ed9	405	}