li.cil.manual.client.manual.segment

Class LinkSegment

java.lang.Object

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

li.cil.manual.client.manual.segment.LinkSegment

All Implemented Interfaces:

InteractiveSegment, Segment

public final class LinkSegment
extends TextSegment
implements InteractiveSegment

Constructor Summary

Constructors

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

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 boolean	ignoreLeadingWhitespace()
protected static int	indexOfFirstNonWhitespace(java.lang.String s)
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.
void	notifyHover()
boolean	onMouseClick(int mouseX, int mouseY) Should be called by whatever is rendering the document when a left mouse click occurs.
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 li.cil.manual.client.manual.segment.TextSegment

format, lineHeight, parent, refine, render, scale, stringWidth, text

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

checkHovered

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

next, nextX, nextY, parent, refine, render, root, setNext

Constructor Detail

LinkSegment

public LinkSegment(Segment parent,
                   java.lang.String text,
                   java.lang.String url)

Method Detail

color

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

Overrides:

color in class TextSegment

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

toString

public java.lang.String toString()

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.

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