li.cil.manual.api.prefab.manual

Class AbstractInteractiveImageRenderer

java.lang.Object

li.cil.manual.api.prefab.manual.AbstractInteractiveImageRenderer

All Implemented Interfaces:

ImageRenderer, InteractiveImageRenderer

public abstract class AbstractInteractiveImageRenderer
extends java.lang.Object
implements InteractiveImageRenderer

Simple base implementation of InteractiveImageRenderer.

Constructor Summary

Constructors

Constructor and Description
AbstractInteractiveImageRenderer()

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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getHeight, getWidth, render

Constructor Detail

AbstractInteractiveImageRenderer

public AbstractInteractiveImageRenderer()

Method Detail

getTooltip

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

Description copied from interface: InteractiveImageRenderer

Get a custom tooltip for this image renderer.

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

Specified by:

getTooltip in interface InteractiveImageRenderer

Parameters:

tooltip - the original tooltip of the element.

Returns:

the tooltip to use for the element.

onMouseClick

public boolean onMouseClick(int mouseX,
                            int mouseY)

Description copied from interface: InteractiveImageRenderer

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.

Specified by:

onMouseClick in interface InteractiveImageRenderer

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.