org.beryx.textio.web

Class WebTextTerminal

java.lang.Object

org.beryx.textio.AbstractTextTerminal<WebTextTerminal>

org.beryx.textio.web.WebTextTerminal

All Implemented Interfaces:

TextTerminal<WebTextTerminal>, DataApi

public class WebTextTerminal
extends AbstractTextTerminal<WebTextTerminal>
implements DataApi

A TextTerminal that allows accessing the application via a browser. It works only in conjunction with a web server supporting the DataApi (such as SparkDataServer) and a web component that accesses this API (typically via textterm.js).

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT_HAS_ACTION
static long	DEFAULT_TIMEOUT_NOT_EMPTY

Fields inherited from class org.beryx.textio.AbstractTextTerminal

DEFAULT_USER_INTERRUPT_KEY, SYSPROP_PROPERTIES_FILE_LOCATION

Constructor Summary

Constructors

Constructor and Description
WebTextTerminal()

Method Summary

Modifier and Type	Method and Description
void	abort() This method is typically called when a text-based input/output session has been aborted by the user or when a severe error occurred.
void	addSetting(String key, Object value)
void	addSettings(TextTerminalData.KeyValue... keyValues)
WebTextTerminal	createCopy()
void	dispose(String resultData) This method is typically called at the end of a text-based input/output session in order to allow the terminal to release its screen resources.
TextTerminalData	getTextTerminalData() This method is called by the web component while polling for data
void	postUserInput(String newInput) This method is called by the web component to post the user input
void	postUserInput(String newInput, boolean userInterrupt)
void	postUserInterrupt(String partialInput) This method is called by the web component in response to a user interrupt (typically triggered by typing Ctrl+Q).
void	println() Terminates the current line by writing the line separator string.
void	rawPrint(String message) Prints the message in its raw form.
String	read(boolean masking) Reads a line of text
boolean	registerUserInterruptHandler(Consumer<WebTextTerminal> handler, boolean abortRead) Registers a handler that will be called in response to a user interrupt.
protected void	setAction(TextTerminalData.Action action)
protected void	setAction(TextTerminalData.Action action, String actionData)
void	setOnAbort(Runnable onAbort)
void	setOnDispose(Runnable onDispose)
void	setTimeoutHasAction(long timeoutHasAction)
void	setTimeoutNotEmpty(long timeoutNotEmpty)
void	setUserInterruptKey(int code, boolean ctrl, boolean shift, boolean alt)
void	setUserInterruptKey(String keyStroke)

Methods inherited from class org.beryx.textio.AbstractTextTerminal

addDefaultProperty, getDefaultProperties, getProperties, getPropertiesPrefixes, getPropertiesReader, init, initProperties, initProperties, initProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.beryx.textio.TextTerminal

dispose, print, print, printf, printf, println, println, rawPrint

Field Detail

DEFAULT_TIMEOUT_NOT_EMPTY

public static final long DEFAULT_TIMEOUT_NOT_EMPTY

See Also:

Constant Field Values

DEFAULT_TIMEOUT_HAS_ACTION

public static final long DEFAULT_TIMEOUT_HAS_ACTION

See Also:

Constant Field Values

Constructor Detail

WebTextTerminal

public WebTextTerminal()

Method Detail

setTimeoutNotEmpty

public void setTimeoutNotEmpty(long timeoutNotEmpty)

setTimeoutHasAction

public void setTimeoutHasAction(long timeoutHasAction)

createCopy

public WebTextTerminal createCopy()

dispose

public void dispose(String resultData)

Description copied from interface: TextTerminal

This method is typically called at the end of a text-based input/output session in order to allow the terminal to release its screen resources. The terminal should be able to rebuild the released resources when a print or read method is subsequently called. The default implementation does nothing.

Specified by:

dispose in interface TextTerminal<WebTextTerminal>

Parameters:

resultData - stringified information about the outcome of the input/output session; may be null,

abort

public void abort()

Description copied from interface: TextTerminal

This method is typically called when a text-based input/output session has been aborted by the user or when a severe error occurred. The default implementation does nothing.

Specified by:

abort in interface TextTerminal<WebTextTerminal>

setOnDispose

public void setOnDispose(Runnable onDispose)

setOnAbort

public void setOnAbort(Runnable onAbort)

read

public String read(boolean masking)

Description copied from interface: TextTerminal

Reads a line of text

Specified by:

read in interface TextTerminal<WebTextTerminal>

Parameters:

masking - true, if the input should be masked (for example to enter a password)

Returns:

the entered text

setAction

protected void setAction(TextTerminalData.Action action)

setAction

protected void setAction(TextTerminalData.Action action,
                         String actionData)

rawPrint

public void rawPrint(String message)

Description copied from interface: TextTerminal

Prints the message in its raw form. This method expects a single line of text. The behavior is undefined if the string contains line separators.

Specified by:

rawPrint in interface TextTerminal<WebTextTerminal>

println

public void println()

Description copied from interface: TextTerminal

Terminates the current line by writing the line separator string.

Specified by:

println in interface TextTerminal<WebTextTerminal>

registerUserInterruptHandler

public boolean registerUserInterruptHandler(Consumer<WebTextTerminal> handler,
                                            boolean abortRead)

Description copied from interface: TextTerminal

Registers a handler that will be called in response to a user interrupt. The event that triggers a user interrupt is usually Ctrl+C, but in general it is terminal specific. For example, a Swing based terminal may send a user interrupt when the X close button of its window is hit. If a terminal is not able to register user interrupt handlers, it should return false.

Specified by:

registerUserInterruptHandler in interface TextTerminal<WebTextTerminal>

Parameters:

handler - the action to be performed in response to a user interrupt.

abortRead - true, if the current read operation should be aborted on user interrupt.

Returns:

true, if the handler has been registered; false, otherwise.

getTextTerminalData

public TextTerminalData getTextTerminalData()

Description copied from interface: DataApi

This method is called by the web component while polling for data

Specified by:

getTextTerminalData in interface DataApi

postUserInput

public void postUserInput(String newInput,
                          boolean userInterrupt)

postUserInput

public void postUserInput(String newInput)

Description copied from interface: DataApi

This method is called by the web component to post the user input

Specified by:

postUserInput in interface DataApi

postUserInterrupt

public void postUserInterrupt(String partialInput)

Description copied from interface: DataApi

This method is called by the web component in response to a user interrupt (typically triggered by typing Ctrl+Q).

Specified by:

postUserInterrupt in interface DataApi

Parameters:

partialInput - the partially entered input when the user interrupt occurred.

setUserInterruptKey

public void setUserInterruptKey(String keyStroke)

addSetting

public void addSetting(String key,
                       Object value)

addSettings

public void addSettings(TextTerminalData.KeyValue... keyValues)

setUserInterruptKey

public void setUserInterruptKey(int code,
                                boolean ctrl,
                                boolean shift,
                                boolean alt)