src/jexer/event/TMenuEvent.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.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 class TMenuEvent extends TInputEvent {
  37
  38     // ------------------------------------------------------------------------
  39     // Variables --------------------------------------------------------------
  40     // ------------------------------------------------------------------------
  41
  42     /**
  43      * MenuItem ID.
  44      */
  45     private int id;
  46
  47     // ------------------------------------------------------------------------
  48     // Constructors -----------------------------------------------------------
  49     // ------------------------------------------------------------------------
  50
  51     /**
  52      * Public contructor.
  53      *
  54      * @param id the MenuItem ID
  55      */
  56     public TMenuEvent(final int id) {
  57         this.id = id;
  58     }
  59
  60     // ------------------------------------------------------------------------
  61     // TInputEvent ------------------------------------------------------------
  62     // ------------------------------------------------------------------------
  63
  64     /**
  65      * Make human-readable description of this TMenuEvent.
  66      *
  67      * @return displayable String
  68      */
  69     @Override
  70     public String toString() {
  71         return String.format("MenuEvent: %d", id);
  72     }
  73
  74     // ------------------------------------------------------------------------
  75     // TMenuEvent -------------------------------------------------------------
  76     // ------------------------------------------------------------------------
  77
  78     /**
  79      * Get the MenuItem ID.
  80      *
  81      * @return the ID
  82      */
  83     public int getId() {
  84         return id;
  85     }
  86
  87 }