Uses of Class
org.jline.utils.AttributedString

Packages that use AttributedString

Package	Description
org.jline.builtins	JLine Builtins provides a collection of utility classes and implementations for common terminal functionality.
org.jline.console	JLine Console package provides a framework for building interactive command-line applications.
org.jline.console.impl
org.jline.reader	JLine 3 Reader Package - Core components for building interactive command-line interfaces.
org.jline.reader.impl	JLine 3 Reader Implementation Package.
org.jline.shell	Clean shell API for building interactive command-line applications with JLine.
org.jline.shell.impl	Default implementations of the shell API interfaces.
org.jline.shell.widget	Widgets for the JLine shell API.
org.jline.style	JLine Style package provides a comprehensive styling system for terminal output.
org.jline.utils	JLine utility classes.
org.jline.widget	JLine Widget package provides a framework for creating and managing widgets for JLine's LineReader.

Uses of AttributedString in org.jline.builtins

Fields in org.jline.builtins with type parameters of type AttributedString

Modifier and Type	Field	Description
protected List<AttributedString>	Less.lines

Methods in org.jline.builtins that return AttributedString

Modifier and Type	Method	Description
static AttributedString	Options.HelpException.highlight(String msg, StyleResolver resolver)
AttributedString	SyntaxHighlighter.highlight(String string)
AttributedString	SyntaxHighlighter.highlight(AttributedString attributedString)
AttributedString	SyntaxHighlighter.highlight(AttributedStringBuilder asb)
static AttributedString	Options.HelpException.highlightComment(String comment, StyleResolver resolver)
static AttributedString	Options.HelpException.highlightSyntax(String syntax, StyleResolver resolver)
static AttributedString	Options.HelpException.highlightSyntax(String syntax, StyleResolver resolver, boolean subcommands)

Methods in org.jline.builtins that return types with arguments of type AttributedString

Modifier and Type	Method	Description
protected List<AttributedString>	Nano.computeFooter()
protected LinkedHashMap<AttributedString,List<AttributedString>>	Nano.computeSuggestions()	Initializes the suggestions map.
protected LinkedHashMap<AttributedString,List<AttributedString>>	Nano.computeSuggestions()	Initializes the suggestions map.

Methods in org.jline.builtins with parameters of type AttributedString

Modifier and Type	Method	Description
AttributedString	SyntaxHighlighter.highlight(AttributedString attributedString)

Uses of AttributedString in org.jline.console

Methods in org.jline.console that return AttributedString

Modifier and Type	Method	Description
AttributedString	CmdDesc.optionDescription(String key)	Deprecated. Returns the description of the specified option.

Methods in org.jline.console that return types with arguments of type AttributedString

Modifier and Type	Method	Description
List<AttributedString>	ArgDesc.getDescription()	Deprecated. Returns the description of the argument as a list of attributed strings.
List<AttributedString>	CmdDesc.getMainDesc()	Deprecated. Returns the main description of the command.
TreeMap<String,List<AttributedString>>	CmdDesc.getOptsDesc()	Deprecated. Returns the descriptions of the command's options.

Method parameters in org.jline.console with type arguments of type AttributedString

Modifier and Type	Method	Description
CmdDesc	CmdDesc.mainDesc(List<AttributedString> mainDesc)	Deprecated. Sets the main description of the command and returns this command description.
void	CmdDesc.setMainDesc(List<AttributedString> mainDesc)	Deprecated. Sets the main description of the command.

Constructor parameters in org.jline.console with type arguments of type AttributedString

Modifier	Constructor	Description
	ArgDesc(String name, List<AttributedString> description)	Deprecated. Creates a new argument description with the specified name and description.
	CmdDesc(List<ArgDesc> argsDesc, Map<String,List<AttributedString>> optsDesc)	Deprecated. Creates a new command description with the specified argument and option descriptions.
	CmdDesc(List<AttributedString> mainDesc, List<ArgDesc> argsDesc, Map<String,List<AttributedString>> optsDesc)	Deprecated. Creates a new command description with the specified main description, argument descriptions, and option descriptions.
	CmdDesc(List<AttributedString> mainDesc, List<ArgDesc> argsDesc, Map<String,List<AttributedString>> optsDesc)	Deprecated. Creates a new command description with the specified main description, argument descriptions, and option descriptions.

