li.cil.tis3d.client.manual.segment

Interface Segment

All Known Subinterfaces:

InteractiveSegment

All Known Implementing Classes:

BoldSegment, CodeSegment, HeaderSegment, ItalicSegment, LinkSegment, RenderSegment, StrikethroughSegment, TextSegment

public interface Segment

Method Summary

Modifier and Type	Method and Description
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 refiner) 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.
void	setNext(Segment segment)

Method Detail

parent

@Nullable
Segment parent()

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.

root

Segment root()

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

Returns:

the root segment.

nextX

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

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).

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

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

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).

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.

render

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.

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

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

Used during construction, checks a segment for inner segments.

Parameters:

pattern - the regex pattern used for refinement.

refiner - the callback for successful matches.

Returns:

a list of child segments.

next

@Nullable
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).

Returns:

the next segment in the linked list of segments.

setNext

void setNext(Segment segment)