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

Crossfire JXClient, Trunk

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

Inheritance graph

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

Collaboration graph

Public Member Functions
boolean	allArguments ()

void	execute (@NotNull final String args)

String	getHelp ()

	ScreenshotCommand (@NotNull final JXCWindowRenderer windowRenderer, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final ScreenshotFiles screenshotFiles)

Public Member Functions inherited from com.realtime.crossfire.jxclient.commands.AbstractCommand
String	getCommandName ()

String	toString ()

Private Attributes
final ScreenshotFiles	screenshotFiles

final JXCWindowRenderer	windowRenderer

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

void	drawInfo (@NotNull final String message)

void	drawInfo (@NotNull final String message, final int color)

void	drawInfoError (@NotNull final String message)

Detailed Description

Implements the "screenshot" command. It writes the current window contents into a .png file.

Author: Andreas Kirschbaum

Definition at line 42 of file ScreenshotCommand.java.

Constructor & Destructor Documentation

◆ ScreenshotCommand()

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

Creates a new instance.

Parameters

windowRenderer	the renderer to use
crossfireServerConnection	the connection instance
screenshotFiles	the screenshot files instance for creating screenshot file names

Definition at line 63 of file ScreenshotCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.crossfireServerConnection, com.realtime.crossfire.jxclient.commands.ScreenshotCommand.screenshotFiles, and com.realtime.crossfire.jxclient.commands.ScreenshotCommand.windowRenderer.

Member Function Documentation

◆ allArguments()

boolean com.realtime.crossfire.jxclient.commands.ScreenshotCommand.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 70 of file ScreenshotCommand.java.

◆ execute()

void com.realtime.crossfire.jxclient.commands.ScreenshotCommand.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 75 of file ScreenshotCommand.java.

References com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfo(), com.realtime.crossfire.jxclient.commands.AbstractCommand.drawInfoError(), com.realtime.crossfire.jxclient.gui.commands.ScreenshotFiles.getFile(), com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.getWindowHeight(), com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.getWindowWidth(), com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.redraw(), com.realtime.crossfire.jxclient.commands.ScreenshotCommand.screenshotFiles, and com.realtime.crossfire.jxclient.commands.ScreenshotCommand.windowRenderer.

Here is the call graph for this function:

◆ getHelp()

String com.realtime.crossfire.jxclient.commands.ScreenshotCommand.getHelp ( )

Returns the help text for this command.

Returns: the help text

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

Definition at line 112 of file ScreenshotCommand.java.

Member Data Documentation

◆ screenshotFiles

final ScreenshotFiles com.realtime.crossfire.jxclient.commands.ScreenshotCommand.screenshotFiles

private

The ScreenshotFiles instance for creating screenshot file names.

Definition at line 54 of file ScreenshotCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.ScreenshotCommand.execute(), and com.realtime.crossfire.jxclient.commands.ScreenshotCommand.ScreenshotCommand().

◆ windowRenderer

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

private

The renderer to use.

Definition at line 48 of file ScreenshotCommand.java.

Referenced by com.realtime.crossfire.jxclient.commands.ScreenshotCommand.execute(), and com.realtime.crossfire.jxclient.commands.ScreenshotCommand.ScreenshotCommand().

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/commands/ScreenshotCommand.java