Uses of Interface
org.jline.terminal.Terminal
-
Packages that use Terminal Package Description org.jline.terminal JLine Terminal API - Core abstractions for terminal operations across different platforms.org.jline.terminal.impl JLine Terminal implementation classes.org.jline.terminal.impl.exec Implementation of terminal functionality using external command-line utilities.org.jline.terminal.spi JLine Terminal Service Provider Interface (SPI).org.jline.utils JLine utility classes. -
-
Uses of Terminal in org.jline.terminal
Methods in org.jline.terminal that return Terminal Modifier and Type Method Description TerminalTerminalBuilder. build()Create and configure a Terminal instance according to this builder's settings.TerminalTerminalBuilder. buildDeferred()Asynchronous variant ofTerminalBuilder.build()that returns aDeferredTerminalimmediately.static TerminalTerminalBuilder. terminal()Returns the default system terminal with automatic configuration.Methods in org.jline.terminal with parameters of type Terminal Modifier and Type Method Description static voidTerminalBuilder. setTerminalOverride(Terminal terminal)Deprecated.This method is deprecated to discourage its use. -
Uses of Terminal in org.jline.terminal.impl
Classes in org.jline.terminal.impl that implement Terminal Modifier and Type Class Description classAbstractPosixTerminalBase implementation for terminals on POSIX-compliant systems.classAbstractTerminalBase implementation of the Terminal interface.classAbstractUnixSysTerminalBase class for flattened POSIX system terminals that bypass the PTY abstraction.classAbstractWindowsTerminal<Console>Base implementation for terminals on Windows systems.classDeferredTerminalATerminalproxy that defers construction to a background thread.classDumbTerminalA minimal terminal implementation with limited capabilities.classExternalTerminalTerminal implementation designed for external connections with embedded line discipline.classLineDisciplineTerminalAbstract terminal with support for line discipline.classPosixPtyTerminalTerminal implementation for POSIX systems using a pseudoterminal (PTY).classPosixSysTerminalTerminal implementation for POSIX systems using system streams.Methods in org.jline.terminal.impl that return Terminal Modifier and Type Method Description TerminalDeferredTerminal. getTerminal()Blocks until the real terminal is ready, then returns it.TerminalDumbTerminalProvider. newTerminal(java.lang.String name, java.lang.String type, java.io.InputStream masterInput, java.io.OutputStream masterOutput, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)TerminalDumbTerminalProvider. sysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)Methods in org.jline.terminal.impl with parameters of type Terminal Modifier and Type Method Description voidKittyGraphics. clearAllImages(Terminal terminal)Clears all images from the terminal.booleanDeferredTerminal. complete(Terminal terminal)voidKittyGraphics. deleteImage(Terminal terminal, int imageId)Deletes an image from the terminal's memory.voidITerm2Graphics. displayBackgroundImage(Terminal terminal, java.awt.image.BufferedImage image, java.lang.String position)Displays an image as a background (non-inline).voidITerm2Graphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image)voidITerm2Graphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image, TerminalGraphics.ImageOptions options)voidITerm2Graphics. displayImage(Terminal terminal, java.io.File file)voidITerm2Graphics. displayImage(Terminal terminal, java.io.File file, TerminalGraphics.ImageOptions options)voidITerm2Graphics. displayImage(Terminal terminal, java.io.InputStream inputStream)voidITerm2Graphics. displayImage(Terminal terminal, java.io.InputStream inputStream, TerminalGraphics.ImageOptions options)voidKittyGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image)voidKittyGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image, TerminalGraphics.ImageOptions options)voidKittyGraphics. displayImage(Terminal terminal, java.io.File file)voidKittyGraphics. displayImage(Terminal terminal, java.io.File file, TerminalGraphics.ImageOptions options)voidKittyGraphics. displayImage(Terminal terminal, java.io.InputStream inputStream)voidKittyGraphics. displayImage(Terminal terminal, java.io.InputStream inputStream, TerminalGraphics.ImageOptions options)voidSixelGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image)voidSixelGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image, int maxWidth, int maxHeight)Displays an image with size constraints.voidSixelGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image, TerminalGraphics.ImageOptions options)voidSixelGraphics. displayImage(Terminal terminal, java.io.File file)voidSixelGraphics. displayImage(Terminal terminal, java.io.File file, TerminalGraphics.ImageOptions options)voidSixelGraphics. displayImage(Terminal terminal, java.io.InputStream inputStream)voidSixelGraphics. displayImage(Terminal terminal, java.io.InputStream inputStream, TerminalGraphics.ImageOptions options)voidTerminalGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image)Displays a BufferedImage on the terminal using this graphics protocol.voidTerminalGraphics. displayImage(Terminal terminal, java.awt.image.BufferedImage image, TerminalGraphics.ImageOptions options)Displays a BufferedImage on the terminal with custom options.voidTerminalGraphics. displayImage(Terminal terminal, java.io.File file)Displays an image file on the terminal.voidTerminalGraphics. displayImage(Terminal terminal, java.io.File file, TerminalGraphics.ImageOptions options)Displays an image file on the terminal with custom options.voidTerminalGraphics. displayImage(Terminal terminal, java.io.InputStream inputStream)Displays an image from an input stream on the terminal.voidTerminalGraphics. displayImage(Terminal terminal, java.io.InputStream inputStream, TerminalGraphics.ImageOptions options)Displays an image from an input stream on the terminal with custom options.static voidTerminalGraphicsManager. displayImage(Terminal terminal, java.awt.image.BufferedImage image)Displays a BufferedImage on the terminal using the best available protocol.static voidTerminalGraphicsManager. displayImage(Terminal terminal, java.awt.image.BufferedImage image, TerminalGraphics.ImageOptions options)Displays a BufferedImage on the terminal with custom options.static voidTerminalGraphicsManager. displayImage(Terminal terminal, java.io.File file)Displays an image file on the terminal using the best available protocol.static voidTerminalGraphicsManager. displayImage(Terminal terminal, java.io.File file, TerminalGraphics.ImageOptions options)Displays an image file on the terminal with custom options.static voidTerminalGraphicsManager. displayImage(Terminal terminal, java.io.InputStream inputStream)Displays an image from an input stream on the terminal using the best available protocol.static voidTerminalGraphicsManager. displayImage(Terminal terminal, java.io.InputStream inputStream, TerminalGraphics.ImageOptions options)Displays an image from an input stream on the terminal with custom options.static voidSixelGraphics. displayImageStatic(Terminal terminal, java.awt.image.BufferedImage image)Displays an image in Sixel format on the terminal.static voidSixelGraphics. displayImageStatic(Terminal terminal, java.io.File file)Displays an image file in Sixel format on the terminal.static voidSixelGraphics. displayImageStatic(Terminal terminal, java.io.InputStream inputStream)Displays an image from an input stream in Sixel format on the terminal.voidITerm2Graphics. displayImageWithPercentageSize(Terminal terminal, java.awt.image.BufferedImage image, int widthPercent, java.lang.Integer heightPercent)Displays an image with percentage-based sizing.static java.util.Optional<TerminalGraphics>TerminalGraphicsManager. getBestProtocol(Terminal terminal)Finds the best graphics protocol for the given terminal.static CursorCursorSupport. getCursorPosition(Terminal terminal, java.util.function.IntConsumer discarded)Gets the current cursor position from the terminal.static java.util.List<TerminalGraphics>TerminalGraphicsManager. getSupportedProtocols(Terminal terminal)Gets all graphics protocols supported by the given terminal.static booleanMouseSupport. hasMouseSupport(Terminal terminal)Checks if the terminal supports mouse tracking.static booleanDoubleSizeCharacters. isDoubleSizeSupported(Terminal terminal)Checks if the terminal supports double-size characters.static booleanTerminalGraphicsManager. isGraphicsSupported(Terminal terminal)Checks if any graphics protocol is supported by the given terminal.static booleanSixelGraphics. isSixelSupported(Terminal terminal)Checks if the terminal supports Sixel graphics.booleanITerm2Graphics. isSupported(Terminal terminal)booleanKittyGraphics. isSupported(Terminal terminal)booleanSixelGraphics. isSupported(Terminal terminal)booleanTerminalGraphics. isSupported(Terminal terminal)Checks if this graphics protocol is supported by the given terminal.static java.lang.String[]MouseSupport. keys(Terminal terminal)Returns a list of key sequences that could be used for mouse events, including the terminal's key_mouse capability if available.static voidDoubleSizeCharacters. printBanner(Terminal terminal, java.lang.String text, char borderChar)Creates a banner with the specified text using double-height characters.static voidDoubleSizeCharacters. printDoubleHeight(Terminal terminal, java.lang.String text)Prints text in double height (both top and bottom halves).static voidDoubleSizeCharacters. printDoubleWidth(Terminal terminal, java.lang.String text)Prints text in double width.static voidDoubleSizeCharacters. printNormal(Terminal terminal, java.lang.String text)Prints text in normal size.static MouseEventMouseSupport. readMouse(Terminal terminal, MouseEvent last)Reads a mouse event from the terminal.static MouseEventMouseSupport. readMouse(Terminal terminal, MouseEvent last, java.lang.String prefix)Reads a mouse event from the terminal with a prefix that has already been consumed.static voidDoubleSizeCharacters. reset(Terminal terminal)Resets the terminal to normal character size.static voidDoubleSizeCharacters. setMode(Terminal terminal, DoubleSizeCharacters.Mode mode)Sets the double-size character mode for the current line.static booleanMouseSupport. trackMouse(Terminal terminal, Terminal.MouseTracking tracking)Enables or disables mouse tracking in the terminal.Method parameters in org.jline.terminal.impl with type arguments of type Terminal Modifier and Type Method Description voidDeferredTerminal. onComplete(java.util.function.Consumer<Terminal> callback)Registers a callback that runs once the real terminal is ready. -
Uses of Terminal in org.jline.terminal.impl.exec
Methods in org.jline.terminal.impl.exec that return Terminal Modifier and Type Method Description TerminalExecTerminalProvider. newTerminal(java.lang.String name, java.lang.String type, java.io.InputStream in, java.io.OutputStream out, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)Creates a new terminal with custom input and output streams.TerminalExecTerminalProvider. posixSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)Creates a terminal connected to a system stream on POSIX systems.TerminalExecTerminalProvider. posixSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset stdinEncoding, java.nio.charset.Charset stdoutEncoding, java.nio.charset.Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)Create a POSIX system terminal backed by the specified system stream.TerminalExecTerminalProvider. sysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused)Creates a terminal connected to a system stream.TerminalExecTerminalProvider. sysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)TerminalExecTerminalProvider. winSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)Creates a terminal connected to a system stream.TerminalExecTerminalProvider. winSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset stdinEncoding, java.nio.charset.Charset stdoutEncoding, java.nio.charset.Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)Create a POSIX-style system terminal for Windows environments that provide a POSIX layer (Cygwin/MSYS); returns null on other Windows variants. -
Uses of Terminal in org.jline.terminal.spi
Subinterfaces of Terminal in org.jline.terminal.spi Modifier and Type Interface Description interfaceTerminalExtExtended Terminal interface that provides access to internal implementation details.Methods in org.jline.terminal.spi that return Terminal Modifier and Type Method Description TerminalTerminalProvider. newTerminal(java.lang.String name, java.lang.String type, java.io.InputStream masterInput, java.io.OutputStream masterOutput, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)Creates a new terminal with custom input and output streams.default TerminalTerminalProvider. sysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused)Creates a terminal connected to the controlling terminal device (/dev/tty).TerminalTerminalProvider. sysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)Creates a terminal connected to a system stream. -
Uses of Terminal in org.jline.utils
Fields in org.jline.utils declared as Terminal Modifier and Type Field Description protected TerminalDisplay. terminalprotected TerminalStatus. terminalMethods in org.jline.utils with parameters of type Terminal Modifier and Type Method Description static intWCWidth. charCountForDisplay(java.lang.CharSequence cs, int index, Terminal terminal)Compute the number of Java chars that form the display unit (code point or grapheme cluster) starting atindexincs.intAttributedCharSequence. columnLength(Terminal terminal)Returns the display width of this attributed string in columns.java.util.List<AttributedString>AttributedCharSequence. columnSplitLength(int columns, boolean includeNewlines, boolean delayLineWrap, Terminal terminal)Deprecated.java.util.List<AttributedString>AttributedCharSequence. columnSplitLength(Terminal terminal, int columns, boolean includeNewlines, boolean delayLineWrap)Splits this attributed string into multiple lines based on column width.AttributedStringAttributedCharSequence. columnSubSequence(int start, int stop, Terminal terminal)Deprecated.AttributedStringAttributedCharSequence. columnSubSequence(Terminal terminal, int start, int stop)Returns a subsequence of this attributed string based on column positions.static AttributedStringAttributedString. fromAnsi(java.lang.String ansi, Terminal terminal)Creates an AttributedString from an ANSI-encoded string, using terminal capabilities.static java.util.Optional<Status>Status. getExistingStatus(Terminal terminal)static StatusStatus. getStatus(Terminal terminal)static StatusStatus. getStatus(Terminal terminal, boolean create)voidAttributedCharSequence. print(Terminal terminal)Prints this attributed string to the specified terminal.voidAttributedCharSequence. println(Terminal terminal)Prints this attributed string to the specified terminal, followed by a line break.java.lang.StringAttributedCharSequence. toAnsi(Terminal terminal)Converts this attributed string to an ANSI escape sequence string appropriate for the specified terminal.static intWCWidth. wcwidthForDisplay(java.lang.CharSequence cs, int index, Terminal terminal)Compute the display width in terminal columns of the character or grapheme cluster that begins at the given index in the character sequence.Constructors in org.jline.utils with parameters of type Terminal Constructor Description ColorPalette(Terminal terminal)ColorPalette(Terminal terminal, java.lang.String distance)Display(Terminal terminal, boolean fullscreen)Create a Display bound to the given Terminal and configured for either full-screen or inline (partial-screen) usage.Status(Terminal terminal)
-