Merge branch 'subtree'

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

diff --git a/src/jexer/TAction.java b/src/jexer/TAction.java
index 2ce8a3950ccea15b30025881abab4ff1dbd70ecb..5343143cc223ebfd3fa8702c7ddb3959d1c7b362 100644 (file)
--- a/src/jexer/TAction.java
+++ b/src/jexer/TAction.java
@@ -1,29 +1,27 @@
-/**
+/*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
- *
- * This module is licensed under the GNU Lesser General Public License
- * Version 3.  Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * The MIT License (MIT)
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * 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:
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * 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
@@ -36,9 +34,42 @@ package jexer;
  * @see TButton
  */
 public abstract class TAction {
+
+    /**
+     * The widget that called this action's DO() method.  Note that this
+     * field could be null, for example if executed as a timer action.
+     */
+    public TWidget source;
+
+    /**
+     * An optional bit of data associated with this action.
+     */
+    public Object data;
+
+    /**
+     * Call DO() with source widget set.
+     *
+     * @param source the source widget
+     */
+    public final void DO(final TWidget source) {
+        this.source = source;
+        DO();
+    }
+
+    /**
+     * Call DO() with source widget and data set.
+     *
+     * @param source the source widget
+     * @param data the data
+     */
+    public final void DO(final TWidget source, final Object data) {
+        this.source = source;
+        this.data = data;
+        DO();
+    }
+
     /**
      * Various classes will call DO() when they are clicked/selected.
      */
     public abstract void DO();
 }
-