Commit | Line | Data |
---|---|---|
daa4106c | 1 | /* |
df8de03f KL |
2 | * Jexer - Java Text User Interface |
3 | * | |
e16dda65 | 4 | * The MIT License (MIT) |
df8de03f | 5 | * |
a2018e99 | 6 | * Copyright (C) 2017 Kevin Lamonte |
df8de03f | 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: | |
df8de03f | 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. | |
df8de03f | 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. | |
7b5261bc KL |
25 | * |
26 | * @author Kevin Lamonte [kevin.lamonte@gmail.com] | |
27 | * @version 1 | |
df8de03f KL |
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 | */ | |
d4a29741 | 36 | public final class TMenuEvent extends TInputEvent { |
df8de03f KL |
37 | |
38 | /** | |
7b5261bc KL |
39 | * MenuItem ID. |
40 | */ | |
928811d8 | 41 | private int id; |
7b5261bc KL |
42 | |
43 | /** | |
44 | * Get the MenuItem ID. | |
45 | * | |
46 | * @return the ID | |
df8de03f | 47 | */ |
928811d8 | 48 | public int getId() { |
7b5261bc KL |
49 | return id; |
50 | } | |
df8de03f KL |
51 | |
52 | /** | |
7b5261bc | 53 | * Public contructor. |
df8de03f KL |
54 | * |
55 | * @param id the MenuItem ID | |
56 | */ | |
928811d8 | 57 | public TMenuEvent(final int id) { |
7b5261bc | 58 | this.id = id; |
df8de03f KL |
59 | } |
60 | ||
61 | /** | |
7b5261bc KL |
62 | * Make human-readable description of this TMenuEvent. |
63 | * | |
64 | * @return displayable String | |
df8de03f KL |
65 | */ |
66 | @Override | |
d4a29741 | 67 | public String toString() { |
7b5261bc | 68 | return String.format("MenuEvent: %d", id); |
df8de03f KL |
69 | } |
70 | } |