A C D E F G H I J K L M O P R S T W

A

AboutDialog - Class in sarj
The dialog window showing credits and contact information regarding SARJ
AboutDialog(JFrame) - Constructor for class sarj.AboutDialog
 
actionPerformed(ActionEvent) - Method in class sarj.AboutDialog
Called as a result of implementing ActionListener
actionPerformed(ActionEvent) - Method in class sarj.ConfigDialog
Called as a result of implementing ActionListener
actionPerformed(ActionEvent) - Method in class sarj.EditScriptDialog
Called as a result of implementing ActionListener
actionPerformed(ActionEvent) - Method in class sarj.GUI
Called as a result of implementing ActionListener
actionPerformed(ActionEvent) - Method in class sarj.LogDialog
Called as a result of implementing ActionListener
actionPerformed(ActionEvent) - Method in class sarj.ScriptButtonPanel
Called as a result of implementing the ActionListener interface
actionPerformed(ActionEvent) - Method in class sarj.ScriptDialog
Called as a result of implementing ActionListener
addEventScript(String, String, boolean) - Method in class sarj.ScriptDialog
Adds details of an event script to the event script table
addNewButton() - Method in class sarj.ScriptButtonPanel
 
addPlayer(String, int, int, String, int, int, String, int) - Method in class sarj.GUI
Adds details of a player to the player table.
addScriptButton(String, String) - Method in class sarj.GUI
Adds a new button to the ScriptButton panel
addScriptButton(String, String) - Method in class sarj.ScriptButtonPanel
Adds a new ScriptButton to the panel
addTeam(String, int, int, int, int) - Method in class sarj.GUI
Adds details of a team to the team table.
associateWith(ScriptButton) - Method in class sarj.EditScriptDialog
Associates this dialog with a particular script button.

C

CANCEL_ICON - Static variable in class sarj.Sarj
 
checkTimedScripts(long) - Method in class sarj.GUI
Checks all of the timed scripts to see if any should run
clearConsole() - Method in class sarj.GUI
Clears the connection console
clearConsole() - Method in class sarj.Sarj
Clears the console on the main window
clearConsole() - Method in interface sarj.ScriptingFacade
Clears the console on the main window
clearPlayerTable() - Method in class sarj.GUI
Clears the table containing the list of currently connected players
clearTeamTable() - Method in class sarj.GUI
Clears the table containing details of each team
ConfigDialog - Class in sarj
The ConfigDialog class contains the components of the Configuration window
ConfigDialog(GUI, String, String) - Constructor for class sarj.ConfigDialog
Creates a new ConfigDialog object
connect(String, int) - Method in class sarj.Connection
Connects to the server with the specified address, on the specified port
connectClient(String, int) - Method in class sarj.Sarj
Connects the client to the specified IP and port
connectClient() - Method in class sarj.Sarj
Connects the client to the IP and port displayed on the main window
connectClient(String, int) - Method in interface sarj.ScriptingFacade
Connects the client to the specified IP and port
connectClient() - Method in interface sarj.ScriptingFacade
Connects the client to the IP and port displayed on the main window
connected() - Method in class sarj.GUI
Updates the GUI components to show that the user is connected.
Connection - Class in sarj
The Connection class manages a connection with a Soldat server
Connection(ConnectionListener) - Constructor for class sarj.Connection
Creates a new Connection object tied to the specified ConnectionListener
ConnectionListener - Interface in sarj
Defines a listener interface for a events generated by a connection with a Soldat server

D

disconnect() - Method in class sarj.Connection
Closes any open connection to a Soldat server
disconnectClient() - Method in class sarj.Sarj
Disconnects the client from any connected server
disconnectClient() - Method in interface sarj.ScriptingFacade
Disconnects the client from any connected server
disconnected() - Method in class sarj.GUI
Updates the GUI components to show that the user is disconnected.
dispatchScript(String) - Method in class sarj.Sarj
Runs the specified script file

E

