Index

A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AdaptiveCliStylist - Class in org.aya.pretty.backend.terminal
use colors from terminal instead of absolute colors to protect eyes
align(Doc) - Static method in interface org.aya.pretty.doc.Doc
align lays out the document with the nesting level set to the current column.
alt() - Method in record class org.aya.pretty.doc.Doc.Image
Returns the value of the alt record component.
ALT_WS - Static variable in interface org.aya.pretty.doc.Doc
 
and() - Method in interface org.aya.pretty.doc.Style
 
angled(Doc) - Static method in interface org.aya.pretty.doc.Doc
 
asSeq() - Method in interface org.aya.pretty.doc.Doc
 
asSeq() - Method in record class org.aya.pretty.doc.Doc.Cat
 
asSeq() - Method in record class org.aya.pretty.doc.Doc.Empty
 
aya.pretty - module aya.pretty
 
AyaColorScheme - Record Class in org.aya.pretty.style
 
AyaColorScheme(MutableMap<String, Integer>) - Constructor for record class org.aya.pretty.style.AyaColorScheme
Creates an instance of a AyaColorScheme record class.
ayaFlavored - Variable in class org.aya.pretty.backend.md.DocMdPrinter.Config
 
AyaStyleFamily - Record Class in org.aya.pretty.style
 
AyaStyleFamily(MutableMap<String, Styles>) - Constructor for record class org.aya.pretty.style.AyaStyleFamily
Creates an instance of a AyaStyleFamily record class.
AyaStyleKey - Enum Class in org.aya.pretty.style
The key syntax:

B

background() - Method in record class org.aya.pretty.doc.Style.ColorHex
Returns the value of the background record component.
background() - Method in record class org.aya.pretty.doc.Style.ColorName
Returns the value of the background record component.
Basic(int, int, S) - Constructor for class org.aya.pretty.printer.PrinterConfig.Basic
 
beginCorner() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the beginCorner record component.
beginCornerDoc() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
 
Between - Enum constant in enum class org.aya.pretty.error.Span.NowLoc
 
Blink - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
BlockQuote - Enum constant in enum class org.aya.pretty.backend.md.MdStyle.GFM
 
bold() - Static method in interface org.aya.pretty.doc.Style
 
bold() - Method in record class org.aya.pretty.doc.Styles
 
Bold - Enum constant in enum class org.aya.pretty.doc.Style.Attr
 
braced(Doc) - Static method in interface org.aya.pretty.doc.Doc
 
bracedUnless(Doc, boolean) - Static method in interface org.aya.pretty.doc.Doc
 
