Package jexer.backend

Class HeadlessBackend

java.lang.Object

jexer.backend.LogicalScreen

jexer.backend.HeadlessBackend

All Implemented Interfaces:

Backend, Screen

public class HeadlessBackend
extends LogicalScreen
implements Backend

HeadlessBackend

Field Summary

Fields inherited from class jexer.backend.LogicalScreen

cursorVisible, cursorX, cursorY, height, logical, physical, reallyCleared, width

Constructor Summary

Constructors

Constructor	Description
HeadlessBackend()	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	flushScreen()	Subclasses must provide an implementation that syncs the logical screen to the physical device.
void	getEvents(java.util.List<TInputEvent> queue)	Subclasses must provide an implementation to get keyboard, mouse, and screen resize events.
Screen	getScreen()	Get a Screen, which displays the text cells to the user.
SessionInfo	getSessionInfo()	Getter for sessionInfo.
boolean	hasEvents()	Check if there are events in the queue.
boolean	isImagesOverText()	Check if backend will support incomplete image fragments over text display.
boolean	isPixelMouse()	Check if backend is reporting pixel-based mouse position.
boolean	isReadOnly()	Check if backend is read-only.
void	reloadOptions()	Reload backend options from System properties.
void	setListener(java.lang.Object listener)	Set listener to a different Object.
void	setMouseStyle(java.lang.String mouseStyle)	Set the mouse pointer (cursor) style.
void	setPixelMouse(boolean pixelMouse)	Set request for backend to report pixel-based mouse position.
void	setReadOnly(boolean readOnly)	Set read-only flag.
void	shutdown()	Subclasses must provide an implementation that closes sockets, restores console, etc.

Methods inherited from class jexer.backend.LogicalScreen

clear, clearPhysical, copySelection, drawBox, drawBox, drawBoxShadow, flushPhysical, getAttrXY, getCharXY, getCharXY, getClipBottom, getClipLeft, getClipRight, getClipTop, getCursorX, getCursorY, getHeight, getOffsetX, getOffsetY, getTextHeight, getTextWidth, getWidth, hideCursor, hLineXY, invertCell, invertCell, isCursorVisible, isDirty, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putCursor, putFullwidthCharXY, putFullwidthCharXY, putFullwidthCharXY, putStringXY, putStringXY, reset, resetClipping, resizeToScreen, setClipBottom, setClipLeft, setClipRight, setClipTop, setDimensions, setHeight, setOffsetX, setOffsetY, setSelection, setTitle, setWidth, snapshot, unsetImageRow, vLineXY

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jexer.backend.Backend

setTitle

Constructor Detail

HeadlessBackend

public HeadlessBackend()

Public constructor.

Method Detail

getSessionInfo

public final SessionInfo getSessionInfo()

Getter for sessionInfo.

Specified by:

getSessionInfo in interface Backend

Returns:

the SessionInfo

getScreen

public Screen getScreen()

Get a Screen, which displays the text cells to the user.

Specified by:

getScreen in interface Backend

Returns:

the Screen

flushScreen

public void flushScreen()

Subclasses must provide an implementation that syncs the logical screen to the physical device.

Specified by:

flushScreen in interface Backend

hasEvents

public boolean hasEvents()

Check if there are events in the queue.

Specified by:

hasEvents in interface Backend

Returns:

if true, getEvents() has something to return to the application

getEvents

public void getEvents(java.util.List<TInputEvent> queue)

Subclasses must provide an implementation to get keyboard, mouse, and screen resize events.

Specified by:

getEvents in interface Backend

Parameters:

queue - list to append new events to

shutdown

public void shutdown()

Subclasses must provide an implementation that closes sockets, restores console, etc.

Specified by:

shutdown in interface Backend

setListener

public void setListener(java.lang.Object listener)

Set listener to a different Object.

Specified by:

setListener in interface Backend

Parameters:

listener - the new listening object that run() wakes up on new input

reloadOptions

public void reloadOptions()

Reload backend options from System properties.

Specified by:

reloadOptions in interface Backend

isReadOnly

public boolean isReadOnly()

Check if backend is read-only. For a HeadlessBackend, this is always false.

Specified by:

isReadOnly in interface Backend

Returns:

true

setReadOnly

public void setReadOnly(boolean readOnly)

Set read-only flag. This does nothing for HeadlessBackend.

Specified by:

setReadOnly in interface Backend

Parameters:

readOnly - ignored

isImagesOverText

public boolean isImagesOverText()

Check if backend will support incomplete image fragments over text display.

Specified by:

isImagesOverText in interface Backend

Returns:

true if images can partially obscure text

isPixelMouse

public boolean isPixelMouse()

Check if backend is reporting pixel-based mouse position.

Specified by:

isPixelMouse in interface Backend

Returns:

true if single-pixel mouse movements are reported

setPixelMouse

public void setPixelMouse(boolean pixelMouse)

Set request for backend to report pixel-based mouse position.

Specified by:

setPixelMouse in interface Backend

Parameters:

pixelMouse - if true, single-pixel mouse movements will be reported, if the backend supports it

setMouseStyle

public void setMouseStyle(java.lang.String mouseStyle)

Set the mouse pointer (cursor) style.

Specified by:

setMouseStyle in interface Backend

Parameters:

mouseStyle - the pointer style string, one of: "default", "none", "hand", "text", "move", or "crosshair"