-/**
+/*
* 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
import java.util.List;
import jexer.event.TInputEvent;
-import jexer.io.Screen;
-import jexer.session.SessionInfo;
/**
- * This abstract class provides a screen, keyboard, and mouse to
- * TApplication. It also exposes session information as gleaned from lower
- * levels of the communication stack.
+ * This interface provides a screen, keyboard, and mouse to TApplication. It
+ * also exposes session information as gleaned from lower levels of the
+ * communication stack.
*/
-public abstract class Backend {
+public interface Backend {
/**
- * The session information.
+ * Get a SessionInfo, which exposes text width/height, language,
+ * username, and other information from the communication stack.
+ *
+ * @return the SessionInfo
*/
- protected SessionInfo sessionInfo;
+ public SessionInfo getSessionInfo();
/**
- * Getter for sessionInfo.
+ * Get a Screen, which displays the text cells to the user.
*
- * @return the SessionInfo
+ * @return the Screen
*/
- public final SessionInfo getSessionInfo() {
- return sessionInfo;
- }
+ public Screen getScreen();
/**
- * The screen to draw on.
+ * Classes must provide an implementation that syncs the logical screen
+ * to the physical device.
*/
- protected Screen screen;
+ public void flushScreen();
/**
- * Getter for screen.
+ * Check if there are events in the queue.
*
- * @return the Screen
+ * @return if true, getEvents() has something to return to the application
*/
- public final Screen getScreen() {
- return screen;
- }
+ public boolean hasEvents();
/**
- * Subclasses must provide an implementation that syncs the logical
- * screen to the physical device.
+ * Classes must provide an implementation to get keyboard, mouse, and
+ * screen resize events.
+ *
+ * @param queue list to append new events to
*/
- public abstract void flushScreen();
+ public void getEvents(List<TInputEvent> queue);
/**
- * Subclasses must provide an implementation to get keyboard, mouse, and
- * screen resize events.
+ * Classes must provide an implementation that closes sockets, restores
+ * console, etc.
+ */
+ public void shutdown();
+
+ /**
+ * Classes must provide an implementation that sets the window title.
*
- * @param queue list to append new events to
- * @param timeout maximum amount of time (in millis) to wait for an
- * event. 0 means to return immediately, i.e. perform a poll.
+ * @param title the new title
+ */
+ public void setTitle(final String title);
+
+ /**
+ * Set listener to a different Object.
+ *
+ * @param listener the new listening object that run() wakes up on new
+ * input
*/
- public abstract void getEvents(List<TInputEvent> queue, int timeout);
+ public void setListener(final Object listener);
/**
- * Subclasses must provide an implementation that closes sockets,
- * restores console, etc.
+ * Reload backend options from System properties.
*/
- public abstract void shutdown();
+ public void reloadOptions();
}