public interface IOSafeTerminal extends Terminal
Modifier and Type | Method and Description |
---|---|
void |
clearScreen()
Removes all the characters, colors and graphics from the screen and leaves you with a big empty space.
|
void |
disableSGR(SGR sgr)
Deactivates an
SGR (Selected Graphic Rendition) code which has previously been activated through enableSGR(..) . |
void |
enableSGR(SGR sgr)
Activates an
SGR (Selected Graphic Rendition) code. |
byte[] |
enquireTerminal(int timeout,
TimeUnit timeoutUnit)
Retrieves optional information from the terminal by printing the ENQ (\u005) character.
|
void |
enterPrivateMode()
Calling this method will, where supported, give your terminal a private area to use, separate from what was there
before.
|
void |
exitPrivateMode()
If you have previously entered private mode, this method will exit this and, depending on implementation, maybe
restore what the terminal looked like before private mode was entered.
|
void |
flush()
Calls
flush() on the underlying OutputStream object, or whatever other implementation this
terminal is built around. |
TerminalSize |
getTerminalSize()
Returns the size of the terminal, expressed as a
TerminalSize object. |
KeyStroke |
pollInput()
Returns the next
Key off the input queue or null if there is no more input events available. |
void |
putCharacter(char c)
Prints one character to the terminal at the current cursor location.
|
KeyStroke |
readInput()
Returns the next
Key off the input queue or blocks until one is available. |
void |
resetColorAndSGR()
Removes all currently active SGR codes and sets foreground and background colors back to default.
|
void |
setBackgroundColor(TextColor color)
Changes the background color for all the following characters put to the terminal.
|
void |
setCursorPosition(int x,
int y)
Moves the text cursor to a new location on the terminal.
|
void |
setCursorVisible(boolean visible)
Hides or shows the text cursor, but not all terminal (-emulators) supports this.
|
void |
setForegroundColor(TextColor color)
Changes the foreground color for all the following characters put to the terminal.
|
addResizeListener, newTextGraphics, removeResizeListener
void enterPrivateMode()
Terminal
enterPrivateMode
in interface Terminal
void exitPrivateMode()
Terminal
exitPrivateMode
in interface Terminal
void clearScreen()
Terminal
moveCursor
next. Some terminal implementations doesn't reset color and modifier state so it's also good
practise to call resetColorAndSGR()
after this.clearScreen
in interface Terminal
void setCursorPosition(int x, int y)
Terminal
setCursorPosition
in interface Terminal
x
- The 0-indexed column to place the cursor aty
- The 0-indexed row to place the cursor atvoid setCursorVisible(boolean visible)
Terminal
setCursorVisible
in interface Terminal
visible
- Hides the text cursor if false
and shows it if true
void putCharacter(char c)
Terminal
putCharacter
will print out a text string without the need
to reposition the text cursor. If you reach the end of the line while putting characters using this method, you
can expect the text cursor to move to the beginning of the next line.
You can output CJK (Chinese, Japanese, Korean) characters (as well as other regional scripts) but remember that the terminal that the user is using might not have the required font to render it. Also worth noticing is that CJK (and some others) characters tend to take up 2 columns per character, simply because they are a square in their construction as opposed to the somewhat rectangular shape we fit latin characters in. As it's very difficult to create a monospace font for CJK with a 2:1 height-width proportion, it seems like the implementers back in the days simply gave up and made each character take 2 column. It causes issues for the random terminal programmer because you can't really trust 1 character = 1 column, but I suppose it's "しょうがない".
putCharacter
in interface Terminal
c
- Character to place on the terminalvoid enableSGR(SGR sgr)
Terminal
SGR
(Selected Graphic Rendition) code. This code modifies a state inside the terminal
that will apply to all characters written afterwards, such as bold, italic, blinking code and so on.enableSGR
in interface Terminal
sgr
- SGR code to applySGR
,
http://www.vt100.net/docs/vt510-rm/SGRvoid disableSGR(SGR sgr)
Terminal
SGR
(Selected Graphic Rendition) code which has previously been activated through enableSGR(..)
.disableSGR
in interface Terminal
sgr
- SGR code to applySGR
,
http://www.vt100.net/docs/vt510-rm/SGRvoid resetColorAndSGR()
Terminal
resetColorAndSGR
in interface Terminal
SGR
,
http://www.vt100.net/docs/vt510-rm/SGRvoid setForegroundColor(TextColor color)
Terminal
This overload is using the TextColor class to define a color, which is a layer of abstraction above the three different color formats supported (ANSI, indexed and RGB). The other setForegroundColor(..) overloads gives you direct access to set one of those three.
Note to implementers of this interface, just make this method call color.applyAsForeground(this);
setForegroundColor
in interface Terminal
color
- Color to use for foregroundvoid setBackgroundColor(TextColor color)
Terminal
This overload is using the TextColor class to define a color, which is a layer of abstraction above the three different color formats supported (ANSI, indexed and RGB). The other setBackgroundColor(..) overloads gives you direct access to set one of those three.
Note to implementers of this interface, just make this method call color.applyAsBackground(this);
setBackgroundColor
in interface Terminal
color
- Color to use for the backgroundTerminalSize getTerminalSize()
Terminal
TerminalSize
object. Please bear in mind that depending
on the Terminal
implementation, this may or may not be accurate. See the implementing classes for more
information. Most commonly, calling getTerminalSize() will involve some kind of hack to retrieve the size of the
terminal, like moving the cursor to position 5000x5000 and then read back the location, unless the terminal
implementation has a more smooth way of getting this data. Keep this in mind and see if you can avoid calling
this method too often. There is a helper class, SimpleTerminalResizeListener, that you can use to cache the size
and update it only when resize events are received (which depends on if a resize is detectable, which they are not
on all platforms).getTerminalSize
in interface Terminal
byte[] enquireTerminal(int timeout, TimeUnit timeoutUnit)
Terminal
enquireTerminal
in interface Terminal
timeout
- How long to wait for the talk-back message, if there's nothing immediately available on the input
stream, you should probably set this to a somewhat small value to prevent unnecessary blockage on the input stream
but large enough to accommodate a round-trip to the user's terminal (~300 ms if you are connection across the globe).timeoutUnit
- What unit to use when interpreting the timeout
parametervoid flush()
Terminal
flush()
on the underlying OutputStream
object, or whatever other implementation this
terminal is built around. Some implementing classes of this interface (like SwingTerminal) doesn't do anything
as it doesn't really apply to them.KeyStroke pollInput()
InputProvider
Key
off the input queue or null if there is no more input events available. Note, this
method call is not blocking, it returns null immediately if there is nothing on the input stream.pollInput
in interface InputProvider
KeyStroke readInput() throws IOException
InputProvider
Key
off the input queue or blocks until one is available. NOTE: In previous
versions of Lanterna, this method was not blocking. From lanterna 3, it is blocking and you can call
pollInput()
for the non-blocking version.readInput
in interface InputProvider
IOException
- Propagated error if the underlying stream gave errorsCopyright © 2016. All rights reserved.