Collaboration diagram for com.realtime.crossfire.jxclient.gui.log.RenderStateManager:

Public Member Functions
boolean	canScrollDown ()

boolean	canScrollUp ()

void	dispose ()

int	getHeight ()

int	getScrollPos ()

int	getTopIndex ()

int	getTopOffset ()

	RenderStateManager (@NotNull final RenderStateListener renderStateListener, @NotNull final Buffer buffer)

void	resetScroll ()

void	scrollDown (final int dy)

void	scrollTo (final int y)

void	scrollUp (final int dy)

void	setHeight (final int height)

void	update (final int oldBufferHeight)

Private Member Functions
void	fireChanges ()

Private Attributes
final Buffer	buffer

final BufferListener	bufferListener

boolean	lastCanScrollDown

boolean	lastCanScrollUp

int	lastScrollPos = -1

int	lastTopIndex = -1

int	lastTopOffset = -1

final RenderState	renderState = new RenderState()

final RenderStateListener	renderStateListener

Detailed Description

Encapsulates the state for rendering a Buffer instance.

Author: Andreas Kirschbaum

Definition at line 32 of file RenderStateManager.java.

Constructor & Destructor Documentation

◆ RenderStateManager()

com.realtime.crossfire.jxclient.gui.log.RenderStateManager.RenderStateManager	(	@NotNull final RenderStateListener	renderStateListener,
		@NotNull final Buffer	buffer
	)

Creates a new instance.

Parameters

renderStateListener	the listener to notify about state changes
buffer	the rendered buffer

