org.beryx.textio.swing

Class SwingTextTerminal

java.lang.Object

org.beryx.textio.AbstractTextTerminal<SwingTextTerminal>

org.beryx.textio.swing.SwingTextTerminal

All Implemented Interfaces:

TextTerminal<SwingTextTerminal>

public class SwingTextTerminal
extends AbstractTextTerminal<SwingTextTerminal>

A TextTerminal implemented using a JTextPane inside a JFrame.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FONT_SIZE
static Color	DEFAULT_INPUT_COLOR
static Color	DEFAULT_PANE_BACKGROUND
static Color	DEFAULT_PROMPT_COLOR

Fields inherited from class org.beryx.textio.AbstractTextTerminal

DEFAULT_USER_INTERRUPT_KEY, SYSPROP_PROPERTIES_FILE_LOCATION

Constructor Summary

Constructors

Constructor and Description
SwingTextTerminal()

Method Summary

Modifier and Type	Method and Description
void	display()
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.
static Optional<Color>	getColor(String colorName)
JFrame	getFrame()
String	getStyle(org.beryx.textio.swing.SwingTextTerminal.StyleData styleData)
JTextPane	getTextPane()
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<SwingTextTerminal> handler, boolean abortRead) Registers a handler that will be called in response to a user interrupt.
void	setInputBackgroundColor(String colorName)
void	setInputBold(boolean bold)
void	setInputColor(String colorName)
void	setInputFontFamily(String fontFamily)
void	setInputFontSize(int fontSize)
void	setInputItalic(boolean italic)
void	setInputSubscript(boolean subscript)
void	setInputSuperscript(boolean superscript)
void	setInputUnderline(boolean underline)
void	setPaneBackgroundColor(String colorName)
void	setPaneIconFile(String filePath)
void	setPaneIconResource(String res)
void	setPaneIconUrl(String url)
void	setPaneTitle(String newTitle)
void	setPromptBackgroundColor(String colorName)
void	setPromptBold(boolean bold)
void	setPromptColor(String colorName)
void	setPromptFontFamily(String fontFamily)
void	setPromptFontSize(int fontSize)
void	setPromptItalic(boolean italic)
void	setPromptSubscript(boolean subscript)
void	setPromptSuperscript(boolean superscript)
void	setPromptUnderline(boolean underline)
void	setUserInterruptKey(KeyStroke keyStroke)
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

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

Field Detail

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE

See Also:

Constant Field Values

DEFAULT_PANE_BACKGROUND

public static final Color DEFAULT_PANE_BACKGROUND

DEFAULT_PROMPT_COLOR

public static final Color DEFAULT_PROMPT_COLOR

DEFAULT_INPUT_COLOR

public static final Color DEFAULT_INPUT_COLOR

Constructor Detail

SwingTextTerminal

public SwingTextTerminal()

Method Detail

getFrame

public JFrame getFrame()

getTextPane

public JTextPane getTextPane()

read

public String read(boolean masking)

Description copied from interface: TextTerminal

Reads a line of text

Parameters:

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

Returns:

the entered text

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.

println

public void println()

Description copied from interface: TextTerminal

Terminates the current line by writing the line separator string.

display

public void display()

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.

Parameters:

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

registerUserInterruptHandler

public boolean registerUserInterruptHandler(Consumer<SwingTextTerminal> 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.

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.

setUserInterruptKey

public void setUserInterruptKey(KeyStroke keyStroke)

setUserInterruptKey

public void setUserInterruptKey(String keyStroke)

getStyle

public String getStyle(org.beryx.textio.swing.SwingTextTerminal.StyleData styleData)

setPromptColor

public void setPromptColor(String colorName)

setPromptBackgroundColor

public void setPromptBackgroundColor(String colorName)

setPromptFontFamily

public void setPromptFontFamily(String fontFamily)

setPromptFontSize

public void setPromptFontSize(int fontSize)

setPromptBold

public void setPromptBold(boolean bold)

setPromptItalic

public void setPromptItalic(boolean italic)

setPromptUnderline

public void setPromptUnderline(boolean underline)

setPromptSubscript

public void setPromptSubscript(boolean subscript)

setPromptSuperscript

public void setPromptSuperscript(boolean superscript)

setInputColor

public void setInputColor(String colorName)

setInputBackgroundColor

public void setInputBackgroundColor(String colorName)

setInputFontFamily

public void setInputFontFamily(String fontFamily)

setInputFontSize

public void setInputFontSize(int fontSize)

setInputBold

public void setInputBold(boolean bold)

setInputItalic

public void setInputItalic(boolean italic)

setInputUnderline

public void setInputUnderline(boolean underline)

setInputSubscript

public void setInputSubscript(boolean subscript)

setInputSuperscript

public void setInputSuperscript(boolean superscript)

setPaneBackgroundColor

public void setPaneBackgroundColor(String colorName)

setPaneTitle

public void setPaneTitle(String newTitle)

setPaneIconUrl

public void setPaneIconUrl(String url)

setPaneIconFile

public void setPaneIconFile(String filePath)

setPaneIconResource

public void setPaneIconResource(String res)

getColor

public static Optional<Color> getColor(String colorName)