Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.commands.ClearCommand Class Reference

Crossfire JXClient, Trunk R20561

Implements the command "clear". More...

Inheritance diagram for com.realtime.crossfire.jxclient.commands.ClearCommand:

Collaboration diagram for com.realtime.crossfire.jxclient.commands.ClearCommand:

Public Member Functions

boolean allArguments ()

Returns whether all remaining commands should be included as arguments.

Returns: whether all remaining commands should be included as arguments

ClearCommand (@NotNull final JXCWindowRenderer windowRenderer, @NotNull final CrossfireServerConnection crossfireServerConnection)

Creates a new instance. More...

void execute (@NotNull final String args)

Executes the command with the given arguments.

Parameters

args	the command arguments

Public Member Functions inherited from com.realtime.crossfire.jxclient.commands.AbstractCommand

String getCommandName ()

Returns the name of the command.

Returns: the name

String toString ()

Private Attributes
final JXCWindowRenderer	windowRenderer
	The JXCWindowRenderer to affect. More...

Additional Inherited Members
Protected Member Functions inherited from com.realtime.crossfire.jxclient.commands.AbstractCommand
	AbstractCommand (@NotNull final String commandName, @NotNull final CrossfireServerConnection crossfireServerConnection)
	Creates a new instance. More...

void	drawInfo (@NotNull final String message)
	Displays a regular output message. More...

void	drawInfo (@NotNull final String message, final int color)
	Displays a message. More...

void	drawInfoError (@NotNull final String message)
	Displays an error message. More...

Detailed Description

Implements the command "clear".

It clears the active message window.

Author: Andreas Kirschbaum

Definition at line 33 of file ClearCommand.java.

Constructor & Destructor Documentation

◆ ClearCommand()

com.realtime.crossfire.jxclient.commands.ClearCommand.ClearCommand	(	@NotNull final JXCWindowRenderer	windowRenderer,
		@NotNull final CrossfireServerConnection	crossfireServerConnection
	)

Creates a new instance.

Parameters

windowRenderer	the window renderer to affect
crossfireServerConnection	the connection instance

Definition at line 46 of file ClearCommand.java.

References com.realtime.crossfire.jxclient.commands.ClearCommand.windowRenderer.

Member Function Documentation

◆ allArguments()

boolean com.realtime.crossfire.jxclient.commands.ClearCommand.allArguments ( )

Returns whether all remaining commands should be included as arguments.

Returns: whether all remaining commands should be included as arguments

Implements com.realtime.crossfire.jxclient.commands.Command.

Definition at line 55 of file ClearCommand.java.

◆ execute()

void com.realtime.crossfire.jxclient.commands.ClearCommand.execute ( @NotNull final String args )

Executes the command with the given arguments.

Parameters

args	the command arguments

Implements com.realtime.crossfire.jxclient.commands.Command.

Definition at line 63 of file ClearCommand.java.

References com.realtime.crossfire.jxclient.gui.log.Buffer.clear(), com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfoError(), and com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.getActiveMessageBuffer().

Here is the call graph for this function:

Member Data Documentation

◆ windowRenderer

final JXCWindowRenderer com.realtime.crossfire.jxclient.commands.ClearCommand.windowRenderer

private

The JXCWindowRenderer to affect.

Definition at line 39 of file ClearCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.ClearCommand.ClearCommand().

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

crossfire-code/jxclient/trunk/src/gui/src/main/java/com/realtime/crossfire/jxclient/commands/ClearCommand.java