li.cil.manual.client.manual.segment

Class TextSegment

java.lang.Object

li.cil.manual.client.manual.segment.TextSegment

All Implemented Interfaces:

Segment

Direct Known Subclasses:

BoldSegment, HeaderSegment, ItalicSegment, LinkSegment, StrikethroughSegment

public class TextSegment
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TextSegment(Segment parent, java.lang.String text)

Method Summary

Modifier and Type	Method and Description
protected java.util.Optional<java.lang.Integer>	color()
protected int	computeWrapIndent(net.minecraft.client.gui.FontRenderer renderer)
protected java.lang.String	format()
protected boolean	ignoreLeadingWhitespace()
protected static int	indexOfFirstNonWhitespace(java.lang.String s)
protected int	lineHeight(net.minecraft.client.gui.FontRenderer renderer)
protected int	maxChars(java.lang.String s, int maxWidth, int maxLineWidth, net.minecraft.client.gui.FontRenderer renderer)
Segment	next() Set after construction of document, used for formatting, specifically to compute the height for last segment on a line (to force a new line).
int	nextX(int indent, int maxWidth, net.minecraft.client.gui.FontRenderer renderer) Get the X coordinate at which to render the next segment.
int	nextY(int indent, int maxWidth, net.minecraft.client.gui.FontRenderer renderer) Get the Y coordinate at which to render the next segment.
Segment	parent() Parent segment, i.e.
java.lang.Iterable<Segment>	refine(java.util.regex.Pattern pattern, SegmentRefiner factory) Used during construction, checks a segment for inner segments.
java.util.Optional<InteractiveSegment>	render(int x, int y, int indent, int maxWidth, net.minecraft.client.gui.FontRenderer renderer, int mouseX, int mouseY) Render the segment at the specified coordinates with the specified properties.
Segment	root() The root segment, i.e.
protected java.util.Optional<java.lang.Float>	scale()
void	setNext(Segment segment)
protected int	stringWidth(java.lang.String s, net.minecraft.client.gui.FontRenderer renderer)
protected java.lang.String	text()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface li.cil.manual.client.manual.segment.Segment

next, root, setNext

Constructor Detail

TextSegment

public TextSegment(@Nullable
                   Segment parent,
                   java.lang.String text)

Method Detail

parent

@Nullable
public Segment parent()

Description copied from interface: Segment

Parent segment, i.e. the segment this segment was refined from. Each line starts as a TextSegment that is refined based into segments based on the handled formatting rules / patterns.

Returns:

the parent segment.

text

protected java.lang.String text()

render

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

Description copied from interface: Segment

Render the segment at the specified coordinates with the specified properties.

Specified by:

render in interface Segment

Parameters:

x - the x position to render at.

y - the y position to render at.

indent - the current indentation.

maxWidth - the maximum width of the document.

renderer - the font renderer to use.

mouseX - the x mouse position.

mouseY - the y mouse position.

Returns:

the hovered interactive segment, if any.

refine

public java.lang.Iterable<Segment> refine(java.util.regex.Pattern pattern,
                                          SegmentRefiner factory)

Description copied from interface: Segment

Used during construction, checks a segment for inner segments.

Specified by:

refine in interface Segment

Parameters:

pattern - the regex pattern used for refinement.

factory - the callback for successful matches.

Returns:

a list of child segments.

lineHeight

protected int lineHeight(net.minecraft.client.gui.FontRenderer renderer)

stringWidth

protected int stringWidth(java.lang.String s,
                          net.minecraft.client.gui.FontRenderer renderer)

color

protected java.util.Optional<java.lang.Integer> color()

scale

protected java.util.Optional<java.lang.Float> scale()

format

protected java.lang.String format()

nextX

public int nextX(int indent,
                 int maxWidth,
                 net.minecraft.client.gui.FontRenderer renderer)

Description copied from interface: Segment

Get the X coordinate at which to render the next segment.

For flowing/inline segments this will be to the right of the last line this segment renders, for block segments it will be at the start of the next line below this segment.

The coordinates in this context are relative to (0,0).

Specified by:

nextX in interface Segment

Parameters:

indent - the current indentation.

maxWidth - the maximum width of the document.

renderer - the font renderer used.

Returns:

the x position of the next segment.

nextY

public int nextY(int indent,
                 int maxWidth,
                 net.minecraft.client.gui.FontRenderer renderer)

Description copied from interface: Segment

Get the Y coordinate at which to render the next segment.

For flowing/inline segments this will be the same level as the last line this segment renders, unless it's the last segment on its line. For block segments and last-on-line segments this will be the next line after.

The coordinates in this context are relative to (0,0).

Specified by:

nextY in interface Segment

Parameters:

indent - the current indentation.

maxWidth - the maximum width of the document.

renderer - the font renderer used.

Returns:

the y position of the next segment.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

ignoreLeadingWhitespace

protected boolean ignoreLeadingWhitespace()

maxChars

protected int maxChars(java.lang.String s,
                       int maxWidth,
                       int maxLineWidth,
                       net.minecraft.client.gui.FontRenderer renderer)

computeWrapIndent

protected int computeWrapIndent(net.minecraft.client.gui.FontRenderer renderer)

indexOfFirstNonWhitespace

protected static int indexOfFirstNonWhitespace(java.lang.String s)

root

public Segment root()

Description copied from interface: Segment

The root segment, i.e. the original parent of this segment.

Specified by:

root in interface Segment

Returns:

the root segment.

next

public Segment next()

Description copied from interface: Segment

Set after construction of document, used for formatting, specifically to compute the height for last segment on a line (to force a new line).

Specified by:

next in interface Segment

Returns:

the next segment in the linked list of segments.

setNext

public void setNext(@Nullable
                    Segment segment)

Specified by:

setNext in interface Segment