li.cil.tis3d.client.manual.segment

Class RenderSegment

java.lang.Object

li.cil.tis3d.client.manual.segment.RenderSegment

All Implemented Interfaces:

InteractiveSegment, Segment

public final class RenderSegment
extends java.lang.Object
implements InteractiveSegment

Constructor Summary

Constructors

Constructor and Description
RenderSegment(Segment parent, java.lang.String title, ImageRenderer imageRenderer)

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.
void	notifyHover()
boolean	onMouseClick(int mouseX, int mouseY) Should be called by whatever is rendering the document when a left mouse click occurs.
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)
java.util.Optional<java.lang.String>	tooltip() The tooltip that should be displayed when this segment is being hovered.
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.tis3d.client.manual.segment.InteractiveSegment

checkHovered

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

next, refine, root, setNext

Constructor Detail

RenderSegment

public RenderSegment(Segment parent,
                     java.lang.String title,
                     ImageRenderer imageRenderer)

Method Detail

parent

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.

Specified by:

parent in interface Segment

Returns:

the parent segment.

tooltip

public java.util.Optional<java.lang.String> tooltip()

Description copied from interface: InteractiveSegment

The tooltip that should be displayed when this segment is being hovered.

Specified by:

tooltip in interface InteractiveSegment

Returns:

the tooltip for this interactive segment, if any.

onMouseClick

public boolean onMouseClick(int mouseX,
                            int mouseY)

Description copied from interface: InteractiveSegment

Should be called by whatever is rendering the document when a left mouse click occurs.

The mouse coordinates are expected to be in the same frame of reference as the document.

Specified by:

onMouseClick in interface InteractiveSegment

Parameters:

mouseX - the X coordinate of the mouse cursor.

mouseY - the Y coordinate of the mouse cursor.

Returns:

whether the click was processed (true) or ignored (false).

notifyHover

public void notifyHover()

Specified by:

notifyHover in interface InteractiveSegment

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.

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.

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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.

refine

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

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.

refiner - the callback for successful matches.

Returns:

a list of child segments.

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