com.realtime.crossfire.jxclient.faces
Interface FacesManager

All Known Implementing Classes:
AbstractFacesManager, DefaultFacesManager
public interface FacesManager

Method Summary
 void addFacesManagerListener(FacesManagerListener facesManagerListener)
          Adds a FacesManagerListener to be notified about updated faces.
 Face getFace(int faceNum)
          Returns the Face instance for a given face ID.
 Face getFace2(int faceNum)
          Returns the Face instance for a given face ID.
 javax.swing.ImageIcon getMagicMapImageIcon(int faceNum)
          Returns the "magic map" face for a face ID.
 javax.swing.ImageIcon getOriginalImageIcon(int faceNum)
          Returns the "original" face for a face ID.
 javax.swing.ImageIcon getScaledImageIcon(int faceNum)
          Returns the "scaled" face for a face ID.
 void removeFacesManagerListener(FacesManagerListener facesManagerListener)
          Removes a FacesManagerListener to be notified about updated faces.
 void reset()
          Forgets about pending faces.
 

Method Detail

addFacesManagerListener

void addFacesManagerListener(@NotNull
                             FacesManagerListener facesManagerListener)
Adds a FacesManagerListener to be notified about updated faces.

Parameters:
facesManagerListener - the listener

getFace

@NotNull
Face getFace(int faceNum)
Returns the Face instance for a given face ID. Requests the face face from the server if necessary.

Parameters:
faceNum - the face ID to request
Returns:
the face

getFace2

@Nullable
Face getFace2(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

getMagicMapImageIcon

@NotNull
javax.swing.ImageIcon getMagicMapImageIcon(int faceNum)
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
Returns:
the face, or the "unknown" face if the face is not loaded

getOriginalImageIcon

@NotNull
javax.swing.ImageIcon getOriginalImageIcon(int faceNum)
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
Returns:
the face, or the "unknown" face if the face is not loaded

getScaledImageIcon

@NotNull
javax.swing.ImageIcon getScaledImageIcon(int faceNum)
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
Returns:
the face, or the "unknown" face if the face is not loaded

removeFacesManagerListener

void removeFacesManagerListener(@NotNull
                                FacesManagerListener facesManagerListener)
Removes a FacesManagerListener to be notified about updated faces.

Parameters:
facesManagerListener - the listener

reset

void reset()
Forgets about pending faces.