src/jexer/backend/TSessionInfo.java

   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  */
  29 package jexer.backend;
  30
  31 /**
  32  * TSessionInfo provides a default session implementation.  The username is
  33  * blank, language is "en_US", with a 80x24 text window.
  34  */
  35 public class TSessionInfo implements SessionInfo {
  36
  37     // ------------------------------------------------------------------------
  38     // Variables --------------------------------------------------------------
  39     // ------------------------------------------------------------------------
  40
  41     /**
  42      * User name.
  43      */
  44     private String username = "";
  45
  46     /**
  47      * Language.
  48      */
  49     private String language = "en_US";
  50
  51     /**
  52      * Text window width.
  53      */
  54     private int windowWidth = 80;
  55
  56     /**
  57      * Text window height.
  58      */
  59     private int windowHeight = 24;
  60
  61     // ------------------------------------------------------------------------
  62     // Constructors -----------------------------------------------------------
  63     // ------------------------------------------------------------------------
  64
  65     /**
  66      * Public constructor.
  67      */
  68     public TSessionInfo() {
  69         this(80, 24);
  70     }
  71
  72     /**
  73      * Public constructor.
  74      *
  75      * @param width the number of columns
  76      * @param height the number of rows
  77      */
  78     public TSessionInfo(final int width, final int height) {
  79         this.windowWidth        = width;
  80         this.windowHeight       = height;
  81     }
  82
  83     // ------------------------------------------------------------------------
  84     // SessionInfo ------------------------------------------------------------
  85     // ------------------------------------------------------------------------
  86
  87     /**
  88      * Username getter.
  89      *
  90      * @return the username
  91      */
  92     public String getUsername() {
  93         return this.username;
  94     }
  95
  96     /**
  97      * Username setter.
  98      *
  99      * @param username the value
 100      */
 101     public void setUsername(final String username) {
 102         this.username = username;
 103     }
 104
 105     /**
 106      * Language getter.
 107      *
 108      * @return the language
 109      */
 110     public String getLanguage() {
 111         return this.language;
 112     }
 113
 114     /**
 115      * Language setter.
 116      *
 117      * @param language the value
 118      */
 119     public void setLanguage(final String language) {
 120         this.language = language;
 121     }
 122
 123     /**
 124      * Text window width getter.
 125      *
 126      * @return the window width
 127      */
 128     public int getWindowWidth() {
 129         return windowWidth;
 130     }
 131
 132     /**
 133      * Text window height getter.
 134      *
 135      * @return the window height
 136      */
 137     public int getWindowHeight() {
 138         return windowHeight;
 139     }
 140
 141     /**
 142      * Re-query the text window size.
 143      */
 144     public void queryWindowSize() {
 145         // NOP
 146     }
 147
 148 }