EditScriptDialog - Class in sarj
A small dialog allowing the user to change the name and filename of a script button
EditScriptDialog(JFrame, String, ScriptButtonPanel) - Constructor for class sarj.EditScriptDialog
Constructor
EventNotFoundException - Exception in sarj
An exception thrown when a specified scripting event cannot be found
EventNotFoundException(String) - Constructor for exception sarj.EventNotFoundException
Constructor
executeScript(String, String[], String[]) - Method in interface scripting.InterpreterDriver
Executes the script code contained within the specified string
executeScript(String, String, String[], String[]) - Static method in class scripting.InterpreterDriverManager
Execute a script string Execute the string supplied according to the langauge specified
executeScript(String, String[], String[]) - Method in class scripting.JSInterpreterDriver
Executes the specified JavaScript/EcmaScript code
executeScriptFile(String, String[], String[]) - Method in interface scripting.InterpreterDriver
Executes script contained within a file
executeScriptFile(String, String[], String[]) - Static method in class scripting.InterpreterDriverManager
Exceute a script file.
executeScriptFile(String, String[], String[]) - Method in class scripting.JSInterpreterDriver
Executes JavaScript/Ecma code contained in the specified file
EXTENSION_es - Static variable in class sarj.EditScriptDialog
 
EXTENSION_es - Static variable in class sarj.ScriptDialog
 
EXTENSION_js - Static variable in class sarj.EditScriptDialog
 
EXTENSION_js - Static variable in class sarj.ScriptDialog
 

F

focusGained(FocusEvent) - Method in class sarj.ScriptDialog
Called as a result of implementing FocusListener
focusLost(FocusEvent) - Method in class sarj.ScriptDialog
Called as a result of implementing FocusListener
formatTime(int) - Static method in class sarj.Sarj
Formats seconds into mm:ss format

G