brief() - Method in record class org.aya.pretty.error.PrettyError
Returns the value of the brief record component.
bullet(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 

C

CallTerm - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
cat(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
cat tries laying out the documents separated with nothing, and if this does not fit the page, separates them with newlines.
cat(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 
Cat(ImmutableSeq<Doc>) - Constructor for record class org.aya.pretty.doc.Doc.Cat
Creates an instance of a Cat record class.
catBlockL(int, SeqLike<Doc>, Doc, SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
catBlockR(int, SeqLike<Doc>, Doc, SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
cblock(Doc, int, Doc) - Static method in interface org.aya.pretty.doc.Doc
Creates a C-style indented block of statements.
ClassedPreset(ClosingStylist) - Constructor for class org.aya.pretty.backend.html.Html5Stylist.ClassedPreset
 
CLASSIC - Static variable in record class org.aya.pretty.error.PrettyError.FormatConfig
 
ClosingStylist - Class in org.aya.pretty.backend.string
 
ClosingStylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.string.ClosingStylist
 
ClosingStylist.Delegate - Class in org.aya.pretty.backend.string
 
ClosingStylist.StyleToken - Record Class in org.aya.pretty.backend.string
 
code() - Method in record class org.aya.pretty.doc.Doc.CodeBlock
Returns the value of the code record component.
code() - Method in record class org.aya.pretty.doc.Doc.InlineCode
Returns the value of the code record component.
code(String) - Static method in interface org.aya.pretty.doc.Doc
 
code(String, Doc) - Static method in interface org.aya.pretty.doc.Doc
 
code(Doc) - Static method in interface org.aya.pretty.doc.Doc
 
Code - Enum constant in enum class org.aya.pretty.backend.string.StringPrinter.Outer
 
codeBlock(String) - Static method in interface org.aya.pretty.doc.Doc
 
codeBlock(String, Doc) - Static method in interface org.aya.pretty.doc.Doc
 
CodeBlock(String, Doc) - Constructor for record class org.aya.pretty.doc.Doc.CodeBlock
Creates an instance of a CodeBlock record class.
color() - Method in record class org.aya.pretty.doc.Style.ColorHex
Returns the value of the color record component.
color(float, float, float) - Static method in interface org.aya.pretty.doc.Style
 
color(float, float, float) - Method in record class org.aya.pretty.doc.Styles
 
color(int) - Static method in interface org.aya.pretty.doc.Style
 
color(int) - Method in record class org.aya.pretty.doc.Styles
 
color(String) - Static method in interface org.aya.pretty.doc.Style
 
color(String) - Method in record class org.aya.pretty.doc.Styles
 
colorBg(int) - Static method in interface org.aya.pretty.doc.Style
 
colorBg(String) - Static method in interface org.aya.pretty.doc.Style
 
colorBG(int) - Method in record class org.aya.pretty.doc.Styles
 
colorBG(String) - Method in record class org.aya.pretty.doc.Styles
 
ColorHex(int, boolean) - Constructor for record class org.aya.pretty.doc.Style.ColorHex
Creates an instance of a ColorHex record class.
colorName() - Method in record class org.aya.pretty.doc.Style.ColorName
Returns the value of the colorName record component.
ColorName(String, boolean) - Constructor for record class org.aya.pretty.doc.Style.ColorName
Creates an instance of a ColorName record class.
colorOf(float, float, float) - Static method in interface org.aya.pretty.printer.ColorScheme
 
colorScheme - Variable in class org.aya.pretty.printer.Stylist
predefined colors, see Style.color(String) and Style.colorBg(String)
ColorScheme - Interface in org.aya.pretty.printer
 
colorsToCss(ColorScheme) - Static method in class org.aya.pretty.backend.html.Html5Stylist
 
column(IntFunction<Doc>) - Static method in interface org.aya.pretty.doc.Doc
Layout a document depending on which column it starts at.
Column(IntFunction<Doc>) - Constructor for record class org.aya.pretty.doc.Doc.Column
Creates an instance of a Column record class.
COMMA - Static variable in interface org.aya.pretty.doc.Doc
 
commaList(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
commonRender() - Method in interface org.aya.pretty.doc.Doc
Produce unicode and 80-width output
Con - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
config - Variable in class org.aya.pretty.backend.string.StringPrinter
 
Config() - Constructor for class org.aya.pretty.backend.latex.DocTeXPrinter.Config
 
Config(boolean, boolean) - Constructor for class org.aya.pretty.backend.html.DocHtmlPrinter.Config
 
Config(boolean, boolean, boolean) - Constructor for class org.aya.pretty.backend.md.DocMdPrinter.Config
 
Config(Html5Stylist, boolean, boolean) - Constructor for class org.aya.pretty.backend.html.DocHtmlPrinter.Config
 
Config(TeXStylist) - Constructor for class org.aya.pretty.backend.latex.DocTeXPrinter.Config
 
Config(MdStylist, boolean, boolean, boolean) - Constructor for class org.aya.pretty.backend.md.DocMdPrinter.Config
 
Config(UnixTermStylist, int, boolean) - Constructor for class org.aya.pretty.backend.terminal.DocTermPrinter.Config
 
content(CharSequence, boolean) - Method in class org.aya.pretty.backend.string.Cursor
 
cssColor(int) - Static method in class org.aya.pretty.backend.html.Html5Stylist
 
cssVar(String) - Static method in class org.aya.pretty.backend.html.Html5Stylist
 
CurlyUnderline - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
Cursor - Class in org.aya.pretty.backend.string
 
Cursor(StringPrinter<?>) - Constructor for class org.aya.pretty.backend.string.Cursor
 
custom(Style.CustomStyle) - Method in record class org.aya.pretty.doc.Styles
 

D

Data - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
Data(int, int, int, int) - Constructor for record class org.aya.pretty.error.Span.Data
Creates an instance of a Data record class.
debugRender() - Method in interface org.aya.pretty.doc.Doc
Produce ASCII and infinite-width output
DebugStylist - Class in org.aya.pretty.backend.string
 
DebugStylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.string.DebugStylist
 
DEFAULT - Static variable in class org.aya.pretty.backend.html.Html5Stylist
 
DEFAULT - Static variable in class org.aya.pretty.backend.latex.TeXStylist
 
DEFAULT - Static variable in class org.aya.pretty.backend.md.MdStylist
 
DEFAULT - Static variable in class org.aya.pretty.backend.string.DebugStylist
 
DEFAULT - Static variable in interface org.aya.pretty.error.PrettyErrorConfig
 
DEFAULT - Static variable in record class org.aya.pretty.style.AyaStyleFamily
 
defaultDoc() - Method in record class org.aya.pretty.doc.Doc.FlatAlt
Returns the value of the defaultDoc record component.
definedColors() - Method in interface org.aya.pretty.printer.ColorScheme
 
definedColors() - Method in record class org.aya.pretty.style.AyaColorScheme
Returns the value of the definedColors record component.
definedStyles() - Method in interface org.aya.pretty.printer.StyleFamily
 
definedStyles() - Method in record class org.aya.pretty.style.AyaStyleFamily
Returns the value of the definedStyles record component.
delegate - Variable in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
Delegate(ClosingStylist) - Constructor for class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
Dim - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
DirectLink(String) - Constructor for record class org.aya.pretty.doc.Link.DirectLink
Creates an instance of a DirectLink record class.
doc() - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Returns the value of the doc record component.
doc() - Method in record class org.aya.pretty.doc.Doc.Nest
Returns the value of the doc record component.
doc() - Method in record class org.aya.pretty.doc.Doc.Styled
Returns the value of the doc record component.
Doc - Interface in org.aya.pretty.doc
This class reimplemented Haskell PrettyPrint library's Doc module.
Doc.Cat - Record Class in org.aya.pretty.doc
Concatenation of two documents
Doc.CodeBlock - Record Class in org.aya.pretty.doc
Code block, with special escape settings compared to Doc.PlainText
Doc.Column - Record Class in org.aya.pretty.doc
A document that will react on the current cursor position.
Doc.Empty - Record Class in org.aya.pretty.doc
The empty document; conceptually the unit of 'Cat'
Doc.EscapedText - Record Class in org.aya.pretty.doc
Already escaped text, which will not be escaped by backend.
Doc.FlatAlt - Record Class in org.aya.pretty.doc
Lay out the defaultDoc 'Doc', but when flattened (via 'group'), prefer the preferWhenFlatten.
Doc.HyperLinked - Record Class in org.aya.pretty.doc
A clickable text line without '\n'.
Doc.Image - Record Class in org.aya.pretty.doc
 
Doc.InlineCode - Record Class in org.aya.pretty.doc
Inline code, with special escape settings compared to Doc.PlainText
Doc.Line - Record Class in org.aya.pretty.doc
Hard line break
Doc.List - Record Class in org.aya.pretty.doc
 
Doc.Nest - Record Class in org.aya.pretty.doc
Document indented by a number of columns
Doc.Nesting - Record Class in org.aya.pretty.doc
A document that will react on the current nest level.
Doc.PageWidth - Record Class in org.aya.pretty.doc
A document that will react on the page width.
Doc.PlainText - Record Class in org.aya.pretty.doc
A plain text line without '\n'.
Doc.SpecialSymbol - Record Class in org.aya.pretty.doc
A special symbol that may get rendered in a special way
Doc.Styled - Record Class in org.aya.pretty.doc
Styled document
Doc.Union - Record Class in org.aya.pretty.doc
The first lines of first document should be shorter than the first lines of the second one, so the layout algorithm can pick the one that fits best.
docBuilder() - Method in record class org.aya.pretty.doc.Doc.Column
Returns the value of the docBuilder record component.
docBuilder() - Method in record class org.aya.pretty.doc.Doc.Nesting
Returns the value of the docBuilder record component.
docBuilder() - Method in record class org.aya.pretty.doc.Doc.PageWidth
Returns the value of the docBuilder record component.
DocHtmlPrinter<Config extends DocHtmlPrinter.Config> - Class in org.aya.pretty.backend.html
Html backend, which ignores page width.
DocHtmlPrinter() - Constructor for class org.aya.pretty.backend.html.DocHtmlPrinter
 
DocHtmlPrinter.Config - Class in org.aya.pretty.backend.html
 
Docile - Interface in org.aya.pretty.doc
Should be called Prettiable.
DocMdPrinter - Class in org.aya.pretty.backend.md
 
DocMdPrinter() - Constructor for class org.aya.pretty.backend.md.DocMdPrinter
 
DocMdPrinter.Config - Class in org.aya.pretty.backend.md
 
DocTermPrinter - Class in org.aya.pretty.backend.terminal
 
DocTermPrinter() - Constructor for class org.aya.pretty.backend.terminal.DocTermPrinter
 
DocTermPrinter.Config - Class in org.aya.pretty.backend.terminal
 
DocTeXPrinter - Class in org.aya.pretty.backend.latex
 
DocTeXPrinter() - Constructor for class org.aya.pretty.backend.latex.DocTeXPrinter
 
DocTeXPrinter.Config - Class in org.aya.pretty.backend.latex
 
DoubleUnderline - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 

E

EMACS - Static variable in record class org.aya.pretty.style.AyaColorScheme
The colors are from Emacs.
empty() - Static method in interface org.aya.pretty.doc.Doc
The empty document; conceptually the unit of 'Cat'
empty() - Static method in record class org.aya.pretty.doc.Styles
 
Empty() - Constructor for record class org.aya.pretty.doc.Doc.Empty
Creates an instance of a Empty record class.
emptyIf(boolean, Supplier<Doc>) - Static method in interface org.aya.pretty.doc.Doc
Return conditional Doc.empty()
EnclosingTag - Enum constant in enum class org.aya.pretty.backend.string.StringPrinter.Outer
 
end() - Method in record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
Returns the value of the end record component.
End - Enum constant in enum class org.aya.pretty.error.Span.NowLoc
 
endCol() - Method in record class org.aya.pretty.error.LineColSpan
Returns the value of the endCol record component.
endCol() - Method in record class org.aya.pretty.error.Span.Data
Returns the value of the endCol record component.
endCorner() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the endCorner record component.
endCornerDoc() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
 
endLine() - Method in record class org.aya.pretty.error.LineColSpan
Returns the value of the endLine record component.
endLine() - Method in record class org.aya.pretty.error.Span.Data
Returns the value of the endLine record component.
english(String) - Static method in interface org.aya.pretty.doc.Doc
 
entityMapping - Static variable in class org.aya.pretty.backend.html.DocHtmlPrinter
 
entityPattern - Static variable in class org.aya.pretty.backend.html.DocHtmlPrinter
Mozilla doc: entity Added backslash for vitepress compatibility.
equals(Object) - Method in record class org.aya.pretty.backend.md.MdStyle.Heading
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Cat
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.CodeBlock
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Column
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Empty
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.EscapedText
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.FlatAlt
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Image
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.InlineCode
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Line
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.List
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Nest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Nesting
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.PageWidth
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.PlainText
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.SpecialSymbol
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Styled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Doc.Union
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Link.DirectLink
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Link.LocalId
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Style.ColorHex
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Style.ColorName
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Style.Preset
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.doc.Styles
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.error.LineColSpan
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.error.PrettyError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.error.Span.Data
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.style.AyaColorScheme
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.aya.pretty.style.AyaStyleFamily
Indicates whether some other object is "equal to" this one.
errorIndicator() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the errorIndicator record component.
errorRange() - Method in record class org.aya.pretty.error.PrettyError
Returns the value of the errorRange record component.
escaped(String) - Static method in interface org.aya.pretty.doc.Doc
Already escaped text that will be rendered as-is.
EscapedText(String) - Constructor for record class org.aya.pretty.doc.Doc.EscapedText
Creates an instance of a EscapedText record class.
escapePlainText(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
escapePlainText(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
escapePlainText(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
escapePlainText(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 

F

Field - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
filePath() - Method in record class org.aya.pretty.error.PrettyError
Returns the value of the filePath record component.
fitsBetter(Cursor, Doc, Doc) - Method in class org.aya.pretty.backend.string.StringPrinter
 
flatAlt(Doc, Doc) - Static method in interface org.aya.pretty.doc.Doc
By default, flatAlt renders as .
FlatAlt(Doc, Doc) - Constructor for record class org.aya.pretty.doc.Doc.FlatAlt
Creates an instance of a FlatAlt record class.
flatAltBracedBlock(Doc, Doc) - Static method in interface org.aya.pretty.doc.Doc
Either `{ defaultDoc }` or `{\nflatDoc\n}`
Fn - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
format(Seq<Style>, Cursor, EnumSet<StringPrinter.Outer>, Runnable) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
format(Seq<Style>, Cursor, EnumSet<StringPrinter.Outer>, Runnable) - Method in class org.aya.pretty.backend.string.DebugStylist
 
format(Seq<Style>, Cursor, EnumSet<StringPrinter.Outer>, Runnable) - Method in class org.aya.pretty.backend.string.StringStylist
 
formatBold(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.Html5Stylist
 
formatBold(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.TeXStylist
 
formatBold(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.MdStylist
 
formatBold(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatBold(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatBold(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.terminal.UnixTermStylist
 
formatCodeBlock(Cursor, Doc, String, String, String, String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
formatCodeBlock(Cursor, Doc, String, String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
formatColorHex(int, boolean) - Method in class org.aya.pretty.backend.html.Html5Stylist
 
formatColorHex(int, boolean) - Method in class org.aya.pretty.backend.latex.TeXStylist
 
formatColorHex(int, boolean) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatColorHex(int, boolean) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatColorHex(int, boolean) - Method in class org.aya.pretty.backend.terminal.UnixTermStylist
 
formatConfig() - Method in record class org.aya.pretty.error.PrettyError
Returns the value of the formatConfig record component.
FormatConfig(Option<Character>, char, Option<Character>, char, char, char, char, char) - Constructor for record class org.aya.pretty.error.PrettyError.FormatConfig
Creates an instance of a FormatConfig record class.
formatCustom(Style.CustomStyle) - Method in class org.aya.pretty.backend.md.MdStylist
 
formatCustom(Style.CustomStyle) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatCustom(Style.CustomStyle) - Method in class org.aya.pretty.backend.terminal.UnixTermStylist
 
formatCustom(Style.CustomStyle) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatInlineCode(Cursor, Doc, String, String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
formatItalic(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.Html5Stylist
 
formatItalic(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.TeXStylist
 
formatItalic(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.MdStylist
 
formatItalic(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatItalic(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatItalic(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.terminal.UnixTermStylist
 
formatPresetColor(String, boolean) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatPresetColor(String, boolean) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatPresetStyle(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.Html5Stylist.ClassedPreset
 
formatPresetStyle(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatPresetStyle(String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatStrike(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.Html5Stylist
 
formatStrike(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.TeXStylist
 
formatStrike(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.MdStylist
 
formatStrike(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatStrike(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatStrike(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.terminal.UnixTermStylist
 
formatUnderline(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.Html5Stylist
 
formatUnderline(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.TeXStylist
 
formatUnderline(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist.Delegate
 
formatUnderline(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.ClosingStylist
 
formatUnderline(EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.terminal.UnixTermStylist
 
FREE - Static variable in class org.aya.pretty.backend.string.StringPrinter
 

G

Generalized - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
getCursor() - Method in class org.aya.pretty.backend.string.Cursor
 
getNestLevel() - Method in class org.aya.pretty.backend.string.Cursor
 
getPageHeight() - Method in class org.aya.pretty.printer.PrinterConfig.Basic
 
getPageHeight() - Method in interface org.aya.pretty.printer.PrinterConfig
The line count that a page can hold.
getPageWidth() - Method in class org.aya.pretty.printer.PrinterConfig.Basic
 
getPageWidth() - Method in interface org.aya.pretty.printer.PrinterConfig
The character count that a line can hold.
getStylist() - Method in class org.aya.pretty.printer.PrinterConfig.Basic
 
getStylist() - Method in interface org.aya.pretty.printer.PrinterConfig
 

H

h(int) - Static method in interface org.aya.pretty.backend.md.MdStyle
 
hang(int, Doc) - Static method in interface org.aya.pretty.doc.Doc
hang lays out the document with a nesting level set to the /current column/ plus .
hashCode() - Method in record class org.aya.pretty.backend.md.MdStyle.Heading
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Cat
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.CodeBlock
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Column
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Empty
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.EscapedText
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.FlatAlt
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Image
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.InlineCode
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Line
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.List
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Nest
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Nesting
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.PageWidth
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.PlainText
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.SpecialSymbol
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Styled
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Doc.Union
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Link.DirectLink
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Link.LocalId
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Style.ColorHex
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Style.ColorName
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Style.Preset
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.doc.Styles
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.error.LineColSpan
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.error.PrettyError
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.error.Span.Data
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.style.AyaColorScheme
Returns a hash code value for this object.
hashCode() - Method in record class org.aya.pretty.style.AyaStyleFamily
Returns a hash code value for this object.
Heading(int) - Constructor for record class org.aya.pretty.backend.md.MdStyle.Heading
Creates an instance of a Heading record class.
hover() - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Returns the value of the hover record component.
HOVER_ALL_OCCURS - Static variable in interface org.aya.pretty.backend.html.HtmlConstants
 
HOVER_HIGHLIGHT_ALL_OCCURS_JS_HIGHLIGHT_FN - Static variable in interface org.aya.pretty.backend.html.HtmlConstants
 
HOVER_HIGHLIGHT_ALL_OCCURS_JS_INIT - Static variable in interface org.aya.pretty.backend.html.HtmlConstants
 
HOVER_HIGHLIGHT_ALL_OCCURS_VUE - Static variable in interface org.aya.pretty.backend.html.HtmlConstants
 
HOVER_POPUP_STYLE - Static variable in interface org.aya.pretty.backend.html.HtmlConstants
 
HOVER_STYLE - Static variable in interface org.aya.pretty.backend.html.HtmlConstants
 
href() - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Returns the value of the href record component.
Html5Stylist - Class in org.aya.pretty.backend.html
 
Html5Stylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.html.Html5Stylist
 
Html5Stylist.ClassedPreset - Class in org.aya.pretty.backend.html
 
HtmlConstants - Interface in org.aya.pretty.backend.html
 
hyperLink(String, Link) - Static method in interface org.aya.pretty.doc.Doc
 
hyperLink(Doc, Link, String) - Static method in interface org.aya.pretty.doc.Doc
 
HyperLinked(Doc, Link, Link, String) - Constructor for record class org.aya.pretty.doc.Doc.HyperLinked
Creates an instance of a HyperLinked record class.

I

id() - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Returns the value of the id record component.
image(Doc, Link) - Static method in interface org.aya.pretty.doc.Doc
 
Image(Doc, Link) - Constructor for record class org.aya.pretty.doc.Doc.Image
Creates an instance of a Image record class.
indent() - Method in record class org.aya.pretty.doc.Doc.Nest
Returns the value of the indent record component.
indent(int, Doc) - Static method in interface org.aya.pretty.doc.Doc
This method indent document by columns, * starting from the current cursor position.
INFINITE_SIZE - Static variable in interface org.aya.pretty.printer.PrinterConfig
Indicate that the width or height has infinite size.
InlineCode(String, Doc) - Constructor for record class org.aya.pretty.doc.Doc.InlineCode
Creates an instance of a InlineCode record class.
inlineHints() - Method in record class org.aya.pretty.error.PrettyError
Returns the value of the inlineHints record component.
inner() - Method in record class org.aya.pretty.doc.Doc.Cat
Returns the value of the inner record component.
input() - Method in record class org.aya.pretty.error.LineColSpan
Returns the value of the input record component.
input() - Method in interface org.aya.pretty.error.Span
 
INSTANCE - Static variable in class org.aya.pretty.backend.terminal.AdaptiveCliStylist
 
INSTANCE - Static variable in record class org.aya.pretty.doc.Doc.Line
 
INTELLIJ - Static variable in record class org.aya.pretty.style.AyaColorScheme
The colors are from IntelliJ IDEA light theme.
invisibleContent(CharSequence) - Method in class org.aya.pretty.backend.string.Cursor
 
isAtLineStart() - Method in class org.aya.pretty.backend.string.Cursor
 
isEmpty() - Method in interface org.aya.pretty.doc.Doc
 
isNotEmpty() - Method in interface org.aya.pretty.doc.Doc
 
isOrdered() - Method in record class org.aya.pretty.doc.Doc.List
Returns the value of the isOrdered record component.
italic() - Static method in interface org.aya.pretty.doc.Style
 
italic() - Method in record class org.aya.pretty.doc.Styles
 
Italic - Enum constant in enum class org.aya.pretty.doc.Style.Attr
 
items() - Method in record class org.aya.pretty.doc.Doc.List
Returns the value of the items record component.

J

join(Doc, SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
join(Doc, Doc...) - Static method in interface org.aya.pretty.doc.Doc
 

K

key() - Method in enum class org.aya.pretty.style.AyaStyleKey
 
Keyword - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 

L

language() - Method in record class org.aya.pretty.doc.Doc.CodeBlock
Returns the value of the language record component.
language() - Method in record class org.aya.pretty.doc.Doc.InlineCode
Returns the value of the language record component.
level() - Method in record class org.aya.pretty.backend.md.MdStyle.Heading
Returns the value of the level record component.
licit(boolean, Doc) - Static method in interface org.aya.pretty.doc.Doc
 
line() - Static method in interface org.aya.pretty.doc.Doc
Unconditionally line break
Line() - Constructor for record class org.aya.pretty.doc.Doc.Line
Creates an instance of a Line record class.
lineBreakWith(CharSequence) - Method in class org.aya.pretty.backend.string.Cursor
 
LineColSpan - Record Class in org.aya.pretty.error
 
LineColSpan(String, int, int, int, int) - Constructor for record class org.aya.pretty.error.LineColSpan
Creates an instance of a LineColSpan record class.
lineNoSeparator() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the lineNoSeparator record component.
lineNoSepDoc() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
 
link() - Method in record class org.aya.pretty.doc.Link.DirectLink
Returns the value of the link record component.
Link - Interface in org.aya.pretty.doc
 
Link.DirectLink - Record Class in org.aya.pretty.doc
 
Link.LocalId - Record Class in org.aya.pretty.doc
 
linkDef(Doc, Link) - Static method in interface org.aya.pretty.doc.Doc
 
linkDef(Doc, Link, String) - Static method in interface org.aya.pretty.doc.Doc
 
linkRef(Doc, Link) - Static method in interface org.aya.pretty.doc.Doc
 
linkRef(Doc, Link, String) - Static method in interface org.aya.pretty.doc.Doc
 
list(boolean, SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
List - Enum constant in enum class org.aya.pretty.backend.string.StringPrinter.Outer
 
List(boolean, ImmutableSeq<Doc>) - Constructor for record class org.aya.pretty.doc.Doc.List
Creates an instance of a List record class.
loc(int) - Static method in interface org.aya.pretty.doc.Link
 
loc(String) - Static method in interface org.aya.pretty.doc.Link
 
LocalId(Either<String, Integer>) - Constructor for record class org.aya.pretty.doc.Link.LocalId
Creates an instance of a LocalId record class.
longerOne() - Method in record class org.aya.pretty.doc.Doc.Union
Returns the value of the longerOne record component.

M

makeIndent(int) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
makeIndent(int) - Method in class org.aya.pretty.backend.string.StringPrinter
 
MD_ESCAPE - Static variable in class org.aya.pretty.backend.md.DocMdPrinter
 
MD_NO_ESCAPE_BACKSLASH - Static variable in class org.aya.pretty.backend.md.DocMdPrinter
 
MdStyle - Interface in org.aya.pretty.backend.md
 
MdStyle.GFM - Enum Class in org.aya.pretty.backend.md
GitHub flavored markdown
MdStyle.Heading - Record Class in org.aya.pretty.backend.md
 
MdStylist - Class in org.aya.pretty.backend.md
 
MdStylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.md.MdStylist
 
moveForward(int) - Method in class org.aya.pretty.backend.string.Cursor
 
moveToNewLine() - Method in class org.aya.pretty.backend.string.Cursor
 

N

nest(int, Doc) - Static method in interface org.aya.pretty.doc.Doc
lays out the document with the current nesting level (indentation of the following lines) increased by .
Nest(int, Doc) - Constructor for record class org.aya.pretty.doc.Doc.Nest
Creates an instance of a Nest record class.
nested(int, Runnable) - Method in class org.aya.pretty.backend.string.Cursor
 
nesting(IntFunction<Doc>) - Static method in interface org.aya.pretty.doc.Doc
Layout a document depending on the current 'nest'-ing level.
Nesting(IntFunction<Doc>) - Constructor for record class org.aya.pretty.doc.Doc.Nesting
Creates an instance of a Nesting record class.
None - Enum constant in enum class org.aya.pretty.error.Span.NowLoc
 
normalize(PrettyErrorConfig) - Method in record class org.aya.pretty.error.LineColSpan
 
normalize(PrettyErrorConfig) - Method in interface org.aya.pretty.error.Span
 
normalizeCssId(String) - Static method in class org.aya.pretty.backend.html.Html5Stylist
normalizeHref(Link) - Static method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
normalizeId(Link) - Static method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
nowLoc(int) - Method in record class org.aya.pretty.error.Span.Data
 
NULL - Static variable in record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
 

O

ONE_WS - Static variable in interface org.aya.pretty.doc.Doc
 
oneLinear() - Method in record class org.aya.pretty.error.Span.Data
 
ordered(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 
ordinal(int) - Static method in interface org.aya.pretty.doc.Doc
 
org.aya.pretty.backend.html - package org.aya.pretty.backend.html
 
org.aya.pretty.backend.latex - package org.aya.pretty.backend.latex
 
org.aya.pretty.backend.md - package org.aya.pretty.backend.md
 
org.aya.pretty.backend.string - package org.aya.pretty.backend.string
 
org.aya.pretty.backend.terminal - package org.aya.pretty.backend.terminal
 
org.aya.pretty.doc - package org.aya.pretty.doc
 
org.aya.pretty.error - package org.aya.pretty.error
 
org.aya.pretty.printer - package org.aya.pretty.printer
 
org.aya.pretty.style - package org.aya.pretty.style
 
Overline - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 

P

page(String) - Static method in interface org.aya.pretty.doc.Link
 
pageWidth(IntFunction<Doc>) - Static method in interface org.aya.pretty.doc.Doc
Layout a document depending on the page width, if one has been specified.
PageWidth(IntFunction<Doc>) - Constructor for record class org.aya.pretty.doc.Doc.PageWidth
Creates an instance of a PageWidth record class.
par(int, Doc) - Static method in interface org.aya.pretty.doc.Doc
Paragraph indentation: indent by columns, and then indent the first line again by columns.
Paragraph - Enum constant in enum class org.aya.pretty.backend.md.MdStyle.GFM
 
parened(Doc) - Static method in interface org.aya.pretty.doc.Doc
 
plain(String) - Static method in interface org.aya.pretty.doc.Doc
Plain text document.
PlainText(String) - Constructor for record class org.aya.pretty.doc.Doc.PlainText
Creates an instance of a PlainText record class.
predictWidth(Cursor, Doc) - Method in class org.aya.pretty.backend.string.StringPrinter
 
preferWhenFlatten() - Method in record class org.aya.pretty.doc.Doc.FlatAlt
Returns the value of the preferWhenFlatten record component.
prepareStylist() - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
prepareStylist() - Method in class org.aya.pretty.backend.string.StringPrinter
 
preset() - Method in enum class org.aya.pretty.style.AyaStyleKey
 
preset(String) - Static method in interface org.aya.pretty.doc.Style
 
preset(String) - Method in record class org.aya.pretty.doc.Styles
 
Preset(String) - Constructor for record class org.aya.pretty.doc.Style.Preset
Creates an instance of a Preset record class.
PrettyError - Record Class in org.aya.pretty.error
 
PrettyError(String, Span, Doc, PrettyError.FormatConfig, ImmutableSeq<Tuple2<Span, Doc>>) - Constructor for record class org.aya.pretty.error.PrettyError
Creates an instance of a PrettyError record class.
PrettyError.FormatConfig - Record Class in org.aya.pretty.error
 
PrettyErrorConfig - Interface in org.aya.pretty.error
 
Prim - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
Printer<Out,Config extends PrinterConfig> - Interface in org.aya.pretty.printer
This class was designed to support various PrettyPrint backend.
PrinterConfig - Interface in org.aya.pretty.printer
This class was designed to support various PrettyPrint backend.
PrinterConfig.Basic<S extends Stylist> - Class in org.aya.pretty.printer
Basic configure for other configs to easily extend config flags.

R

render(Config, Doc) - Method in class org.aya.pretty.backend.string.StringPrinter
 
render(Config, Doc) - Method in interface org.aya.pretty.printer.Printer
Render a Doc object with a config.
render(Printer<Out, Config>, Config) - Method in interface org.aya.pretty.doc.Doc
 
renderCodeBlock(Cursor, Doc.CodeBlock, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderCodeBlock(Cursor, Doc.CodeBlock, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderCodeBlock(Cursor, Doc.CodeBlock, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderCssStyle(Cursor) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderDoc(Cursor, Doc, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderFlatAlt(Cursor, Doc.FlatAlt, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderFooter(Cursor) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderFooter(Cursor) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderFooter(Cursor) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderHardLineBreak(Cursor, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderHardLineBreak(Cursor, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
renderHardLineBreak(Cursor, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderHardLineBreak(Cursor, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderHeader(Cursor) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderHeader(Cursor) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
renderHeader(Cursor) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderHeader(Cursor) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderHyperLinked(Cursor, Doc.HyperLinked, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderHyperLinked(Cursor, Doc.HyperLinked, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderHyperLinked(Cursor, Doc.HyperLinked, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderImage(Cursor, Doc.Image, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderImage(Cursor, Doc.Image, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderImage(Cursor, Doc.Image, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderInlineCode(Cursor, Doc.InlineCode, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderInlineCode(Cursor, Doc.InlineCode, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
renderInlineCode(Cursor, Doc.InlineCode, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.terminal.DocTermPrinter
 
renderInlineCode(Cursor, Doc.InlineCode, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderInlineCode(Cursor, Doc.InlineCode, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderList(Cursor, Doc.List, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.html.DocHtmlPrinter
 
renderList(Cursor, Doc.List, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
renderList(Cursor, Doc.List, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.md.DocMdPrinter
 
renderList(Cursor, Doc.List, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderList(StringPrinter<?>, Cursor, Doc.List, EnumSet<StringPrinter.Outer>) - Static method in class org.aya.pretty.backend.string.StringPrinter
 
renderNest(Cursor, Doc.Nest, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderPlainText(Cursor, String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderSpecialSymbol(Cursor, String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.latex.DocTeXPrinter
 
renderSpecialSymbol(Cursor, String, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderStyled(Cursor, Doc.Styled, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
renderToAyaMd() - Method in interface org.aya.pretty.doc.Doc
 
renderToHtml() - Method in interface org.aya.pretty.doc.Doc
 
renderToHtml(boolean) - Method in interface org.aya.pretty.doc.Doc
 
renderToMd() - Method in interface org.aya.pretty.doc.Doc
 
renderToString(int, boolean) - Method in interface org.aya.pretty.doc.Doc
 
renderToString(StringPrinterConfig<?>) - Method in interface org.aya.pretty.doc.Doc
 
renderToTerminal() - Method in interface org.aya.pretty.doc.Doc
 
renderToTerminal(int, boolean) - Method in interface org.aya.pretty.doc.Doc
 
renderToTeX() - Method in interface org.aya.pretty.doc.Doc
 
renderUnionDoc(Cursor, Doc.Union, EnumSet<StringPrinter.Outer>) - Method in class org.aya.pretty.backend.string.StringPrinter
 
result() - Method in class org.aya.pretty.backend.string.Cursor
 
Reverse - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 

S

sep(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
sep(Doc...) - Static method in interface org.aya.pretty.doc.Doc
fillSep concatenates the documents horizontally with a space as long as it fits the page, then inserts a 'line' and continues doing that for all documents in .
sepNonEmpty(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
sepNonEmpty(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 
shorterOne() - Method in record class org.aya.pretty.doc.Doc.Union
Returns the value of the shorterOne record component.
Shot - Enum constant in enum class org.aya.pretty.error.Span.NowLoc
 
showMore() - Method in interface org.aya.pretty.error.PrettyErrorConfig
Show more lines before startLine and after endLine
spaced(Doc) - Static method in interface org.aya.pretty.doc.Doc
 
spaces(int) - Static method in interface org.aya.pretty.doc.Doc
 
Span - Interface in org.aya.pretty.error
 
Span.Data - Record Class in org.aya.pretty.error
 
Span.NowLoc - Enum Class in org.aya.pretty.error
 
SpecialSymbol(String) - Constructor for record class org.aya.pretty.doc.Doc.SpecialSymbol
Creates an instance of a SpecialSymbol record class.
splitL(int, Doc, Doc, Doc) - Static method in interface org.aya.pretty.doc.Doc
Concat , and , with and occupying at least length.
splitR(int, Doc, Doc, Doc) - Static method in interface org.aya.pretty.doc.Doc
Concat , and , with occupying at least length.
src() - Method in record class org.aya.pretty.doc.Doc.Image
Returns the value of the src record component.
start() - Method in record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
Returns the value of the start record component.
Start - Enum constant in enum class org.aya.pretty.error.Span.NowLoc
 
startCol() - Method in record class org.aya.pretty.error.LineColSpan
Returns the value of the startCol record component.
startCol() - Method in record class org.aya.pretty.error.Span.Data
Returns the value of the startCol record component.
startLine() - Method in record class org.aya.pretty.error.LineColSpan
Returns the value of the startLine record component.
startLine() - Method in record class org.aya.pretty.error.Span.Data
Returns the value of the startLine record component.
stickySep(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
stickySep concatenates all documents horizontally with a space, i.e.
stickySep(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 
strike() - Static method in interface org.aya.pretty.doc.Style
 
strike() - Method in record class org.aya.pretty.doc.Styles
 
Strike - Enum constant in enum class org.aya.pretty.doc.Style.Attr
 
StringPrinter<Config extends StringPrinterConfig<?>> - Class in org.aya.pretty.backend.string
The class for all string-output printers.
StringPrinter() - Constructor for class org.aya.pretty.backend.string.StringPrinter
 
StringPrinter.Outer - Enum Class in org.aya.pretty.backend.string
renderer: where am I?
StringPrinterConfig<S extends StringStylist> - Class in org.aya.pretty.backend.string
 
StringPrinterConfig(S, int, boolean) - Constructor for class org.aya.pretty.backend.string.StringPrinterConfig
 
StringStylist - Class in org.aya.pretty.backend.string
 
StringStylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.string.StringStylist
 
Struct - Enum constant in enum class org.aya.pretty.style.AyaStyleKey
 
Style - Interface in org.aya.pretty.doc
Text styles.
Style.Attr - Enum Class in org.aya.pretty.doc
 
Style.ColorHex - Record Class in org.aya.pretty.doc
 
Style.ColorName - Record Class in org.aya.pretty.doc
 
Style.CustomStyle - Interface in org.aya.pretty.doc
Make your custom style a subclass of this one.
Style.Preset - Record Class in org.aya.pretty.doc
 
styled(Style, String) - Static method in interface org.aya.pretty.doc.Doc
 
styled(Style, Doc) - Static method in interface org.aya.pretty.doc.Doc
 
styled(Styles, String) - Static method in interface org.aya.pretty.doc.Doc
 
styled(Styles, Doc) - Static method in interface org.aya.pretty.doc.Doc
 
Styled(Seq<Style>, Doc) - Constructor for record class org.aya.pretty.doc.Doc.Styled
Creates an instance of a Styled record class.
styleFamily - Variable in class org.aya.pretty.printer.Stylist
predefined styles, see Style.preset(String)
StyleFamily - Interface in org.aya.pretty.printer
 
styleKeyToCss(String) - Static method in class org.aya.pretty.backend.html.Html5Stylist
 
styleName() - Method in record class org.aya.pretty.doc.Style.Preset
Returns the value of the styleName record component.
styles() - Method in record class org.aya.pretty.doc.Doc.Styled
Returns the value of the styles record component.
styles() - Method in record class org.aya.pretty.doc.Styles
Returns the value of the styles record component.
Styles - Record Class in org.aya.pretty.doc
 
Styles(MutableList<Style>) - Constructor for record class org.aya.pretty.doc.Styles
Creates an instance of a Styles record class.
styleToCss(Style) - Static method in class org.aya.pretty.backend.html.Html5Stylist
 
StyleToken(String, String, boolean) - Constructor for record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
 
StyleToken(Consumer<Cursor>, Consumer<Cursor>) - Constructor for record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
Creates an instance of a StyleToken record class.
Stylist - Class in org.aya.pretty.printer
 
Stylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.printer.Stylist
 
supportsCssStyle() - Method in class org.aya.pretty.backend.html.DocHtmlPrinter.Config
Set doc style with html "class" attribute and css block
symbol(String) - Static method in interface org.aya.pretty.doc.Doc
 

T

tabWidth() - Method in interface org.aya.pretty.error.PrettyErrorConfig
Returns the number of spaces occupied by the tab in different terminals.
TerminalBlue - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
TerminalCyan - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
TerminalGreen - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
TerminalPurple - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
TerminalRed - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
TerminalYellow - Enum constant in enum class org.aya.pretty.backend.terminal.UnixTermStyle
 
TeXStylist - Class in org.aya.pretty.backend.latex
 
TeXStylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.latex.TeXStylist
 
text() - Method in record class org.aya.pretty.doc.Doc.EscapedText
Returns the value of the text record component.
text() - Method in record class org.aya.pretty.doc.Doc.PlainText
Returns the value of the text record component.
text() - Method in record class org.aya.pretty.doc.Doc.SpecialSymbol
Returns the value of the text record component.
ThematicBreak - Enum constant in enum class org.aya.pretty.backend.md.MdStyle.GFM
 
toDoc() - Method in interface org.aya.pretty.doc.Doc
 
toDoc() - Method in interface org.aya.pretty.doc.Docile
 
toDoc() - Method in record class org.aya.pretty.error.PrettyError
 
toDoc(PrettyErrorConfig) - Method in record class org.aya.pretty.error.PrettyError
 
toString() - Method in record class org.aya.pretty.backend.md.MdStyle.Heading
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.backend.string.ClosingStylist.StyleToken
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Cat
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.CodeBlock
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Column
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Empty
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.EscapedText
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.FlatAlt
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.HyperLinked
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Image
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.InlineCode
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Line
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.List
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Nest
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Nesting
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.PageWidth
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.PlainText
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.SpecialSymbol
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Styled
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Doc.Union
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Link.DirectLink
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Link.LocalId
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Style.ColorHex
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Style.ColorName
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Style.Preset
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.doc.Styles
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.error.LineColSpan
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.error.PrettyError
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.error.Span.Data
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.style.AyaColorScheme
Returns a string representation of this record class.
toString() - Method in record class org.aya.pretty.style.AyaStyleFamily
Returns a string representation of this record class.
type() - Method in record class org.aya.pretty.doc.Link.LocalId
Returns the value of the type record component.

U

underline() - Static method in interface org.aya.pretty.doc.Style
 
underline() - Method in record class org.aya.pretty.doc.Styles
 
Underline - Enum constant in enum class org.aya.pretty.doc.Style.Attr
 
underlineBegin() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the underlineBegin record component.
underlineBody() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the underlineBody record component.
underlineBody(int) - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
 
underlineBodyDoc(int) - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
 
underlineEnd() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the underlineEnd record component.
unicode - Variable in class org.aya.pretty.backend.string.StringPrinterConfig
 
UNICODE - Static variable in record class org.aya.pretty.error.PrettyError.FormatConfig
 
union(Span.Data) - Method in record class org.aya.pretty.error.Span.Data
 
Union(Doc, Doc) - Constructor for record class org.aya.pretty.doc.Doc.Union
Creates an instance of a Union record class.
UnixTermStyle - Enum Class in org.aya.pretty.backend.terminal
 
UnixTermStylist - Class in org.aya.pretty.backend.terminal
 
UnixTermStylist(ColorScheme, StyleFamily) - Constructor for class org.aya.pretty.backend.terminal.UnixTermStylist
 

V

valueOf(String) - Static method in enum class org.aya.pretty.backend.md.MdStyle.GFM
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.aya.pretty.backend.string.StringPrinter.Outer
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.aya.pretty.backend.terminal.UnixTermStyle
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.aya.pretty.doc.Style.Attr
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.aya.pretty.error.Span.NowLoc
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.aya.pretty.style.AyaStyleKey
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.aya.pretty.backend.md.MdStyle.GFM
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.aya.pretty.backend.string.StringPrinter.Outer
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.aya.pretty.backend.terminal.UnixTermStyle
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.aya.pretty.doc.Style.Attr
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.aya.pretty.error.Span.NowLoc
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.aya.pretty.style.AyaStyleKey
Returns an array containing the constants of this enum class, in the order they are declared.
vbarForHints() - Method in record class org.aya.pretty.error.PrettyError.FormatConfig
Returns the value of the vbarForHints record component.
vcat(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
vcat(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 
vcatNonEmpty(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
vcatNonEmpty(Doc...) - Static method in interface org.aya.pretty.doc.Doc
 
vcommaList(SeqLike<Doc>) - Static method in interface org.aya.pretty.doc.Doc
 
visibleContent(CharSequence) - Method in class org.aya.pretty.backend.string.Cursor
 

W

whenLineUsed(Runnable) - Method in class org.aya.pretty.backend.string.Cursor
Do something when I am not at line start.
withHeader - Variable in class org.aya.pretty.backend.html.DocHtmlPrinter.Config
 
withStyleDef - Variable in class org.aya.pretty.backend.html.DocHtmlPrinter.Config
 
wrap(String, String, Doc) - Static method in interface org.aya.pretty.doc.Doc
 
A B C D E F G H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form