Module aya.pretty

Package org.aya.pretty.backend.html

Class DocHtmlPrinter<Config extends DocHtmlPrinter.Config>

java.lang.Object

org.aya.pretty.backend.string.StringPrinter<Config>

org.aya.pretty.backend.html.DocHtmlPrinter<Config>

All Implemented Interfaces:

Printer<String,Config>

Direct Known Subclasses:

DocMdPrinter

public class DocHtmlPrinter<Config extends DocHtmlPrinter.Config>
extends StringPrinter<Config>

Html backend, which ignores page width.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocHtmlPrinter.Config

Nested classes/interfaces inherited from class org.aya.pretty.backend.string.StringPrinter

StringPrinter.Outer

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull kala.collection.immutable.ImmutableMap<String,String>	entityMapping
static final @NotNull Pattern	entityPattern	Mozilla doc: entity Added backslash for vitepress compatibility.

Fields inherited from class org.aya.pretty.backend.string.StringPrinter

config, FREE

Constructor Summary

Constructors

Constructor	Description
DocHtmlPrinter()

Method Summary

Modifier and Type	Method	Description
protected @NotNull String	escapePlainText(@NotNull String content, EnumSet<StringPrinter.Outer> outer)
static @NotNull String	normalizeHref(@NotNull Link linkId)
static @NotNull String	normalizeId(@NotNull Link linkId)
protected @NotNull StringStylist	prepareStylist()
protected void	renderCodeBlock(@NotNull Cursor cursor, @NotNull Doc.CodeBlock block, EnumSet<StringPrinter.Outer> outer)
protected void	renderCssStyle(@NotNull Cursor cursor)
protected void	renderFooter(@NotNull Cursor cursor)
protected void	renderHardLineBreak(@NotNull Cursor cursor, EnumSet<StringPrinter.Outer> outer)
protected void	renderHeader(@NotNull Cursor cursor)
protected void	renderHyperLinked(@NotNull Cursor cursor, @NotNull Doc.HyperLinked text, EnumSet<StringPrinter.Outer> outer)
protected void	renderImage(@NotNull Cursor cursor, @NotNull Doc.Image image, EnumSet<StringPrinter.Outer> outer)
protected void	renderInlineCode(@NotNull Cursor cursor, @NotNull Doc.InlineCode code, EnumSet<StringPrinter.Outer> outer)
protected void	renderList(@NotNull Cursor cursor, @NotNull Doc.List list, EnumSet<StringPrinter.Outer> outer)

Methods inherited from class org.aya.pretty.backend.string.StringPrinter

fitsBetter, makeIndent, predictWidth, render, renderDoc, renderFlatAlt, renderList, renderNest, renderPlainText, renderSpecialSymbol, renderStyled, renderUnionDoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

entityPattern

@NotNull
public static final @NotNull Pattern entityPattern

Mozilla doc: entity Added backslash for vitepress compatibility.

entityMapping

@NotNull
public static final @NotNull kala.collection.immutable.ImmutableMap<String,String> entityMapping

Constructor Details

DocHtmlPrinter

public DocHtmlPrinter()

Method Details

renderHeader

protected void renderHeader(@NotNull
 @NotNull Cursor cursor)

Overrides:

renderHeader in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderFooter

protected void renderFooter(@NotNull
 @NotNull Cursor cursor)

Overrides:

renderFooter in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderCssStyle

protected void renderCssStyle(@NotNull
 @NotNull Cursor cursor)

prepareStylist

@NotNull
protected @NotNull StringStylist prepareStylist()

Overrides:

prepareStylist in class StringPrinter<Config extends DocHtmlPrinter.Config>

escapePlainText

@NotNull
protected @NotNull String escapePlainText(@NotNull
 @NotNull String content,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

escapePlainText in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderHyperLinked

protected void renderHyperLinked(@NotNull
 @NotNull Cursor cursor,
 @NotNull Doc.HyperLinked text,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

renderHyperLinked in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderImage

protected void renderImage(@NotNull
 @NotNull Cursor cursor,
 @NotNull Doc.Image image,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

renderImage in class StringPrinter<Config extends DocHtmlPrinter.Config>

normalizeId

@NotNull
public static @NotNull String normalizeId(@NotNull
 @NotNull Link linkId)

normalizeHref

@NotNull
public static @NotNull String normalizeHref(@NotNull
 @NotNull Link linkId)

renderHardLineBreak

protected void renderHardLineBreak(@NotNull
 @NotNull Cursor cursor,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

renderHardLineBreak in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderInlineCode

protected void renderInlineCode(@NotNull
 @NotNull Cursor cursor,
 @NotNull Doc.InlineCode code,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

renderInlineCode in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderCodeBlock

protected void renderCodeBlock(@NotNull
 @NotNull Cursor cursor,
 @NotNull Doc.CodeBlock block,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

renderCodeBlock in class StringPrinter<Config extends DocHtmlPrinter.Config>

renderList

protected void renderList(@NotNull
 @NotNull Cursor cursor,
 @NotNull Doc.List list,
 EnumSet<StringPrinter.Outer> outer)

Overrides:

renderList in class StringPrinter<Config extends DocHtmlPrinter.Config>