com.realtime.crossfire.jxclient.gui.log

Class Buffer

java.lang.Object

com.realtime.crossfire.jxclient.gui.log.Buffer

Direct Known Subclasses:

DefaultBuffer

public abstract class Buffer
extends java.lang.Object

Manages the contents of the contents of a log window. It consists of a list of Lines.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Buffer(int maxLines, int renderWidth) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addBufferListener(@NotNull BufferListener listener) Adds a listener to notify of changes.
void	addLine(@NotNull Line line) Appends a Line to the end of the buffer.
void	addTextSegment(@NotNull Line line, @NotNull java.lang.String text, boolean bold, boolean italic, boolean underline, @NotNull FontID fontID, @NotNull java.awt.Color color, @NotNull java.awt.Color selectionColor) Appends a TextSegment to the end of a line.
void	clear() Clears all lines from the buffer.
int	coordinateToPosition(int x, int y) Returns the text position for a coordinate.
int	getLastCount() Returns the number of merged lines.
@NotNull Line	getLine(int line) Returns one Line by line index.
protected abstract int	getSegmentWidth(@NotNull TextSegment segment, int characters) Returns the width of a prefix of a TextSegment.
@NotNull java.lang.Object	getSyncObject() Returns the object to synchronize on when calling lines(int).
@NotNull java.lang.String	getText(int beginSelection, int endSelection) Returns the selected text.
int	getTotalHeight() Returns the total height of all lines.
@NotNull java.lang.Iterable<Line>	lines(int line) Returns an Iterator for the lines in this buffer.
boolean	mergeLines(@NotNull java.lang.String text, int type, int subtype, @Nullable java.awt.Color color) Checks whether a new text line should be merged with a preceding line.
protected abstract @NotNull TextSegment	newTextSegment(@NotNull java.lang.String text, boolean bold, boolean italic, boolean underline, @NotNull FontID fontID, @NotNull java.awt.Color color, @NotNull java.awt.Color selectionColor) Creates a new segment.
void	prune() Prunes excess lines.
void	removeBufferListener(@NotNull BufferListener listener) Removes a listener to be notified of changes.
void	replaceLine(@NotNull Line line) Replaces the last Line of this buffer.
void	setRenderWidth(int renderWidth) Updates the width to render.
void	setShowSentCommands(boolean showSentCommands) Sets whether commands sent to the server are shown.
void	setShowTimestamps(boolean showTimestamps) Sets whether timestamps are shown.
int	size() Returns the number of lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

Buffer

protected Buffer(int maxLines,
                 int renderWidth)

Creates a new instance.

Parameters:

maxLines - the maximum number of lines the buffer can hold

renderWidth - the width to render

Method Detail

setRenderWidth

public void setRenderWidth(int renderWidth)

Updates the width to render.

Parameters:

renderWidth - the width to render

setShowSentCommands

public void setShowSentCommands(boolean showSentCommands)

Sets whether commands sent to the server are shown.

Parameters:

showSentCommands - whether commands sent to the server are shown

setShowTimestamps

public void setShowTimestamps(boolean showTimestamps)

Sets whether timestamps are shown.

Parameters:

showTimestamps - whether timestamps are shown

clear

public void clear()

Clears all lines from the buffer.

addLine

public void addLine(@NotNull
                    @NotNull Line line)

Appends a Line to the end of the buffer.

Parameters:

line - the line to append

replaceLine

public void replaceLine(@NotNull
                        @NotNull Line line)

Replaces the last Line of this buffer.

Parameters:

line - the replacing line

prune

public void prune()

Prunes excess lines.

getLine

@NotNull
public @NotNull Line getLine(int line)

Returns one Line by line index. The first line has the index 0.

Parameters:

line - the line index

Returns:

the line

getTotalHeight

public int getTotalHeight()

Returns the total height of all lines.

Returns:

the total height

lines

@NotNull
public @NotNull java.lang.Iterable<Line> lines(int line)

Returns an Iterator for the lines in this buffer.

Parameters:

line - the initial line index of the list iterator

Returns:

the list iterator

size

public int size()

Returns the number of lines.

Returns:

the number of lines

addBufferListener

public void addBufferListener(@NotNull
                              @NotNull BufferListener listener)

Adds a listener to notify of changes.

Parameters:

listener - the listener

removeBufferListener

public void removeBufferListener(@NotNull
                                 @NotNull BufferListener listener)

Removes a listener to be notified of changes.

Parameters:

listener - the listener

getSyncObject

@NotNull
public @NotNull java.lang.Object getSyncObject()

Returns the object to synchronize on when calling lines(int).

Returns:

the object

mergeLines

public boolean mergeLines(@NotNull
                          @NotNull java.lang.String text,
                          int type,
                          int subtype,
                          @Nullable
                          @Nullable java.awt.Color color)

Checks whether a new text line should be merged with a preceding line.

Parameters:

text - the text line contents

type - the message type

subtype - the message subtype

color - the text line color

Returns:

whether the line should be merged

getLastCount

public int getLastCount()

Returns the number of merged lines. Should not be called unless directly after mergeLines(String, int, int, Color) did return true.

Returns:

the number of merged lines

addTextSegment

public void addTextSegment(@NotNull
                           @NotNull Line line,
                           @NotNull
                           @NotNull java.lang.String text,
                           boolean bold,
                           boolean italic,
                           boolean underline,
                           @NotNull
                           @NotNull FontID fontID,
                           @NotNull
                           @NotNull java.awt.Color color,
                           @NotNull
                           @NotNull java.awt.Color selectionColor)

Appends a TextSegment to the end of a line.

Parameters:

line - the line

text - the text to display

bold - whether bold face is enabled

italic - whether italic face is enabled

underline - whether underlining is enabled

fontID - the font to use

color - the color to use

selectionColor - the selection color to use

newTextSegment

@NotNull
protected abstract @NotNull TextSegment newTextSegment(@NotNull
                                                                @NotNull java.lang.String text,
                                                                boolean bold,
                                                                boolean italic,
                                                                boolean underline,
                                                                @NotNull
                                                                @NotNull FontID fontID,
                                                                @NotNull
                                                                @NotNull java.awt.Color color,
                                                                @NotNull
                                                                @NotNull java.awt.Color selectionColor)

Creates a new segment.

Parameters:

text - the text to display

bold - whether bold face is enabled

italic - whether italic face is enabled

underline - whether underlining is enabled

fontID - the font to use

color - the color to use

selectionColor - the selection color to use

Returns:

the new segment

coordinateToPosition

public int coordinateToPosition(int x,
                                int y)

Returns the text position for a coordinate.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

the text position

getSegmentWidth

protected abstract int getSegmentWidth(@NotNull
                                       @NotNull TextSegment segment,
                                       int characters)

Returns the width of a prefix of a TextSegment.

Parameters:

segment - the text segment

characters - the number of characters in the prefix

Returns:

the width in pixels

getText

@NotNull
public @NotNull java.lang.String getText(int beginSelection,
                                                  int endSelection)

Returns the selected text.

Parameters:

beginSelection - the first selected character

endSelection - the first character after the selection

Returns:

the selected text