Inheritance diagram for com.realtime.crossfire.jxclient.faces.AbstractFacesManager:

Collaboration diagram for com.realtime.crossfire.jxclient.faces.AbstractFacesManager:

Public Member Functions
void	addFacesManagerListener (@NotNull final FacesManagerListener facesManagerListener)

Face	getFace (final int faceNum)

Face	getFace2 (final int faceNum)

ImageIcon	getMagicMapImageIcon (final int faceNum, @Nullable final AtomicBoolean returnIsUnknownImage)

ImageIcon	getOriginalImageIcon (final int faceNum, @Nullable final AtomicBoolean returnIsUnknownImage)

ImageIcon	getScaledImageIcon (final int faceNum, @Nullable final AtomicBoolean returnIsUnknownImage)

void	removeFacesManagerListener (@NotNull final FacesManagerListener facesManagerListener)

void	reset ()

Protected Member Functions
	AbstractFacesManager (@NotNull final FaceCache faceCache)

void	fireFaceUpdated (@NotNull final Face face)

abstract FaceImages	getFaceImages (final int faceNum, @Nullable AtomicBoolean returnIsUnknownImage)

Face	lookupFace (final int faceNum)

Private Attributes
final FaceCache	faceCache

final EventListenerList2< FacesManagerListener >	facesManagerListeners = new EventListenerList2<>()

Detailed Description

Abstract base class for FacesManager implementations.

Author: Andreas Kirschbaum

Definition at line 35 of file AbstractFacesManager.java.

Constructor & Destructor Documentation

◆ AbstractFacesManager()

com.realtime.crossfire.jxclient.faces.AbstractFacesManager.AbstractFacesManager ( @NotNull final FaceCache faceCache )

protected

Creates a new instance.

Parameters

faceCache the face cache instance for storing in-memory faces

Definition at line 54 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.faceCache.

Member Function Documentation

◆ addFacesManagerListener()

void com.realtime.crossfire.jxclient.faces.AbstractFacesManager.addFacesManagerListener ( @NotNull final FacesManagerListener facesManagerListener )

Adds a FacesManagerListener to be notified about updated faces.

Parameters

facesManagerListener the listener

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 59 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.facesManagerListeners.

◆ fireFaceUpdated()

void com.realtime.crossfire.jxclient.faces.AbstractFacesManager.fireFaceUpdated ( @NotNull final Face face )

protected

Notifies all FacesManagerListeners that a face has been updated.

Parameters

face the face

Definition at line 73 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.facesManagerListeners.

◆ getFace()

Face com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFace ( final int faceNum )

Returns the Face instance for a given face ID. Requests the face from the server if necessary.

Parameters

faceNum the face ID to request

Returns: the face

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 99 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.faceCache, com.realtime.crossfire.jxclient.faces.FaceCache.getFace(), and com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFaceImages().

Here is the call graph for this function:

◆ getFace2()

Face com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFace2 ( final int faceNum )

Returns the Face instance for a given face ID. Requests the face from the server if necessary.

Parameters

faceNum the face ID to request

Returns: the face or
null

for the empty face

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 130 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.faceCache, com.realtime.crossfire.jxclient.faces.FaceCache.getFace(), and com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFaceImages().

Here is the call graph for this function:

◆ getFaceImages()

abstract FaceImages com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFaceImages	(	final int	faceNum,
		@Nullable AtomicBoolean	returnIsUnknownImage
	)

abstractprotected

Returns the FaceImages information for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters

faceNum	the face ID
returnIsUnknownImage	returns whether the returned face is the "unknown" face; ignored if null

Returns: the face images information

Reimplemented in com.realtime.crossfire.jxclient.faces.DefaultFacesManager, and com.realtime.crossfire.jxclient.faces.TestFacesManager.

