li.cil.tis3d.client.manual

Class Document

java.lang.Object

li.cil.tis3d.client.manual.Document

public final class Document
extends java.lang.Object

Primitive Markdown parser, only supports a very small subset. Used for parsing documentation into segments, to be displayed in a GUI somewhere.

General usage is: parse a string using parse(), render it using render().

The parser generates a list of segments, each segment representing a part of the document, with a specific formatting / render type. For example, links are their own segments, a bold section in a link would be its own section and so on. The data structure is essentially a very flat multi-tree, where the segments returned are the leaves, and the roots are the individual lines, represented as text segments. Formatting is done by accumulating formatting information over the parent nodes, up to the root.

Method Summary

Modifier and Type	Method and Description
static int	height(Segment document, int maxWidth, net.minecraft.client.gui.FontRenderer renderer) Compute the overall height of a document, e.g.
static int	lineHeight(net.minecraft.client.gui.FontRenderer renderer) Line height for a normal line of text.
static Segment	parse(java.lang.Iterable<java.lang.String> document) Parses a plain text document into a list of segments.
static java.util.Optional<InteractiveSegment>	render(Segment document, int x, int y, int maxWidth, int maxHeight, int yOffset, net.minecraft.client.gui.FontRenderer renderer, int mouseX, int mouseY) Renders a list of segments and tooltips if a segment with a tooltip is hovered.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static Segment parse(java.lang.Iterable<java.lang.String> document)

Parses a plain text document into a list of segments.

Parameters:

document - iterator over the lines of the document to parse.

Returns:

the first segment of the parsed document.

height

public static int height(Segment document,
                         int maxWidth,
                         net.minecraft.client.gui.FontRenderer renderer)

Compute the overall height of a document, e.g. for computation of scroll offsets.

Parameters:

document - the document to compute the height of.

maxWidth - the maximum height available.

renderer - the font renderer used.

Returns:

the height of the document.

lineHeight

public static int lineHeight(net.minecraft.client.gui.FontRenderer renderer)

Line height for a normal line of text.

Parameters:

renderer - the font renderer used.

Returns:

the height of a single line.

render

public static java.util.Optional<InteractiveSegment> render(Segment document,
                                                            int x,
                                                            int y,
                                                            int maxWidth,
                                                            int maxHeight,
                                                            int yOffset,
                                                            net.minecraft.client.gui.FontRenderer renderer,
                                                            int mouseX,
                                                            int mouseY)

Renders a list of segments and tooltips if a segment with a tooltip is hovered. Returns the hovered interactive segment, if any.

Parameters:

document - the document to render.

x - the x position to render at.

y - the y position to render at.

maxWidth - the width of the area to render the document in.

maxHeight - the height of the area to render the document in.

yOffset - the vertical scroll offset of the document.

renderer - the font renderer to use.

mouseX - the x position of the mouse.

mouseY - the y position of the mouse.

Returns:

the interactive segment being hovered, if any.