Package com.realtime.crossfire.jxclient.gui.log

Class GUILog

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

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

All Implemented Interfaces:

GUIElement, GUIScrollable, GUIScrollable2, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

GUILabelLog, GUIMessageLog

public abstract class GUILog
extends AbstractGUIElement
implements GUIScrollable2

Abstract base class for gui elements implementing text fields.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GUILog(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull String name, @Nullable Image backgroundImage, @NotNull Fonts fonts, @NotNull GuiFactory guiFactory)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addScrollableListener(@NotNull ScrollableListener listener)	Adds a scrollable listener to be informed about changes.
boolean	canScroll(int distance)	Returns whether scrolling is possible.
void	dispose()	Releases all allocated resources.
@NotNull Buffer	getBuffer()	Returns the Buffer instance containing the text messages.
void	mouseDragged(@NotNull MouseEvent e)	Will be called when the mouse moves within this component while the button is pressed.
void	mousePressed(@NotNull MouseEvent e)	Will be called when the user has pressed the mouse inside this element.
void	mouseReleased(@NotNull MouseEvent e)	Will be called when the user has released the mouse.
void	mouseWheelMoved(int wheelRotation)	Will be called when the mouse wheel has been moved.
void	paintComponent(@NotNull Graphics g)
void	removeScrollableListener(@NotNull ScrollableListener listener)	Removes a scrollable listener.
void	resetScroll()	Resets the scroll index to the default value.
void	scroll(int distance)	Scrolls the element.
void	scrollTo(int pos)	Scrolls to the given location.
void	setBounds(int x, int y, int width, int height)
void	setShowSentCommands(boolean showSentCommands)	Sets whether the commands sent to the server should be shown.
void	setShowTimestamps(boolean showTimestamps)	Sets whether the timestamps are shown.

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, getTooltip, inhibitListeners, isDefault, isIgnore, mouseClicked, mouseEntered, mouseExited, mouseMoved, newTooltipText, setChanged, setChangedListener, setDefault, setIgnore, tooltipChanged, toString

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.realtime.crossfire.jxclient.gui.gui.GUIElement

notifyOpen

Constructor Details

GUILog

protected GUILog(@NotNull
 @NotNull TooltipManager tooltipManager,
 @NotNull
 @NotNull GUIElementListener elementListener,
 @NotNull
 @NotNull String name,
 @Nullable
 @Nullable Image backgroundImage,
 @NotNull
 @NotNull Fonts fonts,
 @NotNull
 @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

backgroundImage - the background image; may be null if unused

fonts - the Fonts instance for looking up fonts

guiFactory - the global GUI factory instance

Method Details

dispose

public void dispose()

Description copied from interface: GUIElement

Releases all allocated resources.

Specified by:

dispose in interface GUIElement

Overrides:

dispose in class AbstractGUIElement

paintComponent

public void paintComponent(@NotNull
 @NotNull Graphics g)

Overrides:

paintComponent in class JComponent

canScroll

public boolean canScroll(int distance)

Description copied from interface: GUIScrollable

Returns whether scrolling is possible.

Specified by:

canScroll in interface GUIScrollable

Parameters:

distance - the distance to scroll

Returns:

whether scrolling is possible

scroll

public void scroll(int distance)

Description copied from interface: GUIScrollable

Scrolls the element.

Specified by:

scroll in interface GUIScrollable

Parameters:

distance - the distance to scroll

resetScroll

public void resetScroll()

Description copied from interface: GUIScrollable

Resets the scroll index to the default value.

Specified by:

resetScroll in interface GUIScrollable

scrollTo

public void scrollTo(int pos)

Description copied from interface: GUIScrollable2

Scrolls to the given location. The possible range is given by a previous notification through a listener registered with GUIScrollable2.addScrollableListener(ScrollableListener).

Specified by:

scrollTo in interface GUIScrollable2

Parameters:

pos - the location to scroll to

addScrollableListener

public void addScrollableListener(@NotNull
 @NotNull ScrollableListener listener)

Description copied from interface: GUIScrollable2

Adds a scrollable listener to be informed about changes.

Specified by:

addScrollableListener in interface GUIScrollable2

Parameters:

listener - the listener to add

removeScrollableListener

public void removeScrollableListener(@NotNull
 @NotNull ScrollableListener listener)

Description copied from interface: GUIScrollable2

Removes a scrollable listener.

Specified by:

removeScrollableListener in interface GUIScrollable2

Parameters:

listener - the listener to remove

getBuffer

@NotNull
public @NotNull Buffer getBuffer()

Returns the Buffer instance containing the text messages.

Returns:

the buffer instance

setBounds

public void setBounds(int x,
 int y,
 int width,
 int height)

Overrides:

setBounds in class Component

mousePressed

public void mousePressed(@NotNull
 @NotNull MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has pressed the mouse inside this element.

Specified by:

mousePressed in interface GUIElement

Overrides:

mousePressed in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseReleased

public void mouseReleased(@NotNull
 @NotNull MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has released the mouse. This event may be delivered even if no previous GUIElement.mousePressed(MouseEvent) has been delivered before.

Specified by:

mouseReleased in interface GUIElement

Overrides:

mouseReleased in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseDragged

public void mouseDragged(@NotNull
 @NotNull MouseEvent e)

Description copied from interface: GUIElement

Will be called when the mouse moves within this component while the button is pressed. This event will be delivered after GUIElement.mouseMoved(MouseEvent).

Note: if the mouse leaves this element's bounding box while the mouse button is still pressed, further mouseDragged (but no mouseMoved) events will be generated.

Specified by:

mouseDragged in interface GUIElement

Overrides:

mouseDragged in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseWheelMoved

public void mouseWheelMoved(int wheelRotation)

Description copied from interface: GUIElement

Will be called when the mouse wheel has been moved.

Specified by:

mouseWheelMoved in interface GUIElement

Overrides:

mouseWheelMoved in class AbstractGUIElement

Parameters:

wheelRotation - the movement amount; negative=away from the user, positive=towards the user

setShowSentCommands

public void setShowSentCommands(boolean showSentCommands)

Sets whether the commands sent to the server should be shown.

Parameters:

showSentCommands - whether to show the commands

setShowTimestamps

public void setShowTimestamps(boolean showTimestamps)

Sets whether the timestamps are shown.

Parameters:

showTimestamps - whether timestamps are shown