Crossfire JXClient, Trunk
ActivateCommandInputCommand.java
Go to the documentation of this file.
1 /*
2  * This file is part of JXClient, the Fullscreen Java Crossfire Client.
3  *
4  * JXClient is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * JXClient is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with JXClient; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * Copyright (C) 2005-2008 Yann Chachkoff
19  * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
20  * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
21  */
22 
23 package com.realtime.crossfire.jxclient.gui.textinput;
24 
28 import org.jetbrains.annotations.NotNull;
29 
34 public class ActivateCommandInputCommand implements GUICommand2 {
35 
39  @NotNull
41 
45  @NotNull
46  private final String commandText;
47 
51  @NotNull
52  private final Macros macros;
53 
60  public ActivateCommandInputCommand(@NotNull final String commandText, @NotNull final CommandCallback commandCallback, @NotNull final Macros macros) {
61  this.commandText = commandText;
62  this.commandCallback = commandCallback;
63  this.macros = macros;
64  }
65 
66  @Override
67  public boolean canExecute() {
68  return true;
69  }
70 
71  @Override
72  public void execute() {
74  }
75 
76  @NotNull
77  @Override
78  public String getCommandString() {
79  return commandText.isEmpty() ? "-e" : "-e "+commandText;
80  }
81 
82 }
com.realtime.crossfire.jxclient
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.canExecute
boolean canExecute()
Returns whether this command may be executed.
Definition: ActivateCommandInputCommand.java:67
com.realtime.crossfire.jxclient.gui.commandlist.GUICommand2
A GUICommand that has a string representation.
Definition: GUICommand2.java:31
com.realtime.crossfire.jxclient.gui.commandlist.GUICommand
An executable command.
Definition: GUICommand.java:29
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.commandCallback
final CommandCallback commandCallback
The CommandCallback to affect.
Definition: ActivateCommandInputCommand.java:40
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.execute
void execute()
Executes the command.
Definition: ActivateCommandInputCommand.java:72
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.macros
final Macros macros
The Macros instance to use.
Definition: ActivateCommandInputCommand.java:52
com.realtime.crossfire.jxclient.gui.commandlist
Definition: CommandList.java:23
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.ActivateCommandInputCommand
ActivateCommandInputCommand(@NotNull final String commandText, @NotNull final CommandCallback commandCallback, @NotNull final Macros macros)
Creates a new instance.
Definition: ActivateCommandInputCommand.java:60
com.realtime.crossfire.jxclient.settings
Definition: CommandHistory.java:23
com.realtime.crossfire.jxclient.gui.textinput.CommandCallback.activateCommandInput
void activateCommandInput(@NotNull String newText)
Activates the command input text field.
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.getCommandString
String getCommandString()
Returns the command as a string.
Definition: ActivateCommandInputCommand.java:78
com.realtime.crossfire.jxclient.settings.Macros
Manages macro expansion in command strings.
Definition: Macros.java:38
com.realtime.crossfire.jxclient.gui
com.realtime.crossfire
com.realtime.crossfire.jxclient.gui.textinput.CommandCallback
Interface that defines callback functions needed by commands.
Definition: CommandCallback.java:33
com.realtime
com
com.realtime.crossfire.jxclient.settings.Macros.expandMacros
String expandMacros(@NotNull final String string)
Expands all macro references.
Definition: Macros.java:127
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand
A GUICommand which activates the command input field.
Definition: ActivateCommandInputCommand.java:34
com.realtime.crossfire.jxclient.gui.textinput.ActivateCommandInputCommand.commandText
final String commandText
The command text to set.
Definition: ActivateCommandInputCommand.java:46