Uses of AttributedString in org.jline.console.impl

Methods in org.jline.console.impl that return AttributedString

Modifier and Type	Method	Description
protected AttributedString	SystemHighlighter.doCommandHighlight(String buffer)
protected AttributedString	SystemHighlighter.doFileArgsHighlight(LineReader reader, String buffer, List<String> words, SystemHighlighter.FileHighlightCommand fhc)
protected AttributedString	SystemHighlighter.doFileOptsHighlight(LineReader reader, String buffer, List<String> words, SystemHighlighter.FileHighlightCommand fhc)
AttributedString	SystemHighlighter.highlight(LineReader reader, String buffer)
protected AttributedString	SystemHighlighter.systemHighlight(LineReader reader, String buffer)

Method parameters in org.jline.console.impl with type arguments of type AttributedString

Modifier and Type	Method	Description
void	DefaultPrinter.setHighlightValue(Map<String,Function<Object,AttributedString>> highlightValue)	Highlight column value

Uses of AttributedString in org.jline.reader

Methods in org.jline.reader that return AttributedString

Modifier and Type	Method	Description
AttributedString	Highlighter.highlight(LineReader reader, String buffer)	Highlights the provided text buffer with appropriate styling.

Methods in org.jline.reader with parameters of type AttributedString

Modifier and Type	Method	Description
void	LineReader.printAbove(AttributedString str)	Prints a string before the prompt and redraw everything.

Uses of AttributedString in org.jline.reader.impl

Fields in org.jline.reader.impl declared as AttributedString

Modifier and Type	Field	Description
protected AttributedString	LineReaderImpl.prompt
protected AttributedString	LineReaderImpl.rightPrompt

Fields in org.jline.reader.impl with type parameters of type AttributedString

Modifier and Type	Field	Description
protected Supplier<AttributedString>	LineReaderImpl.post

Methods in org.jline.reader.impl that return AttributedString

Modifier and Type	Method	Description
AttributedString	LineReaderImpl.getDisplayedBufferWithPrompts(List<AttributedString> secondaryPrompts)	Compute the full string to be displayed with the left, right and secondary prompts
AttributedString	DefaultHighlighter.highlight(LineReader reader, String buffer)

Methods in org.jline.reader.impl with parameters of type AttributedString

Modifier and Type	Method	Description
void	LineReaderImpl.printAbove(AttributedString str)

Method parameters in org.jline.reader.impl with type arguments of type AttributedString

Modifier and Type	Method	Description
AttributedString	LineReaderImpl.getDisplayedBufferWithPrompts(List<AttributedString> secondaryPrompts)	Compute the full string to be displayed with the left, right and secondary prompts

Constructors in org.jline.reader.impl with parameters of type AttributedString

Modifier	Constructor	Description
	PostResult(AttributedString post, int lines, int selectedLine)
	PostResult(AttributedString post, int lines, int selectedLine, int columns)

Uses of AttributedString in org.jline.shell

Methods in org.jline.shell that return AttributedString

Modifier and Type	Method	Description
AttributedString	CommandDescription.optionDescription(String key)	Returns the first line of description for the specified option key.

Methods in org.jline.shell that return types with arguments of type AttributedString

Modifier and Type	Method	Description
List<AttributedString>	ArgumentDescription.description()	Returns the argument description lines.
List<AttributedString>	CommandDescription.mainDescription()	Returns the main description lines.
Map<String,List<AttributedString>>	CommandDescription.options()	Returns the option descriptions, keyed by option syntax.

Method parameters in org.jline.shell with type arguments of type AttributedString