Definition at line 111 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.Buffer.addBufferListener(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.bufferListener, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderStateListener.

Here is the call graph for this function:

Member Function Documentation

◆ canScrollDown()

boolean com.realtime.crossfire.jxclient.gui.log.RenderStateManager.canScrollDown ( )

Returns whether scrolling down is possible.

Returns: whether scrolling down is possible

Definition at line 224 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderState.canScrollDown, and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState.

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.autoScroll(), and com.realtime.crossfire.jxclient.gui.log.GUILog.canScroll().

Here is the caller graph for this function:

◆ canScrollUp()

boolean com.realtime.crossfire.jxclient.gui.log.RenderStateManager.canScrollUp ( )

Returns whether scrolling up is possible.

Returns: whether scrolling up is possible

Definition at line 216 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderState.canScrollUp, and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState.

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.autoScroll(), and com.realtime.crossfire.jxclient.gui.log.GUILog.canScroll().

Here is the caller graph for this function:

◆ dispose()

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

Destroys this instance. Must be called when the instance is not needed anymore.

Definition at line 139 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.bufferListener, and com.realtime.crossfire.jxclient.gui.log.Buffer.removeBufferListener().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.dispose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fireChanges()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges ( )

private

Notifies listeners of changes.

Definition at line 231 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.RenderStateManager(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.resetScroll(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.scrollDown(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.scrollTo(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.scrollUp(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHeight()

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.getHeight ( )

Returns the height of the viewable area.

Returns: the height

Definition at line 147 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderState.getHeight(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState.

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.getEndPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScrollPos()

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.getScrollPos ( )

Returns the location of the view area in pixels.

Returns: the location

Definition at line 171 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderState.getScrollPos(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState.

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.getEndPosition(), com.realtime.crossfire.jxclient.gui.log.GUILog.getStartPosition(), com.realtime.crossfire.jxclient.gui.log.GUILog.mouseDragged(), com.realtime.crossfire.jxclient.gui.log.GUILog.mousePressed(), and com.realtime.crossfire.jxclient.gui.log.GUILog.mouseReleased().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTopIndex()

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.getTopIndex ( )

Returns the first line to render.

Returns: the line index

Definition at line 155 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderState.getTopIndex(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState.

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.paintComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTopOffset()

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.getTopOffset ( )

Returns the number of pixels to shift the first displayed line.

Returns: the pixel offset

Definition at line 163 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderState.getTopOffset(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState.

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.paintComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetScroll()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.resetScroll ( )

Resets the scrolling range to default values.

Definition at line 178 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState, and com.realtime.crossfire.jxclient.gui.log.RenderState.scrollToBottom().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.resetScroll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scrollDown()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.scrollDown ( final int dy )

Scrolls down by pixels.

Parameters

dy	the number of pixels to scroll

Definition at line 197 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), com.realtime.crossfire.jxclient.gui.log.RenderState.getScrollPos(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState, and com.realtime.crossfire.jxclient.gui.log.RenderState.scrollTo().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.autoScroll(), and com.realtime.crossfire.jxclient.gui.log.GUILog.scroll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scrollTo()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.scrollTo ( final int y )

Scrolls to a location.

Parameters

y	the location

Definition at line 207 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState, and com.realtime.crossfire.jxclient.gui.log.RenderState.scrollTo().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.scrollTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scrollUp()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.scrollUp ( final int dy )

Scrolls up by pixels.

Parameters

dy	the number of pixels to scroll

Definition at line 187 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), com.realtime.crossfire.jxclient.gui.log.RenderState.getScrollPos(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState, and com.realtime.crossfire.jxclient.gui.log.RenderState.scrollTo().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.autoScroll(), and com.realtime.crossfire.jxclient.gui.log.GUILog.scroll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHeight()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.setHeight ( final int height )

Sets the viewable height in pixel.

Parameters

height the viewable height

Definition at line 122 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState, and com.realtime.crossfire.jxclient.gui.log.RenderState.setHeight().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.GUILog(), and com.realtime.crossfire.jxclient.gui.log.GUILog.setBounds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

void com.realtime.crossfire.jxclient.gui.log.RenderStateManager.update ( final int oldBufferHeight )

Updates the internal state after the buffer has changed.

Parameters

oldBufferHeight the buffer height before the change

Definition at line 130 of file RenderStateManager.java.

References com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer, com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState, and com.realtime.crossfire.jxclient.gui.log.RenderState.update().

Referenced by com.realtime.crossfire.jxclient.gui.log.GUILog.setShowSentCommands(), and com.realtime.crossfire.jxclient.gui.log.GUILog.setShowTimestamps().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ buffer

final Buffer com.realtime.crossfire.jxclient.gui.log.RenderStateManager.buffer

private

The rendered buffer.

Definition at line 44 of file RenderStateManager.java.

◆ bufferListener

final BufferListener com.realtime.crossfire.jxclient.gui.log.RenderStateManager.bufferListener

private

Initial value:

= new BufferListener() {
 
        @Override
        public void lineAdded() {
            renderState.linesAdded(buffer);
            fireChanges();
        }
 
        @Override
        public void lineReplaced() {
            renderState.linesReplaced(buffer);
            fireChanges();
        }
 
        @Override
        public void linesRemoved(@NotNull final List<Line> lines) {
            renderState.linesRemoved(buffer, lines);
            fireChanges();
        }
 
    }

The listener to re-render the window contents after changes.

Definition at line 84 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.dispose(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.RenderStateManager().

◆ lastCanScrollDown

boolean com.realtime.crossfire.jxclient.gui.log.RenderStateManager.lastCanScrollDown

private

The last known result of RenderState#canScrollDown() for renderState. Used to detect changes.

Definition at line 66 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges().

◆ lastCanScrollUp

boolean com.realtime.crossfire.jxclient.gui.log.RenderStateManager.lastCanScrollUp

private

The last known result of RenderState#canScrollUp() for renderState. Used to detect changes.

Definition at line 72 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges().

◆ lastScrollPos

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.lastScrollPos = -1

private

The position in pixels of the viewable window. May be negative if not enough lines are present to fill the whole window.

Definition at line 60 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges().

◆ lastTopIndex

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.lastTopIndex = -1

private

The first line of buffer to display.

Definition at line 49 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges().

◆ lastTopOffset

int com.realtime.crossfire.jxclient.gui.log.RenderStateManager.lastTopOffset = -1

private

The number of pixels to shift the first displayed line.

Definition at line 54 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges().

◆ renderState

final RenderState com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderState = new RenderState()

private

The underlying RenderState instance.

Definition at line 78 of file RenderStateManager.java.

◆ renderStateListener

final RenderStateListener com.realtime.crossfire.jxclient.gui.log.RenderStateManager.renderStateListener

private

The listener to notify about state changes.

Definition at line 38 of file RenderStateManager.java.

Referenced by com.realtime.crossfire.jxclient.gui.log.RenderStateManager.fireChanges(), and com.realtime.crossfire.jxclient.gui.log.RenderStateManager.RenderStateManager().

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/log/RenderStateManager.java

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RenderStateManager()

Member Function Documentation

◆ canScrollDown()

◆ canScrollUp()

◆ dispose()

◆ fireChanges()

◆ getHeight()

◆ getScrollPos()

◆ getTopIndex()

◆ getTopOffset()

◆ resetScroll()

◆ scrollDown()

◆ scrollTo()

◆ scrollUp()

◆ setHeight()

◆ update()

Member Data Documentation

◆ buffer

◆ bufferListener

◆ lastCanScrollDown

◆ lastCanScrollUp

◆ lastScrollPos

◆ lastTopIndex

◆ lastTopOffset

◆ renderState

◆ renderStateListener