li.cil.oc.api.manual

Interface InteractiveImageRenderer

All Superinterfaces:

ImageRenderer

All Known Implementing Classes:

AbstractInteractiveImageRenderer

public interface InteractiveImageRenderer
extends ImageRenderer

Allows implementing advanced image renderers that react to mouse input and specify customized tooltips.

This way you can e.g. disable the default tooltip and render a more advanced one, or render a small GUI on a page.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTooltip(java.lang.String tooltip) Get a custom tooltip for this image renderer.
boolean	onMouseClick(int mouseX, int mouseY) Called when the mouse is clicked while over this image renderer.

Methods inherited from interface li.cil.oc.api.manual.ImageRenderer

getHeight, getWidth, render

Method Detail

getTooltip

java.lang.String getTooltip(java.lang.String tooltip)

Get a custom tooltip for this image renderer.

This can be used to override the original tooltip of an image.

Parameters:

tooltip - the original tooltip of the element.

Returns:

the tooltip to use for the element.

onMouseClick

boolean onMouseClick(int mouseX,
                     int mouseY)

Called when the mouse is clicked while over this image renderer.

This only fires for left-clicks, because right-clicks are reserved for navigating back in the manual.

If this returns false and the element is a link, the link will be followed. If it returns true, it will not.

Parameters:

mouseX - the X coordinate of the mouse, relative to the element.

mouseY - the Y coordinate of the mouse, relative to the element.

Returns:

whether the click was handled.