li.cil.manual.client.manual.segment

Class HeaderSegment

java.lang.Object

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

li.cil.manual.client.manual.segment.HeaderSegment

All Implemented Interfaces:

Segment

public final class HeaderSegment
extends TextSegment

Field Summary

Fields

Modifier and Type	Field and Description
protected ManualDefinitionImpl	myManual

Constructor Summary

Constructors

Constructor and Description
HeaderSegment(Segment parent, java.lang.String text, int level)

Method Summary

Modifier and Type	Method and Description
protected int	computeWrapIndent(net.minecraft.client.gui.FontRenderer renderer)
protected java.lang.String	format()
ManualDefinitionImpl	getManual()
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.
Segment	root() The root segment, i.e.
protected java.util.Optional<java.lang.Float>	scale()
void	setNext(Segment segment)
java.lang.String	toString()

Methods inherited from class li.cil.manual.client.manual.segment.TextSegment

color, lineHeight, parent, refine, render, 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.Segment

getManual, next, root, setNext

Field Detail

myManual

protected final ManualDefinitionImpl myManual

Constructor Detail

HeaderSegment

public HeaderSegment(Segment parent,
                     java.lang.String text,
                     int level)

Method Detail

scale

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

Overrides:

scale in class TextSegment

format

protected java.lang.String format()

Overrides:

format in class TextSegment

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

getManual

public ManualDefinitionImpl getManual()

Specified by:

getManual in interface Segment