Inheritance diagram for com.realtime.crossfire.jxclient.gui.list.GUICharacter:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.list.GUICharacter:

Public Member Functions
boolean	canScroll (final int distance)

void	execute ()

int	getIndex ()

Dimension	getMinimumSize ()

Dimension	getPreferredSize ()

TooltipText	getTooltip ()

	GUICharacter (@NotNull final TooltipManager tooltipManager, @NotNull final FacesManager facesManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int w, final int h, @NotNull final Font font, final int defaultIndex, final CharacterModel characterModel, @NotNull final GuiFactory guiFactory)

void	notifyOpen ()

void	paintComponent (@NotNull final Graphics g)

void	resetScroll ()

void	scroll (final int distance)

void	setIndex (final int index)

void	setSelected (final boolean selected)

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
void	activateNextElement ()

void	activatePrevElement ()

boolean	isActive ()

void	mousePressed (@NotNull final MouseEvent e)

void	setActive (final boolean active)

void	setNextActive (@NotNull final ActivatableGUIElement next)

void	setPrevActive (@NotNull final ActivatableGUIElement prev)

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
void	dispose ()

int	getDialogBorderBottom ()

int	getDialogBorderLeft ()

int	getDialogBorderRight ()

int	getDialogBorderTop ()

String	getName ()

void	inhibitListeners ()

boolean	isDefault ()

boolean	isIgnore ()

void	mouseClicked (@NotNull final MouseEvent e)

void	mouseDragged (@NotNull final MouseEvent e)

void	mouseEntered (@NotNull final MouseEvent e)

void	mouseExited (@NotNull final MouseEvent e)

void	mouseMoved (@NotNull final MouseEvent e)

void	mouseReleased (@NotNull final MouseEvent e)

void	mouseWheelMoved (final int wheelRotation)

void	setChanged ()

void	setChangedListener (@Nullable final GUIElementChangedListener changedListener)

void	setDefault (final boolean isDefault)

void	setIgnore ()

String	toString ()

Protected Member Functions
void	activeChanged ()

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
	ActivatableGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)

void	markInactivePending ()

void	setInactiveIfPending ()

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
	AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)

TooltipText	newTooltipText (@Nullable final String tooltipText)

void	tooltipChanged ()

Private Member Functions
Dimension	getMinimumSizeInt ()

Private Attributes
final CharacterInformationListener	characterInformationListener

final CharacterModel	characterModel

final FacesManager	facesManager

final Font	font

int	index

boolean	selected

Static Private Attributes
static final long	serialVersionUID = 1

Detailed Description

A character displaying GUI element.

Author: Nicolas Weeger

Definition at line 47 of file GUICharacter.java.

Constructor & Destructor Documentation

◆ GUICharacter()

com.realtime.crossfire.jxclient.gui.list.GUICharacter.GUICharacter	(	@NotNull final TooltipManager	tooltipManager,
		@NotNull final FacesManager	facesManager,
		@NotNull final GUIElementListener	elementListener,
		@NotNull final String	name,
		final int	w,
		final int	h,
		@NotNull final Font	font,
		final int	defaultIndex,
		final CharacterModel	characterModel,
		@NotNull final GuiFactory	guiFactory
	)

Creates a new instance.

Parameters

tooltipManager	the tooltip manager to update
facesManager	the faces to use to display
elementListener	the element listener to notify
name	the name of this element
w	the width for drawing this element to screen
h	the height for drawing this element to screen
font	the font to use
defaultIndex	the initial metaserver index
characterModel	the character model to monitor
guiFactory	the global GUI factory instance

Definition at line 103 of file GUICharacter.java.

Member Function Documentation

◆ activeChanged()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.activeChanged ( )

protected

Will be called whenever the active state has changed.

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.

Definition at line 113 of file GUICharacter.java.

◆ canScroll()

boolean com.realtime.crossfire.jxclient.gui.list.GUICharacter.canScroll ( final int distance )

Returns whether scrolling is possible.

Parameters

distance the distance to scroll

Returns: whether scrolling is possible

Implements com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable.

Definition at line 171 of file GUICharacter.java.

◆ execute()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.execute ( )

Executes the actions associated with this GUI element. Does nothing if this element has no associated actions.

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.

Definition at line 223 of file GUICharacter.java.

◆ getIndex()

int com.realtime.crossfire.jxclient.gui.list.GUICharacter.getIndex ( )

Returns the index of this element.

Returns: the index

Definition at line 189 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.gui.list.GUICharacter.index.

◆ getMinimumSize()

Dimension com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSize ( )

Definition at line 156 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSizeInt().

Here is the call graph for this function:

◆ getMinimumSizeInt()

Dimension com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSizeInt ( )

private

Returns the minimal size needed to display this component.

Returns: the minimal size

