com.realtime.crossfire.jxclient.commands

Class ScreenshotCommand

java.lang.Object

com.realtime.crossfire.jxclient.commands.AbstractCommand

com.realtime.crossfire.jxclient.commands.ScreenshotCommand

All Implemented Interfaces:

Command

public class ScreenshotCommand
extends AbstractCommand

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

Constructor Summary

Constructors

Constructor and Description
ScreenshotCommand(@NotNull JXCWindowRenderer windowRenderer, @NotNull CrossfireServerConnection crossfireServerConnection, @NotNull ScreenshotFiles screenshotFiles) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	allArguments() Returns whether all remaining commands should be included as arguments.
void	execute(@NotNull java.lang.String args) Executes the command with the given arguments.
@NotNull java.lang.String	getHelp() Returns the help text for this command.

Methods inherited from class com.realtime.crossfire.jxclient.commands.AbstractCommand

drawInfo, drawInfo, drawInfoError, getCommandName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenshotCommand

public ScreenshotCommand(@NotNull
                         @NotNull JXCWindowRenderer windowRenderer,
                         @NotNull
                         @NotNull CrossfireServerConnection crossfireServerConnection,
                         @NotNull
                         @NotNull 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

Method Detail

allArguments

public boolean allArguments()

Description copied from interface: Command

Returns whether all remaining commands should be included as arguments.

Returns:

whether all remaining commands should be included as arguments

execute

public void execute(@NotNull
                    @NotNull java.lang.String args)

Description copied from interface: Command

Executes the command with the given arguments.

Parameters:

args - the command arguments

getHelp

@NotNull
public @NotNull java.lang.String getHelp()

Description copied from interface: Command

Returns the help text for this command.

Returns:

the help text