getCommandBox() - Method in class sarj.GUI
Returns the value of the command combo box field on the main window
getCommandBox() - Method in class sarj.Sarj
Returns the value of the command combo box on the main window
getCommandBox() - Method in interface sarj.ScriptingFacade
Returns the value of the command combo box on the main window
getCurrentMap() - Method in class sarj.Sarj
Returns the name of the map currently being played on the server
getCurrentMap() - Method in interface sarj.ScriptingFacade
Returns the name of the map currently being played on the server
getFilenameForEvent(String) - Method in class sarj.GUI
Returns the name of the file to execute for the specified event
getFilenameForEvent(String) - Method in class sarj.ScriptDialog
Returns the script file path associated with the specified event
getGameType() - Method in class sarj.Sarj
Returns the type of game running on the server
getGameType() - Method in interface sarj.ScriptingFacade
Returns the type of game running on the server
getIPField() - Method in class sarj.GUI
Returns the current value stored in the IP address field on the main window
getIPField() - Method in class sarj.Sarj
Returns the value of the IP field on the main window
getIPField() - Method in interface sarj.ScriptingFacade
Returns the value of the IP field on the main window
getMainFrame() - Method in class sarj.GUI
Returns the GUI's main window frame
getName() - Method in class sarj.ScriptButton
Returns a String containing the name of the button
getNumPlayers() - Method in class sarj.Sarj
Returns the number of players connected to the server
getNumPlayers() - Method in interface sarj.ScriptingFacade
Returns the number of players connected to the server
getPasswordField() - Method in class sarj.GUI
Returns the current value stored in the password field on the main window
getPasswordField() - Method in class sarj.Sarj
Returns the current value stored in the password field on the main window
getPasswordField() - Method in interface sarj.ScriptingFacade
Returns the current value stored in the password field on the main window
getPlayerData(String) - Method in class sarj.GUI
Returns the row of the player table with the player name matching that provided
getPlayerData() - Method in class sarj.GUI
Returns all the data in the player table
getPlayerData(String) - Method in class sarj.Sarj
Returns the row of the player table with the player name matching that provided
getPlayerData() - Method in class sarj.Sarj
Returns all data within the player table on the main window
getPlayerData(String) - Method in interface sarj.ScriptingFacade
Returns the row of the player table with the player name matching that provided
getPlayerData() - Method in interface sarj.ScriptingFacade
Returns all data within the player table on the main window
getPortField() - Method in class sarj.GUI
Returns the current value stored in the port field on the main window
getPortField() - Method in class sarj.Sarj
Returns the value of the port field on the main window
getPortField() - Method in interface sarj.ScriptingFacade
Returns the value of the port field on the main window
getScoreLimit() - Method in class sarj.Sarj
Returns the score limit of the game
getScoreLimit() - Method in interface sarj.ScriptingFacade
Returns the score limit of the game
getScriptButtons() - Method in class sarj.GUI
Returns the buttons on the ScriptButton panel
getScriptButtons() - Method in class sarj.ScriptButtonPanel
Returns the buttons on the ScriptButton panel
getScriptFile() - Method in class sarj.ScriptButton
Returns a String containing the filename of the script to execute when the button is clicked
getSupportedExtensions() - Method in interface scripting.InterpreterDriver
Returns a list of all file extensions associated with the interpreter
getSupportedExtensions() - Method in class scripting.JSInterpreterDriver
Returns the list of file extensions supported by this interpreter
getSupportedLanguages() - Method in interface scripting.InterpreterDriver
Returns a list of all languages supported by the interpreter
getSupportedLanguages() - Method in class scripting.JSInterpreterDriver
Returns the list of languages supported by this interpreter
getTeamData(String) - Method in class sarj.GUI
Returns the row of the team table with the team name matching that provided
getTeamData() - Method in class sarj.GUI
Returns all the data in the team table
getTeamData(String) - Method in class sarj.Sarj
Returns the row of the team table with the team name matching that provided
getTeamData() - Method in class sarj.Sarj
Returns all data within the team table on the main window
getTeamData(String) - Method in interface sarj.ScriptingFacade
Returns the row of the team table with the team name matching that provided
getTeamData() - Method in interface sarj.ScriptingFacade
Returns all data within the team table on the main window
getTimedScriptDetails() - Method in class sarj.ScriptDialog
Returns the details of all the interval based or specific time based scripts
getTimeLeft() - Method in class sarj.Sarj
Returns the time left within the current game
getTimeLeft() - Method in interface sarj.ScriptingFacade
Returns the time left within the current game
getTimeLimit() - Method in class sarj.Sarj
Returns the time limit of the current game
getTimeLimit() - Method in interface sarj.ScriptingFacade
Returns the time limit of the current game
getUIClassNameFromConfigFile(String) - Static method in class sarj.ConfigDialog
Returns the name of the UI style (Java/Windows) from the file with the path specified.
getWindowTitle() - Method in class sarj.Sarj
Returns the main SARJ window title
getWindowTitle() - Method in interface sarj.ScriptingFacade
Returns the main SARJ window title
GUI - Class in sarj
The GUI class contains all the Swing components that comprise the SARJ Graphical User Interface
GUI(String, String, String, GUIListener) - Constructor for class sarj.GUI
Creates a new GUI object.
GUIListener - Interface in sarj
Defines a listener interface for events generated by user interaction with the GUI

H

hide() - Method in class sarj.GUI
Hide the GUI

I

ImagePanel - Class in sarj
A custom Swing component to show an image in a panel
ImagePanel(String) - Constructor for class sarj.ImagePanel
 
instance() - Static method in class sarj.Sarj
Returns the instance of the SARJ program
InterpreterDriver - Interface in scripting
Defines the interface for a driver for a scripting language interpreter
InterpreterDriver.InterpreterException - Exception in scripting
An object of this class is thrown when an exception is generated while the interpreter is executing a script
InterpreterDriver.InterpreterException(Exception) - Constructor for exception scripting.InterpreterDriver.InterpreterException
 
InterpreterDriverManager - Class in scripting
Class for managing interpreter drivers.
isClosed() - Method in class sarj.Connection
Tests whether or not the connection socket is closed
isConnected() - Method in class sarj.Connection
Tests whether or not the connection socket is connected
isEventEnabled(String) - Method in class sarj.GUI
Returns whether or not the specified event is enabled
isEventEnabled(String) - Method in class sarj.ScriptDialog
Returns whether or not the specified event is enabled
itemStateChanged(ItemEvent) - Method in class sarj.ConfigDialog
Called as a result of implementing ItemListener

