Collaboration diagram for com.realtime.crossfire.jxclient.gui.misc.MouseTracker:

Public Member Functions
void	mouseClicked (@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e)

void	mouseDragged (@Nullable final GUIElement element, @NotNull final MouseEvent e)

void	mouseEntered (@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e)

void	mouseExited (@NotNull final MouseEvent e)

void	mouseMoved (@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e)

void	mousePressed (@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e)

void	mouseReleased (@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e)

	MouseTracker (final boolean debugGui, @Nullable final Writer debugMouse, @NotNull final GuiFactory guiFactory)

void	mouseWheelMoved (@Nullable final GUIElement element, @NotNull final MouseWheelEvent e)

void	paintActiveComponent (@NotNull final Graphics g)

Private Member Functions
void	debugMouseWrite (@NotNull final CharSequence message)

void	enterElement (@Nullable final AbstractGUIElement element, @NotNull final MouseEvent e)

void	setActiveComponent (@Nullable final AbstractGUIElement activeComponent)

void	setClicked (final boolean isClicked)

void	setDragging (final boolean isDragging)

Static Private Member Functions
static String	formatName (@NotNull final Component component)

Private Attributes
AbstractGUIElement	activeComponent

final Point	clickPosition = new Point()

final boolean	debugGui

final Writer	debugMouse

final GuiFactory	guiFactory

boolean	isClicked

boolean	isDragging

GUIElement	mouseElement

Static Private Attributes
static final int	CLICK_DISTANCE = 20

static final DateTimeFormatter	FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss,SSS ", Locale.ENGLISH)

static final Pattern	PATTERN_PACKAGE_NAME = Pattern.compile(".*\\.")

Detailed Description

Tracks mouse actions and delivers mouse events to affected GUIElement.

XXX: some delivered MouseEvents are not relative to the underlying GUIElement.

Author: Andreas Kirschbaum

Definition at line 55 of file MouseTracker.java.

Constructor & Destructor Documentation

◆ MouseTracker()

com.realtime.crossfire.jxclient.gui.misc.MouseTracker.MouseTracker	(	final boolean	debugGui,
		@Nullable final Writer	debugMouse,
		@NotNull final GuiFactory	guiFactory
	)

Creates a new instance.

Parameters

debugGui	whether GUI elements should be highlighted
debugMouse	the writer to write mouse debug to or null
guiFactory	the global GUI factory instance

Definition at line 126 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugGui, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouse, and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.guiFactory.

Member Function Documentation

◆ debugMouseWrite()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite ( @NotNull final CharSequence message )

private

Writes a message to the mouse debug.

Parameters

message the message to write

Definition at line 334 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouse, and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.FORMATTER.

Here is the caller graph for this function:

◆ enterElement()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement	(	@Nullable final AbstractGUIElement	element,
		@NotNull final MouseEvent	e
	)

private

Sets a new mouseElement and generate entered/exited events.

Parameters

element	the new element; it may be null
e	the event parameter

