li.cil.manual.client.manual.segment

Interface InteractiveSegment

All Superinterfaces:

Segment

All Known Implementing Classes:

LinkSegment, RenderSegment

public interface InteractiveSegment
extends Segment

Segments that can react to mouse presence and input.

The currently hovered interactive segment is picked in the render process and returned there. Calling code can then decide whether to render the segment's tooltip, for example. It should also notice the currently hovered segment when a left-click occurs.

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<InteractiveSegment>	checkHovered(int mouseX, int mouseY, int x, int y, int w, int h)
void	notifyHover()
boolean	onMouseClick(int mouseX, int mouseY) Should be called by whatever is rendering the document when a left mouse click occurs.
default java.util.Optional<java.lang.String>	tooltip() The tooltip that should be displayed when this segment is being hovered.

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

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

Method Detail

tooltip

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

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

Returns:

the tooltip for this interactive segment, if any.

onMouseClick

boolean onMouseClick(int mouseX,
                     int mouseY)

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.

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

void notifyHover()

checkHovered

default java.util.Optional<InteractiveSegment> checkHovered(int mouseX,
                                                            int mouseY,
                                                            int x,
                                                            int y,
                                                            int w,
                                                            int h)