J

JSInterpreterDriver - Class in scripting
JavaScript / EcmaScript implementation of a language interpreter.
JSInterpreterDriver() - Constructor for class scripting.JSInterpreterDriver
Default constructor

K

keyPressed(KeyEvent) - Method in class sarj.GUI
Called as a result of implementing KeyListener
keyPressed(KeyEvent) - Method in class sarj.LogDialog
Called as a result of implementing KeyListener
keyReleased(KeyEvent) - Method in class sarj.GUI
Called as a result of implementing KeyListener
keyReleased(KeyEvent) - Method in class sarj.LogDialog
Called as a result of implementing KeyListener
keyTyped(KeyEvent) - Method in class sarj.GUI
Called as a result of implementing KeyListener
keyTyped(KeyEvent) - Method in class sarj.LogDialog
Called as a result of implementing KeyListener

L

loadSettings() - Method in class sarj.ConfigDialog
Loads settings from the file with the path specified in the configFile field
loadSettings() - Method in class sarj.ScriptButtonPanel
Loads the script buttons from the settings file
loadSettings() - Method in class sarj.ScriptDialog
Loads the script dialog settings from the settings file
LogDialog - Class in sarj
The log console dialog for displaying error messages
LogDialog() - Constructor for class sarj.LogDialog
Default constructor

M

main(String[]) - Static method in class sarj.Sarj
The main method
mouseClicked(MouseEvent) - Method in class sarj.GUI
 
mouseClicked(MouseEvent) - Method in class sarj.ScriptButtonPanel
Not implemented
mouseEntered(MouseEvent) - Method in class sarj.GUI
 
mouseEntered(MouseEvent) - Method in class sarj.ScriptButtonPanel
Not implemented
mouseExited(MouseEvent) - Method in class sarj.GUI
 
mouseExited(MouseEvent) - Method in class sarj.ScriptButtonPanel
Not implemented
mousePressed(MouseEvent) - Method in class sarj.GUI
 
mousePressed(MouseEvent) - Method in class sarj.ScriptButtonPanel
Tests to see if the popup menu needs to be shown
mouseReleased(MouseEvent) - Method in class sarj.GUI
 
mouseReleased(MouseEvent) - Method in class sarj.ScriptButtonPanel
Tests to see if the popup menu needs to be shown

O

OK_ICON - Static variable in class sarj.Sarj
 
onAction(int) - Method in interface sarj.GUIListener
Called when the Perform button is clicked on the GUI
onAction(int) - Method in class sarj.Sarj
Called when the Perform button is clicked on the GUI
onAddAdmin(String) - Method in interface sarj.GUIListener
Called when the user chooses to add a player to the remote administrators list
onAddAdmin(String) - Method in class sarj.Sarj
Called when the user chooses to add a player to the remote administrators list
onBanPlayer(int) - Method in interface sarj.GUIListener
Called when the user chooses to ban a player from the list of currently connected players
onBanPlayer(int) - Method in class sarj.Sarj
Called when the user chooses to ban a player from the list of currently connected players
onCommand(String) - Method in interface sarj.GUIListener
Called when a command is sent from the user
onCommand(String) - Method in class sarj.Sarj
Called when a command is sent from the user
onConnect(String, int, String) - Method in interface sarj.GUIListener
Called when the Connect button is clicked on the GUI
onConnect(String, int, String) - Method in class sarj.Sarj
Called when the Connect button is clicked on the GUI
onConnected() - Method in interface sarj.ConnectionListener
Called when a connection is successfully established with a server, as a result of calling the connect method of a Connection object.
onConnected() - Method in class sarj.Sarj
Called when a connection is successfully established with a server, as a result of calling the connect method of a Connection object.
onDisconnect() - Method in interface sarj.GUIListener
Called when the Disconnect button is clicked on the GUI
onDisconnect() - Method in class sarj.Sarj
Called when the Disconnect button is clicked on the GUI
onDisconnected() - Method in interface sarj.ConnectionListener
Called when a connection to a server is lost, either gracefully or due to error
onDisconnected() - Method in class sarj.Sarj
Called when a connection to a server is lost, either gracefully or due to error
onError(String) - Method in interface sarj.ConnectionListener
Called when a connection error occurrs
onError(String) - Method in class sarj.Sarj
Called when a connection error occurrs
onExit() - Method in interface sarj.GUIListener
Called when the Exit button is clicked on the GUI, or the main GUI window is closed
onExit() - Method in class sarj.Sarj
Called when the Exit button is clicked on the GUI, or the main GUI window is closed
onKickPlayer(int) - Method in interface sarj.GUIListener
Called when the user chooses to kick a player from the list of currently connected players
onKickPlayer(int) - Method in class sarj.Sarj
Called when the user chooses to kick a player from the list of currently connected players
onRefresh() - Method in interface sarj.GUIListener
Called when the Refresh button is clicked on the GUI, or the refresh timer triggers
onRefresh() - Method in class sarj.Sarj
Called when the Refresh button is clicked on the GUI, or the refresh timer triggers
onRemoveAdmin(String) - Method in interface sarj.GUIListener
Called when the user chooses to remove a player from the remote administrators list
onRemoveAdmin(String) - Method in class sarj.Sarj
Called when the user chooses to remove a player from the remote administrators list
onScriptButtonClick(String, String) - Method in interface sarj.GUIListener
Called when a user clicks a ScriptButton
onScriptButtonClick(String, String) - Method in class sarj.Sarj
Called when the user clicks on a ScriptButton
onSetTeam(int, int) - Method in interface sarj.GUIListener
Called when the user chooses to assign a connected player to a particular team
onSetTeam(int, int) - Method in class sarj.Sarj
Called when the user chooses to assign a connected player to a particular team

