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

Implements the "screenshot" command. More...

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

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
More...
 
void execute (@NotNull final String args)
 Executes the command with the given arguments.
Parameters
argsthe command arguments
More...
 
 ScreenshotCommand (@NotNull final JXCWindowRenderer windowRenderer, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final ScreenshotFiles screenshotFiles)
 Creates a new instance. More...
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.commands.AbstractCommand
String getCommandName ()
 Returns the name of the command.
Returns
the name
More...
 
String toString ()
 

Private Attributes

final ScreenshotFiles screenshotFiles
 The ScreenshotFiles instance for creating screenshot file names. More...
 
final JXCWindowRenderer windowRenderer
 The renderer to use. 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 "screenshot" command.

It write the current window contents into a .png file.

Author
Andreas Kirschbaum

Definition at line 40 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
windowRendererthe renderer to use
crossfireServerConnectionthe connection instance
screenshotFilesthe screenshot files instance for creating screenshot file names

Definition at line 61 of file ScreenshotCommand.java.

References 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 71 of file ScreenshotCommand.java.

◆ execute()

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 52 of file ScreenshotCommand.java.

Referenced by 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 46 of file ScreenshotCommand.java.

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


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