[nikiroo-utils.git] / src / jexer / event / TMenuEvent.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.event;

/**
 * This class encapsulates a menu selection event.
 * TApplication.getMenuItem(id) can be used to obtain the TMenuItem itself,
 * say for setting enabled/disabled/checked/etc.
 */
public final class TMenuEvent extends TInputEvent {

    /**
     * MenuItem ID.
     */
    private int id;

    /**
     * Get the MenuItem ID.
     *
     * @return the ID
     */
    public int getId() {
        return id;
    }

    /**
     * Public contructor.
     *
     * @param id the MenuItem ID
     */
    public TMenuEvent(final int id) {
        this.id = id;
    }

    /**
     * Make human-readable description of this TMenuEvent.
     *
     * @return displayable String
     */
    @Override
    public String toString() {
        return String.format("MenuEvent: %d", id);
    }
}
Commit	Line	Data
	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.event;
	30
	31	/**
	32	* This class encapsulates a menu selection event.
	33	* TApplication.getMenuItem(id) can be used to obtain the TMenuItem itself,
	34	* say for setting enabled/disabled/checked/etc.
	35	*/
	36	public final class TMenuEvent extends TInputEvent {
	37
	38	/**
	39	* MenuItem ID.
	40	*/
	41	private int id;
	42
	43	/**
	44	* Get the MenuItem ID.
	45	*
	46	* @return the ID
	47	*/
	48	public int getId() {
	49	return id;
	50	}
	51
	52	/**
	53	* Public contructor.
	54	*
	55	* @param id the MenuItem ID
	56	*/
	57	public TMenuEvent(final int id) {
	58	this.id = id;
	59	}
	60
	61	/**
	62	* Make human-readable description of this TMenuEvent.
	63	*
	64	* @return displayable String
	65	*/
	66	@Override
	67	public String toString() {
	68	return String.format("MenuEvent: %d", id);
	69	}
	70	}