P

paint(Graphics) - Method in class sarj.ImagePanel
Paints the image on to the panel
printError(String) - Static method in class sarj.GUI
Displays error messages in the log console
printError(String) - Method in class sarj.LogDialog
Prints an error to the console area and to standard err
printError(String) - Static method in class sarj.Sarj
Displays error messages

R

read() - Method in class sarj.Connection
Reads a single character from an open connection.
readString() - Method in class sarj.Connection
Reads characters up to and including a newline character from the connection socket
registerDriver(InterpreterDriver) - Static method in class scripting.InterpreterDriverManager
Register a driver.
removeScriptButton(String) - Method in class sarj.GUI
Removes a button from the ScriptButton panel
removeScriptButton(String) - Method in class sarj.ScriptButtonPanel
Removes a button from the script button panel
removeScriptButton(ScriptButton) - Method in class sarj.ScriptButtonPanel
Removes a button from the script button panel
run() - Method in class sarj.Sarj
Called when the main execution thread is started by a call to Thread.start()
run() - Method in class scripting.JSInterpreterDriver
Interprets a script in a new thread

S

sarj - package sarj
 
Sarj - Class in sarj
The main SARJ application class
Sarj() - Constructor for class sarj.Sarj
 
Sarj() - Method in class sarj.Sarj
Default constructor
saveSettings() - Method in class sarj.ConfigDialog
Saves the current settings to the file with the path specified in the configFile field
saveSettings() - Method in class sarj.ScriptButtonPanel
Saves the script buttons to the settings file
saveSettings() - Method in class sarj.ScriptDialog
Saves the script settings to the settings file
ScriptButton - Class in sarj
The ScriptButton class is a specialised button that contains an associated name and filename of a script to execute when clicked.
ScriptButton(String, String) - Constructor for class sarj.ScriptButton
Creates a new QuickButton object with the specigied name and script file
ScriptButtonPanel - Class in sarj
A custom swing component to hold all of the script buttons in one panel
ScriptButtonPanel(JFrame, String, GUIListener) - Constructor for class sarj.ScriptButtonPanel
Default constructor
ScriptDialog - Class in sarj
Contains details of all time and event based scripts
ScriptDialog(GUI, String, String) - Constructor for class sarj.ScriptDialog
Script dialog constructor
scripting - package scripting
 
