src/jexer/event/TResizeEvent.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2016 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 screen or window resize event.
  33  */
  34 public final class TResizeEvent extends TInputEvent {
  35
  36     /**
  37      * Resize events can be generated for either a total screen resize or a
  38      * widget/window resize.
  39      */
  40     public enum Type {
  41         /**
  42          * The entire screen size changed.
  43          */
  44         SCREEN,
  45
  46         /**
  47          * A widget was resized.
  48          */
  49         WIDGET
  50     }
  51
  52     /**
  53      * The type of resize.
  54      */
  55     private Type type;
  56
  57     /**
  58      * Get resize type.
  59      *
  60      * @return SCREEN or WIDGET
  61      */
  62     public Type getType() {
  63         return type;
  64     }
  65
  66     /**
  67      * New width.
  68      */
  69     private int width;
  70
  71     /**
  72      * Get the new width.
  73      *
  74      * @return width
  75      */
  76     public int getWidth() {
  77         return width;
  78     }
  79
  80     /**
  81      * New height.
  82      */
  83     private int height;
  84
  85     /**
  86      * Get the new height.
  87      *
  88      * @return height
  89      */
  90     public int getHeight() {
  91         return height;
  92     }
  93
  94     /**
  95      * Public contructor.
  96      *
  97      * @param type the Type of resize, Screen or Widget
  98      * @param width the new width
  99      * @param height the new height
 100      */
 101     public TResizeEvent(final Type type, final int width, final int height) {
 102         this.type   = type;
 103         this.width  = width;
 104         this.height = height;
 105     }
 106
 107     /**
 108      * Make human-readable description of this TResizeEvent.
 109      *
 110      * @return displayable String
 111      */
 112     @Override
 113     public String toString() {
 114         return String.format("Resize: %s width = %d height = %d",
 115             type, width, height);
 116     }
 117
 118 }