Modifier and Type	Method	Description
CommandDescription.Builder	CommandDescription.Builder.mainDescription(List<AttributedString> mainDescription)	Sets the main description.
CommandDescription.Builder	CommandDescription.Builder.option(String key, List<AttributedString> description)	Adds an option with its description.
CommandDescription.Builder	CommandDescription.Builder.options(Map<String,List<AttributedString>> options)	Sets all options.

Constructor parameters in org.jline.shell with type arguments of type AttributedString

Modifier	Constructor	Description
	ArgumentDescription(String name, List<AttributedString> description)	Creates a new argument description with the specified name and description.

Uses of AttributedString in org.jline.shell.impl

Methods in org.jline.shell.impl that return AttributedString

Modifier and Type	Method	Description
AttributedString	CommandHighlighter.highlight(LineReader reader, String buffer)

Uses of AttributedString in org.jline.shell.widget

Method parameters in org.jline.shell.widget with type arguments of type AttributedString

Modifier and Type	Method	Description
void	CommandTailTipWidgets.setSyntaxHighlighter(Function<AttributedString,AttributedString> highlighter)	Sets a function to highlight syntax in description text.
void	CommandTailTipWidgets.setSyntaxHighlighter(Function<AttributedString,AttributedString> highlighter)	Sets a function to highlight syntax in description text.

Uses of AttributedString in org.jline.style

Methods in org.jline.style that return AttributedString

Modifier and Type	Method	Description
AttributedString	StyleExpression.evaluate(String expression)	Evaluates a style expression and returns the result as an AttributedString.
AttributedString	StyleFactory.evaluate(String expression)	Evaluates a style expression and returns the result as an AttributedString.
AttributedString	StyleFactory.evaluate(String format, Object... params)	Evaluates a style expression with formatting and returns the result as an AttributedString.
AttributedString	StyleFactory.style(String style, String value)	Creates a styled string by applying the specified style to the given value.
AttributedString	StyleFactory.style(String style, String format, Object... params)	Creates a styled string by applying the specified style to a formatted value.

Uses of AttributedString in org.jline.utils

Fields in org.jline.utils declared as AttributedString

Modifier and Type	Field	Description
protected AttributedString	Status.borderString
static final AttributedString	AttributedString.EMPTY	An empty AttributedString with no characters.
static final AttributedString	AttributedString.NEWLINE	An AttributedString containing only a newline character.
final AttributedString	DiffHelper.Diff.text	The text associated with this diff operation.

Fields in org.jline.utils with type parameters of type AttributedString

Modifier and Type	Field	Description
protected List<AttributedString>	Status.lines
protected final List<AttributedString>	Display.oldLines

Methods in org.jline.utils that return AttributedString

Modifier and Type	Method	Description
static AttributedString	AttributedStringBuilder.append(CharSequence... strings)	Creates an AttributedString by appending multiple character sequences.
AttributedString	AttributedCharSequence.columnSubSequence(int start, int stop)	Returns a subsequence of this attributed string based on column positions.
AttributedString	AttributedCharSequence.columnSubSequence(int start, int stop, Terminal terminal)	Deprecated. Use AttributedCharSequence.columnSubSequence(Terminal, int, int) instead
AttributedString	AttributedCharSequence.columnSubSequence(Terminal terminal, int start, int stop)	Returns a subsequence of this attributed string based on column positions.
static AttributedString	AttributedString.fromAnsi(String ansi)	Creates an AttributedString from an ANSI-encoded string.
static AttributedString	AttributedString.fromAnsi(String ansi, int tabs)	Creates an AttributedString from an ANSI-encoded string with a specified tab size.
static AttributedString	AttributedString.fromAnsi(String ansi, List<Integer> tabs)	Creates an AttributedString from an ANSI-encoded string with custom tab stops.
static AttributedString	AttributedString.fromAnsi(String ansi, List<Integer> tabs, String altIn, String altOut)	Creates an AttributedString from an ANSI-encoded string with custom tab stops and alternate character set sequences.
static AttributedString	AttributedString.fromAnsi(String ansi, Terminal terminal)	Creates an AttributedString from an ANSI-encoded string, using terminal capabilities.
static AttributedString	AttributedString.join(AttributedString delimiter, Iterable<AttributedString> elements)	Joins an Iterable of AttributedString objects with a delimiter.
static AttributedString	AttributedString.join(AttributedString delimiter, AttributedString... elements)	Joins multiple AttributedString objects with a delimiter.
AttributedString	AttributedString.styleMatches(Pattern pattern, AttributedStyle style)	Returns a new AttributedString with the specified style applied to all matches of the pattern.
abstract AttributedString	AttributedCharSequence.subSequence(int start, int end)
AttributedString	AttributedString.subSequence(int start, int end)	Returns a new AttributedString that is a subsequence of this attributed string.
AttributedString	AttributedStringBuilder.subSequence(int start, int end)	Returns a new AttributedString that is a subsequence of this attributed string builder.
AttributedString	AttributedCharSequence.substring(int start, int end)	Returns a new AttributedString that is a substring of this attributed string.
AttributedString	AttributedCharSequence.toAttributedString()	Converts this attributed character sequence to an AttributedString.

