src/jexer/backend/GenericBackend.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2017 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 import java.util.List;
  32
  33 import jexer.event.TInputEvent;
  34
  35 /**
  36  * This abstract class provides a screen, keyboard, and mouse to
  37  * TApplication.  It also exposes session information as gleaned from lower
  38  * levels of the communication stack.
  39  */
  40 public abstract class GenericBackend implements Backend {
  41
  42     /**
  43      * The session information.
  44      */
  45     protected SessionInfo sessionInfo;
  46
  47     /**
  48      * Getter for sessionInfo.
  49      *
  50      * @return the SessionInfo
  51      */
  52     public final SessionInfo getSessionInfo() {
  53         return sessionInfo;
  54     }
  55
  56     /**
  57      * The screen to draw on.
  58      */
  59     protected Screen screen;
  60
  61     /**
  62      * Getter for screen.
  63      *
  64      * @return the Screen
  65      */
  66     public final Screen getScreen() {
  67         return screen;
  68     }
  69
  70     /**
  71      * Subclasses must provide an implementation that syncs the logical
  72      * screen to the physical device.
  73      */
  74     public abstract void flushScreen();
  75
  76     /**
  77      * Subclasses must provide an implementation to get keyboard, mouse, and
  78      * screen resize events.
  79      *
  80      * @param queue list to append new events to
  81      */
  82     public abstract void getEvents(List<TInputEvent> queue);
  83
  84     /**
  85      * Subclasses must provide an implementation that closes sockets,
  86      * restores console, etc.
  87      */
  88     public abstract void shutdown();
  89
  90     /**
  91      * Subclasses must provide an implementation that sets the window title.
  92      *
  93      * @param title the new title
  94      */
  95     public abstract void setTitle(final String title);
  96
  97 }