Definition at line 165 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.gui.list.GUICharacter.characterModel, com.realtime.crossfire.jxclient.gui.list.GUICharacter.font, com.realtime.crossfire.jxclient.account.CharacterModel.getEntry(), com.realtime.crossfire.jxclient.account.CharacterInformation.getName(), com.realtime.crossfire.jxclient.gui.gui.GuiUtils.getTextDimension(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.index.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSize(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.getPreferredSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPreferredSize()

Dimension com.realtime.crossfire.jxclient.gui.list.GUICharacter.getPreferredSize ( )

Definition at line 149 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSizeInt().

Here is the call graph for this function:

◆ getTooltip()

TooltipText com.realtime.crossfire.jxclient.gui.list.GUICharacter.getTooltip ( )

Returns the current tooltip text.

Returns: the tooltip text or
null

to not show a tooltip

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

Definition at line 233 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.gui.list.GUICharacter.characterModel, com.realtime.crossfire.jxclient.account.CharacterModel.getEntry(), com.realtime.crossfire.jxclient.account.CharacterInformation.getName(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.index, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.newTooltipText().

Here is the call graph for this function:

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.notifyOpen ( )

Called each time the enclosing dialog is opened (or raised).

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 228 of file GUICharacter.java.

◆ paintComponent()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent ( @NotNull final Graphics g )

Definition at line 118 of file GUICharacter.java.

Here is the call graph for this function:

◆ resetScroll()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.resetScroll ( )

Resets the scroll index to the default value.

Implements com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable.

Definition at line 181 of file GUICharacter.java.

◆ scroll()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.scroll ( final int distance )

Scrolls the element.

Parameters

distance the distance to scroll

Implements com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable.

Definition at line 176 of file GUICharacter.java.

◆ setIndex()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.setIndex ( final int index )

Sets the index of this element.

Parameters

index the index

Definition at line 197 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.account.CharacterModel.addCharacterInformationListener(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.characterInformationListener, com.realtime.crossfire.jxclient.gui.list.GUICharacter.characterModel, com.realtime.crossfire.jxclient.gui.list.GUICharacter.index, com.realtime.crossfire.jxclient.account.CharacterModel.removeCharacterInformationListener(), com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipChanged().

Here is the call graph for this function:

◆ setSelected()

void com.realtime.crossfire.jxclient.gui.list.GUICharacter.setSelected ( final boolean selected )

Sets the selected state.

Parameters

selected whether this element should be drawn as "selected"

Definition at line 213 of file GUICharacter.java.

References com.realtime.crossfire.jxclient.gui.list.GUICharacter.selected, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

Here is the call graph for this function:

Member Data Documentation

◆ characterInformationListener

final CharacterInformationListener com.realtime.crossfire.jxclient.gui.list.GUICharacter.characterInformationListener

private

Initial value:

= () -> {
        setChanged();
        tooltipChanged();
    }

All listeners to the entry itself.

Definition at line 85 of file GUICharacter.java.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.setIndex().

◆ characterModel

final CharacterModel com.realtime.crossfire.jxclient.gui.list.GUICharacter.characterModel

private

Character model to display items from.

Definition at line 63 of file GUICharacter.java.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSizeInt(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.getTooltip(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.GUICharacter(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.setIndex().

◆ facesManager

final FacesManager com.realtime.crossfire.jxclient.gui.list.GUICharacter.facesManager

private

The FacesManager to use to display faces.

Definition at line 58 of file GUICharacter.java.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.GUICharacter(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent().

◆ font

final Font com.realtime.crossfire.jxclient.gui.list.GUICharacter.font

private

The font to use.

Definition at line 74 of file GUICharacter.java.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSizeInt(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.GUICharacter(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent().

◆ index

int com.realtime.crossfire.jxclient.gui.list.GUICharacter.index

private

Index of the item to display in characterModel.

Definition at line 68 of file GUICharacter.java.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.getIndex(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.getMinimumSizeInt(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.getTooltip(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.GUICharacter(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.setIndex().

◆ selected

boolean com.realtime.crossfire.jxclient.gui.list.GUICharacter.selected

private

If set, paint the element in "selected" state.

Definition at line 79 of file GUICharacter.java.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent(), and com.realtime.crossfire.jxclient.gui.list.GUICharacter.setSelected().

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.list.GUICharacter.serialVersionUID = 1

staticprivate

The serial version UID.

Definition at line 52 of file GUICharacter.java.

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/list/GUICharacter.java

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GUICharacter()

Member Function Documentation

◆ activeChanged()

◆ canScroll()

◆ execute()

◆ getIndex()

◆ getMinimumSize()

◆ getMinimumSizeInt()

◆ getPreferredSize()

◆ getTooltip()

◆ notifyOpen()

◆ paintComponent()

◆ resetScroll()

◆ scroll()

◆ setIndex()

◆ setSelected()

Member Data Documentation

◆ characterInformationListener

◆ characterModel

◆ facesManager

◆ font

◆ index

◆ selected

◆ serialVersionUID