Methods in org.jline.utils that return types with arguments of type AttributedString

Modifier and Type	Method	Description
List<AttributedString>	AttributedCharSequence.columnSplitLength(int columns)	Splits this attributed string into multiple lines based on column width.
List<AttributedString>	AttributedCharSequence.columnSplitLength(int columns, boolean includeNewlines, boolean delayLineWrap)	Splits this attributed string into multiple lines based on column width, with options for handling newlines and line wrapping.
List<AttributedString>	AttributedCharSequence.columnSplitLength(int columns, boolean includeNewlines, boolean delayLineWrap, Terminal terminal)	Deprecated. Use AttributedCharSequence.columnSplitLength(Terminal, int, boolean, boolean) instead
List<AttributedString>	AttributedCharSequence.columnSplitLength(Terminal terminal, int columns, boolean includeNewlines, boolean delayLineWrap)	Splits this attributed string into multiple lines based on column width.

Methods in org.jline.utils with parameters of type AttributedString

Modifier and Type	Method	Description
AttributedStringBuilder	AttributedStringBuilder.append(AttributedString str)	Appends the specified AttributedString to this builder.
AttributedStringBuilder	AttributedStringBuilder.append(AttributedString str, int start, int end)	Appends a subsequence of the specified AttributedString to this builder.
static List<DiffHelper.Diff>	DiffHelper.diff(AttributedString text1, AttributedString text2)	Compute the differences between two attributed strings.
static AttributedString	AttributedString.join(AttributedString delimiter, Iterable<AttributedString> elements)	Joins an Iterable of AttributedString objects with a delimiter.
static AttributedString	AttributedString.join(AttributedString delimiter, AttributedString... elements)	Joins multiple AttributedString objects with a delimiter.

Method parameters in org.jline.utils with type arguments of type AttributedString

Modifier and Type	Method	Description
static AttributedString	AttributedString.join(AttributedString delimiter, Iterable<AttributedString> elements)	Joins an Iterable of AttributedString objects with a delimiter.
protected void	Display.moveVisualCursorTo(int targetPos, List<AttributedString> newLines)
void	Display.update(List<AttributedString> newLines, int targetCursorPos)	Update the display according to the new lines and flushes the output.
void	Display.update(List<AttributedString> newLines, int targetCursorPos, boolean flush)	Update the display according to the new lines.
void	Status.update(List<AttributedString> lines)
void	Status.update(List<AttributedString> lines, boolean flush)	Returns true if the cursor may be misplaced and should be updated.

Constructors in org.jline.utils with parameters of type AttributedString

Modifier	Constructor	Description
	Diff(DiffHelper.Operation operation, AttributedString text)	Constructor.

Uses of AttributedString in org.jline.widget

Method parameters in org.jline.widget with type arguments of type AttributedString

Modifier and Type	Method	Description
void	Widgets.setDescription(List<AttributedString> desc)	Set description text to the terminal status bar