Package net.runelite.client.ui.overlay

Class WidgetOverlay

java.lang.Object

net.runelite.client.ui.overlay.Overlay

net.runelite.client.ui.overlay.WidgetOverlay

All Implemented Interfaces:

LayoutableRenderableEntity, RenderableEntity

public class WidgetOverlay
extends Overlay

Field Summary

Fields

Modifier and Type	Field	Description
protected Client	client
protected int	componentId
protected String	name

Fields inherited from class net.runelite.client.ui.overlay.Overlay

PRIORITY_DEFAULT, PRIORITY_HIGH, PRIORITY_HIGHEST, PRIORITY_LOW, PRIORITY_MED

Method Summary

Modifier and Type	Method	Description
static Collection<WidgetOverlay>	createOverlays(OverlayManager overlayManager, Client client)
String	getName()	Overlay name, used for saving the overlay, needs to be unique
Rectangle	getParentBounds()	Get the parent bounds for overlay dragging.
Dimension	render(Graphics2D graphics)
void	revalidate()

Methods inherited from class net.runelite.client.ui.overlay.Overlay

addMenuEntry, addMenuEntry, drawAfterInterface, drawAfterLayer, drawAfterLayer, drawAfterLayer, getBounds, getDrawHooks, getLayer, getMenuEntries, getMinimumSize, getPlugin, getPosition, getPreferredLocation, getPreferredPosition, getPreferredSize, getPriority, isDragTargetable, isMovable, isResettable, isResizable, isSnappable, onDrag, onMouseOver, removeMenuEntry, setBounds, setDragTargetable, setLayer, setMinimumSize, setMovable, setPosition, setPreferredLocation, setPreferredPosition, setPreferredSize, setPriority, setPriority, setResettable, setResizable, setSnappable

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final Client client

componentId

@Component
protected final int componentId

name

protected final String name

Method Detail

createOverlays

public static Collection<WidgetOverlay> createOverlays(OverlayManager overlayManager,
                                                       Client client)

getName

public String getName()

Description copied from class: Overlay

Overlay name, used for saving the overlay, needs to be unique

Overrides:

getName in class Overlay

Returns:

overlay name

render

public Dimension render(Graphics2D graphics)

getParentBounds

public Rectangle getParentBounds()

Description copied from class: Overlay

Get the parent bounds for overlay dragging. The overlay will not be allowed to be moved outside of the parent bounds.

Overrides:

getParentBounds in class Overlay

Returns:

revalidate

public void revalidate()

Overrides:

revalidate in class Overlay