Merge commit '77d3a60869e7a780c6ae069e51530e1eacece5e2'

[fanfix.git] / src / jexer / event / TResizeEvent.java

diff --git a/src/jexer/event/TResizeEvent.java b/src/jexer/event/TResizeEvent.java
index 101b8f3bd96ced30bb5413b0a905efeda87a4e2d..ff9571084232f1891258c1b0af02758f231fabb1 100644 (file)
--- a/src/jexer/event/TResizeEvent.java
+++ b/src/jexer/event/TResizeEvent.java
@@ -1,34 +1,30 @@
-/**
+/*
  * Jexer - Java Text User Interface
  *
- * Version: $Id$
- *
- * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
- *
- * License: LGPLv3 or later
+ * The MIT License (MIT)
  *
- * Copyright: 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.
+ * Copyright (C) 2019 Kevin Lamonte
  *
- *     Copyright (C) 2015  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:
  *
- * 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * 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 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.
  *
- * 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
+ * @author Kevin Lamonte [kevin.lamonte@gmail.com]
+ * @version 1
  */
 package jexer.event;
 
@@ -37,50 +33,102 @@ package jexer.event;
  */
 public class TResizeEvent extends TInputEvent {
 
+    // ------------------------------------------------------------------------
+    // Constants --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Resize events can be generated for either a total screen resize or a
      * widget/window resize.
      */
     public enum Type {
-       Screen,
-       Widget
+        /**
+         * The entire screen size changed.
+         */
+        SCREEN,
+
+        /**
+         * A widget was resized.
+         */
+        WIDGET
     }
 
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
-     * The type of resize
+     * The type of resize.
      */
-    public Type type;
+    private Type type;
 
     /**
-     * New width
+     * New width.
      */
-    public int width;
+    private int width;
 
     /**
-     * New height
+     * New height.
      */
-    public int height;
+    private int height;
+
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
-     * Public contructor
+     * Public contructor.
      *
      * @param type the Type of resize, Screen or Widget
      * @param width the new width
      * @param height the new height
      */
-    public TResizeEvent(Type type, int width, int height) {
-       this.type   = type;
-       this.width  = width;
-       this.height = height;
+    public TResizeEvent(final Type type, final int width, final int height) {
+        this.type   = type;
+        this.width  = width;
+        this.height = height;
+    }
+
+    // ------------------------------------------------------------------------
+    // TResizeEvent -----------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Get resize type.
+     *
+     * @return SCREEN or WIDGET
+     */
+    public Type getType() {
+        return type;
+    }
+
+    /**
+     * Get the new width.
+     *
+     * @return width
+     */
+    public int getWidth() {
+        return width;
     }
 
     /**
-     * Make human-readable description of this event
+     * Get the new height.
+     *
+     * @return height
+     */
+    public int getHeight() {
+        return height;
+    }
+
+    /**
+     * Make human-readable description of this TResizeEvent.
+     *
+     * @return displayable String
      */
     @Override
     public String toString() {
-       return String.format("Resize: %s width = %d height = %d",
-           type, width, height);
+        return String.format("Resize: %s width = %d height = %d",
+            type, width, height);
     }
 
 }