ScriptingFacade - Interface in sarj
This interface provides a basic set of functions to make scripting easier.
sendData(String) - Method in class sarj.Connection
Sends data to the connected Soldat server
sendData(String) - Method in class sarj.Sarj
Sends data to a connected server
sendData(String) - Method in interface sarj.ScriptingFacade
Sends data to a connected server
setAutoRefresh(boolean) - Method in class sarj.GUI
Sets the automatic refresh timer to on or off
setCommandBox(String) - Method in class sarj.GUI
Sets the command combo box field on the main window to the specified string
setCommandBox(String) - Method in class sarj.Sarj
Sets the command combo box field on the main window
setCommandBox(String) - Method in interface sarj.ScriptingFacade
Sets the command combo box field on the main window
setGameType(String) - Method in class sarj.GUI
Sets the game type label on the main window to the one specified
setIPField(String) - Method in class sarj.GUI
Sets the server address text field on the main window to the one specified
setIPField(String) - Method in class sarj.Sarj
Sets the IP field on the main window
setIPField(String) - Method in interface sarj.ScriptingFacade
Sets the IP field on the main window
setMapName(String) - Method in class sarj.GUI
Sets the map name label on the main window to the one specified
setName(String) - Method in class sarj.ScriptButton
Sets the name of the button
setPasswordField(String) - Method in class sarj.GUI
Sets the password field on the main window to the specified string
setPasswordField(String) - Method in class sarj.Sarj
Sets the password field on the main window
setPasswordField(String) - Method in interface sarj.ScriptingFacade
Sets the password field on the main window
setPortField(String) - Method in class sarj.GUI
Sets the port number text field on the main window to the one specified
setPortField(String) - Method in class sarj.Sarj
Sets the port field on the main window
setPortField(String) - Method in interface sarj.ScriptingFacade
Sets the port field on the main window
setRefreshDelay(int) - Method in class sarj.GUI
Sets the delay of the refresh timer for refreshing the player details
setScoreLimit(String) - Method in class sarj.GUI
Sets the score limit label on the main window to the one specified
setScriptFile(String) - Method in class sarj.ScriptButton
Sets the script file associated with the button
setTimeLeft(String) - Method in class sarj.GUI
Sets the time left label on the main window to the one specified
setTimeLimit(String) - Method in class sarj.GUI
Sets the time limit label on the main window to the one specified
setTitle(String) - Method in class sarj.GUI
Sets the window title of the GUI
setVariable(String, String) - Method in interface scripting.InterpreterDriver
Sets a variable/member to the specified value
setVariable(String, String) - Static method in class scripting.InterpreterDriverManager
Sets a variable/member to the specified value for all registered drivers
setVariable(String, String) - Method in class scripting.JSInterpreterDriver
Sets a variable/member to the specified value
setVisible(boolean) - Method in class sarj.ScriptDialog
Overridden to disable the 'script details' related components
setWindowTitle(String) - Method in class sarj.Sarj
Sets the main SARJ window title to that specified
setWindowTitle(String) - Method in interface sarj.ScriptingFacade
Sets the main SARJ window title to that specified
show() - Method in class sarj.GUI
Display the GUI
skip(int) - Method in class sarj.Connection
Skips the specified number of bytes of data waiting on the connection socket
startRefreshTimer(int) - Method in class sarj.GUI
Starts the automatic refresh timer with the specified millisecond delay
STATE_CONNECTED - Static variable in class sarj.GUI
 
STATE_DISCONNECTED - Static variable in class sarj.GUI
 
stopRefreshTimer() - Method in class sarj.GUI
Stops the automatic refresh timer

T

toString() - Method in exception sarj.EventNotFoundException
Returns a string representation of this exception
toString() - Method in class sarj.ScriptButton
Returns a string representation of the button
toString() - Method in exception scripting.InterpreterDriver.InterpreterException
 

W

windowClosing(WindowEvent) - Method in class sarj.GUI
Called when the main window is being closed
writeToConsole(String) - Method in class sarj.GUI
Writes the specified string of text to the main console
writeToConsole(String) - Method in class sarj.Sarj
Writes text to the main command console
writeToConsole(String) - Method in interface sarj.ScriptingFacade
Writes text to the main command console

A C D E F G H I J K L M O P R S T W