Referenced by com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFace(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFace2(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getMagicMapImageIcon(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getOriginalImageIcon(), and com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getScaledImageIcon().

Here is the caller graph for this function:

◆ getMagicMapImageIcon()

ImageIcon com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getMagicMapImageIcon	(	final int	faceNum,
		@Nullable final AtomicBoolean	returnIsUnknownImage
	)

Returns the "magic map" face for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters

faceNum	the face ID
returnIsUnknownImage	returns whether the returned face is the "unknown" face; ignored if null

Returns: the face, or the "unknown" face if the face is not loaded

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 93 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFaceImages(), and com.realtime.crossfire.jxclient.faces.FaceImages.getMagicMapImageIcon().

Here is the call graph for this function:

◆ getOriginalImageIcon()

ImageIcon com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getOriginalImageIcon	(	final int	faceNum,
		@Nullable final AtomicBoolean	returnIsUnknownImage
	)

Returns the "original" face for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters

faceNum	the face ID
returnIsUnknownImage	returns whether the returned face is the "unknown" face; ignored if null

Returns: the face, or the "unknown" face if the face is not loaded

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 81 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFaceImages(), and com.realtime.crossfire.jxclient.faces.FaceImages.getOriginalImageIcon().

Here is the call graph for this function:

◆ getScaledImageIcon()

ImageIcon com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getScaledImageIcon	(	final int	faceNum,
		@Nullable final AtomicBoolean	returnIsUnknownImage
	)

Returns the "scaled" face for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters

faceNum	the face ID
returnIsUnknownImage	returns whether the returned face is the "unknown" face; ignored if null

Returns: the face, or the "unknown" face if the face is not loaded

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 87 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFaceImages(), and com.realtime.crossfire.jxclient.faces.FaceImages.getScaledImageIcon().

Here is the call graph for this function:

◆ lookupFace()

Face com.realtime.crossfire.jxclient.faces.AbstractFacesManager.lookupFace ( final int faceNum )

protected

Returns the Face instance for a given face ID. Other than getFace(int), does not request the face face from the server if unknown.

Parameters

faceNum the face ID to look up

Returns: the face

Definition at line 124 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.faceCache, and com.realtime.crossfire.jxclient.faces.FaceCache.getFace().

Referenced by com.realtime.crossfire.jxclient.faces.TestFacesManager.getFaceImages(), and com.realtime.crossfire.jxclient.faces.DefaultFacesManager.getFaceImages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFacesManagerListener()

void com.realtime.crossfire.jxclient.faces.AbstractFacesManager.removeFacesManagerListener ( @NotNull final FacesManagerListener facesManagerListener )

Removes a FacesManagerListener to be notified about updated faces.

Parameters

facesManagerListener the listener

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Definition at line 64 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.facesManagerListeners.

◆ reset()

void com.realtime.crossfire.jxclient.faces.AbstractFacesManager.reset ( )

Forgets about pending faces.

Implements com.realtime.crossfire.jxclient.faces.FacesManager.

Reimplemented in com.realtime.crossfire.jxclient.faces.DefaultFacesManager.

Definition at line 140 of file AbstractFacesManager.java.

References com.realtime.crossfire.jxclient.faces.AbstractFacesManager.faceCache, and com.realtime.crossfire.jxclient.faces.FaceCache.reset().

Here is the call graph for this function:

Member Data Documentation

◆ faceCache

final FaceCache com.realtime.crossfire.jxclient.faces.AbstractFacesManager.faceCache

private

The FaceCache instance used to look up in-memory faces.

Definition at line 48 of file AbstractFacesManager.java.

Referenced by com.realtime.crossfire.jxclient.faces.AbstractFacesManager.AbstractFacesManager(), com.realtime.crossfire.jxclient.faces.DefaultFacesManager.DefaultFacesManager(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFace(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.getFace2(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.lookupFace(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.reset(), and com.realtime.crossfire.jxclient.faces.TestFacesManager.TestFacesManager().

◆ facesManagerListeners

final EventListenerList2<FacesManagerListener> com.realtime.crossfire.jxclient.faces.AbstractFacesManager.facesManagerListeners = new EventListenerList2<>()

private

The FacesManagerListeners to notify about changed faces.

Definition at line 42 of file AbstractFacesManager.java.

Referenced by com.realtime.crossfire.jxclient.faces.AbstractFacesManager.addFacesManagerListener(), com.realtime.crossfire.jxclient.faces.AbstractFacesManager.fireFaceUpdated(), and com.realtime.crossfire.jxclient.faces.AbstractFacesManager.removeFacesManagerListener().

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

src/model/src/main/java/com/realtime/crossfire/jxclient/faces/AbstractFacesManager.java

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractFacesManager()

Member Function Documentation

◆ addFacesManagerListener()

◆ fireFaceUpdated()

◆ getFace()

◆ getFace2()

◆ getFaceImages()

◆ getMagicMapImageIcon()

◆ getOriginalImageIcon()

◆ getScaledImageIcon()

◆ lookupFace()

◆ removeFacesManagerListener()

◆ reset()

Member Data Documentation

◆ faceCache

◆ facesManagerListeners