Definition at line 249 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugGui, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseElement, com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseExited(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setActiveComponent().

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseEntered(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseExited(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseMoved(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseReleased().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatName()

static String com.realtime.crossfire.jxclient.gui.misc.MouseTracker.formatName ( @NotNull final Component component )

staticprivate

Returns the name to display for a Component.

Parameters

component the component

Returns: the name

Definition at line 326 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.PATTERN_PACKAGE_NAME.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.paintActiveComponent().

Here is the caller graph for this function:

◆ mouseClicked()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseClicked	(	@Nullable final AbstractGUIElement	element,
		@NotNull final MouseEvent	e
	)

Handles a mouse clicked event.

Parameters

element	the affected GUI element
e	the mouse event

Definition at line 137 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite().

Here is the call graph for this function:

◆ mouseDragged()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged	(	@Nullable final GUIElement	element,
		@NotNull final MouseEvent	e
	)

Handles a mouse dragged event.

Parameters

element	the affected GUI element
e	the mouse event

Definition at line 147 of file MouseTracker.java.

Here is the call graph for this function:

◆ mouseEntered()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseEntered	(	@Nullable final AbstractGUIElement	element,
		@NotNull final MouseEvent	e
	)

Handles a mouse entered event.

Parameters

element	the affected GUI element
e	the mouse event

Definition at line 224 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isDragging, and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setClicked().

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.openDialogsAdd(), and com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.openDialogsRemove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mouseExited()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseExited ( @NotNull final MouseEvent e )

Handles a mouse exited event.

Parameters

e	the mouse event

Definition at line 236 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isDragging, and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setClicked().

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.openDialogsAdd(), and com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.openDialogsRemove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mouseMoved()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseMoved	(	@Nullable final AbstractGUIElement	element,
		@NotNull final MouseEvent	e
	)

Handles a mouse moved event.

Parameters

element	the affected GUI element
e	the mouse event

Definition at line 171 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseElement, and com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseMoved().

Here is the call graph for this function:

◆ mousePressed()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed	(	@Nullable final AbstractGUIElement	element,
		@NotNull final MouseEvent	e
	)

Handles a mouse pressed event.

Parameters

element	the affected GUI element
e	the mouse event

Definition at line 185 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.clickPosition, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseElement, com.realtime.crossfire.jxclient.gui.gui.GUIElement.mousePressed(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setClicked(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setDragging().

Here is the call graph for this function:

◆ mouseReleased()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseReleased	(	@Nullable final AbstractGUIElement	element,
		@NotNull final MouseEvent	e
	)

Handles a mouse released event.

Parameters

element	the affected GUI element
e	the mouse event

Definition at line 202 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isClicked, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseElement, com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseReleased(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setDragging().

Here is the call graph for this function:

◆ mouseWheelMoved()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseWheelMoved	(	@Nullable final GUIElement	element,
		@NotNull final MouseWheelEvent	e
	)

Handles a mouse wheel event.

Parameters

element	the affected GUI element
e	the mouse wheel event

Definition at line 276 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite().

Here is the call graph for this function:

◆ paintActiveComponent()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.paintActiveComponent ( @NotNull final Graphics g )

Marks the active component in a Graphics instance.

Parameters

g	the graphics

Definition at line 290 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.activeComponent, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.formatName(), com.realtime.crossfire.jxclient.skin.skin.GuiFactory.getElementX(), com.realtime.crossfire.jxclient.skin.skin.GuiFactory.getElementY(), com.realtime.crossfire.jxclient.gui.gui.GuiUtils.getTextDimension(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.guiFactory.

Here is the call graph for this function:

◆ setActiveComponent()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setActiveComponent ( @Nullable final AbstractGUIElement activeComponent )

private

Updates activeComponent. Prints a debug message if the value changes.

Parameters

activeComponent the new value

Definition at line 356 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.activeComponent, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugGui, com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setClicked()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setClicked ( final boolean isClicked )

private

Updates isClicked. Prints a debug message if the value changes.

Parameters

isClicked the new value

Definition at line 405 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isClicked.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseEntered(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseExited(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDragging()

void com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setDragging ( final boolean isDragging )

private

Updates isDragging. Prints a debug message if the value changes.

Parameters

isDragging the new value

Definition at line 392 of file MouseTracker.java.

References com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isDragging.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseReleased().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ activeComponent

AbstractGUIElement com.realtime.crossfire.jxclient.gui.misc.MouseTracker.activeComponent

private

The active component.

Definition at line 102 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.paintActiveComponent(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setActiveComponent().

◆ CLICK_DISTANCE

final int com.realtime.crossfire.jxclient.gui.misc.MouseTracker.CLICK_DISTANCE = 20

staticprivate

The maximum distance the mouse may have moved between the mouse pressed and the mouse released even to generate a mouse clicked event.

Definition at line 61 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged().

◆ clickPosition

final Point com.realtime.crossfire.jxclient.gui.misc.MouseTracker.clickPosition = new Point()

private

The position that was clicked if isClicked is set.

Definition at line 118 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed().

◆ debugGui

final boolean com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugGui

private

Whether GUI elements should be highlighted.

Definition at line 72 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.MouseTracker(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setActiveComponent().

◆ debugMouse

final Writer com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouse

private

The Writer to write mouse debug to or

null

.

Definition at line 78 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.MouseTracker().

◆ FORMATTER

final DateTimeFormatter com.realtime.crossfire.jxclient.gui.misc.MouseTracker.FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss,SSS ", Locale.ENGLISH)

staticprivate

A formatter for timestamps.

Definition at line 90 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.debugMouseWrite().

◆ guiFactory

final GuiFactory com.realtime.crossfire.jxclient.gui.misc.MouseTracker.guiFactory

private

The global GuiFactory instance.

Definition at line 84 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.MouseTracker(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.paintActiveComponent().

◆ isClicked

boolean com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isClicked

private

Whether a button release event is considered a "click".

Definition at line 112 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseReleased(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setClicked().

◆ isDragging

boolean com.realtime.crossfire.jxclient.gui.misc.MouseTracker.isDragging

private

Whether a dragging operation is in progress.

Definition at line 107 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseEntered(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseExited(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.setDragging().

◆ mouseElement

GUIElement com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseElement

private

The gui element in which the mouse is.

Definition at line 96 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseMoved(), com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseReleased().

◆ PATTERN_PACKAGE_NAME

final Pattern com.realtime.crossfire.jxclient.gui.misc.MouseTracker.PATTERN_PACKAGE_NAME = Pattern.compile(".*\\.")

staticprivate

Matches the package name of a fully qualified class name.

Definition at line 67 of file MouseTracker.java.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.formatName().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/misc/MouseTracker.java

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MouseTracker()

Member Function Documentation

◆ debugMouseWrite()

◆ enterElement()

◆ formatName()

◆ mouseClicked()

◆ mouseDragged()

◆ mouseEntered()

◆ mouseExited()

◆ mouseMoved()

◆ mousePressed()

◆ mouseReleased()

◆ mouseWheelMoved()

◆ paintActiveComponent()

◆ setActiveComponent()

◆ setClicked()

◆ setDragging()

Member Data Documentation

◆ activeComponent

◆ CLICK_DISTANCE

◆ clickPosition

◆ debugGui

◆ debugMouse

◆ FORMATTER

◆ guiFactory

◆ isClicked

◆ isDragging

◆ mouseElement

◆ PATTERN_PACKAGE_NAME