Inheritance diagram for com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl:

Public Member Functions
void	reset ()

void	setElement (@NotNull final AbstractGUIElement guiElement)

void	setScreenSize (final int windowWidth, final int windowHeight)

void	setTooltip (@Nullable final AbstractLabel tooltip)

void	tooltipTextChanged (@NotNull final GUIElement element)

void	unsetElement (@NotNull final AbstractGUIElement guiElement)

Private Member Functions
void	addTooltip ()

void	removeTooltip ()

Private Attributes
AbstractGUIElement	activeGuiElement

final Object	activeGuiElementSync = new Object()

final Runnable	resetRunnable

AbstractLabel	tooltip

int	windowHeight

int	windowWidth

Static Private Attributes
static final int	TOOLTIP_DISTANCE = 8

Detailed Description

Manages the tooltip display. An AbstractLabel is moved/resized to display a tooltip text for an "active" GUI element.

Author: Andreas Kirschbaum

Definition at line 38 of file TooltipManagerImpl.java.

Member Function Documentation

◆ addTooltip()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip ( )

private

Adds or updates the tooltip (text and location) for the activeGuiElement.

Definition at line 164 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeTooltip()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.removeTooltip ( )

private

Removes the tooltip label. Does nothing if no tooltip is active.

Definition at line 203 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync, and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.tooltip.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setElement(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.unsetElement().

Here is the caller graph for this function:

◆ reset()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.reset ( )

Removes the tooltip. Does nothing if no tooltip is active.

Definition at line 117 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeAndWait(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.resetRunnable.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.showGUIMain(), com.realtime.crossfire.jxclient.window.GuiManager.showGUIMeta(), and com.realtime.crossfire.jxclient.window.GuiManager.showGUIStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setElement()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setElement ( @NotNull final AbstractGUIElement guiElement )

Displays the tooltip for a GUI element.

Parameters

guiElement the GUI element to show the tooltip of

Implements com.realtime.crossfire.jxclient.gui.gui.TooltipManager.

Definition at line 122 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElement, com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync, com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeAndWait(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.removeTooltip().

Here is the call graph for this function:

◆ setScreenSize()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setScreenSize	(	final int	windowWidth,
		final int	windowHeight
	)

Updates the current window size.

Parameters

windowWidth	the window width
windowHeight	the window height

Definition at line 97 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync, com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.windowHeight, and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.windowWidth.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.updateWindowSize().

Here is the caller graph for this function:

◆ setTooltip()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setTooltip ( @Nullable final AbstractLabel tooltip )

Sets the tooltip label.

Parameters

tooltip

the tooltip label, or

null

Definition at line 108 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync, and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.tooltip.

Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.attach(), and com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.detach().

Here is the caller graph for this function:

◆ tooltipTextChanged()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.tooltipTextChanged ( @NotNull final GUIElement element )

Reports a possibly changed tooltip text.

Parameters

element the GUI element that may have changed

Implements com.realtime.crossfire.jxclient.gui.gui.TooltipManager.

Definition at line 150 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElement, com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync, and com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeLater().

Here is the call graph for this function:

◆ unsetElement()

void com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.unsetElement ( @NotNull final AbstractGUIElement guiElement )

Removes the tooltip of a GUI element. Does nothing if the given GUI element is not active.

Parameters

guiElement the gui element to remove the tooltip of

Implements com.realtime.crossfire.jxclient.gui.gui.TooltipManager.

Definition at line 138 of file TooltipManagerImpl.java.

References com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElement, com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync, com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeAndWait(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.removeTooltip().

Here is the call graph for this function:

Member Data Documentation

◆ activeGuiElement

AbstractGUIElement com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElement

private

The last known active gui element. It is used to suppress unnecessary change events to the tooltip label.

Definition at line 67 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setElement(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.tooltipTextChanged(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.unsetElement().

◆ activeGuiElementSync

final Object com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.activeGuiElementSync = new Object()

private

Synchronizes accesses to activeGuiElement.

Definition at line 73 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.removeTooltip(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setElement(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setScreenSize(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setTooltip(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.tooltipTextChanged(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.unsetElement().

◆ resetRunnable

final Runnable com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.resetRunnable

private

Initial value:

= new Runnable() {
 
        @Override
        public void run() {
            synchronized (activeGuiElementSync) {
                removeTooltip();
                activeGuiElement = null;
            }
        }
 
    }

The Runnable that implements the functionality of reset().

Definition at line 80 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.reset().

◆ tooltip

AbstractLabel com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.tooltip

private

The tooltip label. Set to

null

if the skin does not use tooltips.

Definition at line 60 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.removeTooltip(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setTooltip().

◆ TOOLTIP_DISTANCE

final int com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.TOOLTIP_DISTANCE = 8

staticprivate

Distance of tooltip from its associated GUI element.

Definition at line 43 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip().

◆ windowHeight

int com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.windowHeight

private

The current window height.

Definition at line 53 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setScreenSize().

◆ windowWidth

int com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.windowWidth

private

The current window width.

Definition at line 48 of file TooltipManagerImpl.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), and com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.setScreenSize().

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/label/TooltipManagerImpl.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ addTooltip()

◆ removeTooltip()

◆ reset()

◆ setElement()

◆ setScreenSize()

◆ setTooltip()

◆ tooltipTextChanged()

◆ unsetElement()

Member Data Documentation

◆ activeGuiElement

◆ activeGuiElementSync

◆ resetRunnable

◆ tooltip

◆ TOOLTIP_DISTANCE

◆ windowHeight

◆ windowWidth