Merge branch 'upstream-sep2019-tcombo' into subtree
[fanfix.git] / TAction.java
... / ...
CommitLineData
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 */
29package jexer;
30
31/**
32 * A TAction represents a simple action to perform in response to the user.
33 *
34 * @see TButton
35 */
36public abstract class TAction {
37
38 /**
39 * The widget that called this action's DO() method. Note that this
40 * field could be null, for example if executed as a timer action.
41 */
42 public TWidget source;
43
44 /**
45 * An optional bit of data associated with this action.
46 */
47 public Object data;
48
49 /**
50 * Call DO() with source widget set.
51 *
52 * @param source the source widget
53 */
54 public final void DO(final TWidget source) {
55 this.source = source;
56 DO();
57 }
58
59 /**
60 * Call DO() with source widget and data set.
61 *
62 * @param source the source widget
63 * @param data the data
64 */
65 public final void DO(final TWidget source, final Object data) {
66 this.source = source;
67 this.data = data;
68 DO();
69 }
70
71 /**
72 * Various classes will call DO() when they are clicked/selected.
73 */
74 public abstract void DO();
75}