Crossfire JXClient, Trunk
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
com.realtime.crossfire.jxclient.gui.log.GUIMessageLog Class Reference
Inheritance diagram for com.realtime.crossfire.jxclient.gui.log.GUIMessageLog:
Inheritance graph
Collaboration diagram for com.realtime.crossfire.jxclient.gui.log.GUIMessageLog:
Collaboration graph

Public Member Functions

void dispose ()
 
TooltipText getTooltip ()
 
 GUIMessageLog (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final CrossfireServerConnection crossfireServerConnection, @Nullable final Image backgroundImage, @NotNull final Fonts fonts, @NotNull final Color defaultColor, @NotNull final Color selectionColor, @NotNull final GuiFactory guiFactory)
 
void notifyOpen ()
 
void setColor (final int index, @NotNull final Color color)
 
void setTypes (@NotNull final MessageTypes types)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.log.GUILog
void addScrollableListener (@NotNull final ScrollableListener listener)
 
boolean canScroll (final int distance)
 
Buffer getBuffer ()
 
void mouseDragged (@NotNull final MouseEvent e)
 
void mousePressed (@NotNull final MouseEvent e)
 
void mouseReleased (@NotNull final MouseEvent e)
 
void mouseWheelMoved (final int wheelRotation)
 
void paintComponent (@NotNull final Graphics g)
 
void removeScrollableListener (@NotNull final ScrollableListener listener)
 
void resetScroll ()
 
void scroll (final int distance)
 
void scrollTo (final int pos)
 
void setBounds (final int x, final int y, final int width, final int height)
 
void setShowSentCommands (final boolean showSentCommands)
 
void setShowTimestamps (final boolean showTimestamps)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
int getDialogBorderBottom ()
 
int getDialogBorderLeft ()
 
int getDialogBorderRight ()
 
int getDialogBorderTop ()
 
String getName ()
 
void inhibitListeners ()
 
boolean isDefault ()
 
boolean isIgnore ()
 
void mouseClicked (@NotNull final MouseEvent e)
 
void mouseEntered (@NotNull final MouseEvent e)
 
void mouseExited (@NotNull final MouseEvent e)
 
void mouseMoved (@NotNull final MouseEvent e)
 
void setChanged ()
 
void setChangedListener (@Nullable final GUIElementChangedListener changedListener)
 
void setDefault (final boolean isDefault)
 
void setIgnore ()
 
String toString ()
 

Private Attributes

final MessageBufferUpdater messageBufferUpdater
 

Static Private Attributes

static final long serialVersionUID = 1
 

Additional Inherited Members

- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.log.GUILog
 GUILog (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final Image backgroundImage, @NotNull final Fonts fonts, @NotNull final GuiFactory guiFactory)
 
- 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 ()
 

Detailed Description

A gui element implementing the message window.

Author
Andreas Kirschbaum

Definition at line 40 of file GUIMessageLog.java.

Constructor & Destructor Documentation

◆ GUIMessageLog()

com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.GUIMessageLog ( @NotNull final TooltipManager  tooltipManager,
@NotNull final GUIElementListener  elementListener,
@NotNull final String  name,
@NotNull final CrossfireServerConnection  crossfireServerConnection,
@Nullable final Image  backgroundImage,
@NotNull final Fonts  fonts,
@NotNull final Color  defaultColor,
@NotNull final Color  selectionColor,
@NotNull final GuiFactory  guiFactory 
)

Creates a new instance.

Parameters
tooltipManagerthe tooltip manager to update
elementListenerthe element listener to notify
namethe name of this element
crossfireServerConnectionthe connection instance
backgroundImagethe background image; may be
null
if unused
fontsthe
Fonts
instance for looking up fonts
defaultColorthe default color to use for text message not specifying a color
selectionColorthe selection color
guiFactorythe global GUI factory instance

Definition at line 67 of file GUIMessageLog.java.

References com.realtime.crossfire.jxclient.gui.log.GUILog.backgroundImage, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener, com.realtime.crossfire.jxclient.gui.log.GUILog.getBuffer(), com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory, com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.messageBufferUpdater, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Here is the call graph for this function:

Member Function Documentation

◆ dispose()

void com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.dispose ( )

Releases all allocated resources.

Reimplemented from com.realtime.crossfire.jxclient.gui.log.GUILog.

Definition at line 73 of file GUIMessageLog.java.

References com.realtime.crossfire.jxclient.gui.log.MessageBufferUpdater.dispose(), and com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.messageBufferUpdater.

Here is the call graph for this function:

◆ getTooltip()

TooltipText com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.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 80 of file GUIMessageLog.java.

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.notifyOpen ( )

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

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

Definition at line 85 of file GUIMessageLog.java.

◆ setColor()

void com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.setColor ( final int  index,
@NotNull final Color  color 
)

Sets a color mapping.

Parameters
indexthe color index to change
colorthe color to map to

Definition at line 93 of file GUIMessageLog.java.

References com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.messageBufferUpdater, and com.realtime.crossfire.jxclient.gui.log.MessageBufferUpdater.setColor().

Here is the call graph for this function:

◆ setTypes()

void com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.setTypes ( @NotNull final MessageTypes  types)

Sets the message types to show.

Parameters
typesthe types to show

Definition at line 101 of file GUIMessageLog.java.

References com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.messageBufferUpdater, and com.realtime.crossfire.jxclient.gui.log.MessageBufferUpdater.setTypes().

Here is the call graph for this function:

Member Data Documentation

◆ messageBufferUpdater

final MessageBufferUpdater com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.messageBufferUpdater
private

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.serialVersionUID = 1
staticprivate

The serial version UID.

Definition at line 45 of file GUIMessageLog.java.


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