Gui

java.lang.Object
- com.putable.client.gui.Gui

```
public class Gui
extends java.lang.Object
```
This class is for the client this is what he/she sees when they login to our games.

Version:

1.0

Author:

Heineken

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Gui.CellListener` This class is used to add some form listening from the user mouse to the specified cell.
`class`	`Gui.KeyDispatcher` A class to dispatch Key events
`private class`	`Gui.MyListCellRenderer` This little class is so the agents in the list panel can still display the background behind it.

Field Summary

Fields
Modifier and Type	Field and Description
`private javax.swing.DefaultListModel`	`agentListModel` These are other elements that belong to a certain panel.
`private javax.swing.JScrollPane`	`agentScrollPane`
`private HeinekenList`	`agentsList`
`private HeinekenPanel`	`agentsPanel` These are the various panels needed.
`private javax.swing.JButton`	`chatButton`
`private HeinekenPanel`	`chatPanel` These are the various panels needed.
`private HeinekenTextField`	`chatText`
`private javax.swing.JScrollPane`	`chatTextPane`
`private NetPuzlClient`	`client`
`private TransparentPanel`	`drawPanel`
`private HeinekenPanel`	`eastPanel` These are the various panels needed.
`private java.awt.Color`	`HEINEKEN_GREEN` A nice Heineken green color.
`private HeinekenList`	`imageList`
`private javax.swing.DefaultListModel`	`imageListModel`
`private HeinekenPanel`	`imagePanel` These are the various panels needed.
`private javax.swing.JScrollPane`	`imageScrollPane`
`private HeinekenPanel`	`infoPanel` These are the various panels needed.
`private javax.swing.JScrollPane`	`infoScrollPane`
`private javax.swing.DefaultListModel`	`keyListModel`
`private HeinekenPanel`	`keyPanel` These are the various panels needed.
`private javax.swing.JScrollPane`	`keyScrollPane`
`private HeinekenList`	`keysList`
`private javax.swing.JFrame`	`mainFrame` This is the window.
`private Matrix`	`matrix`
`private HeinekenList`	`matrixList`
`private javax.swing.DefaultListModel`	`matrixListModel`
`private HeinekenPanel`	`matrixPanel` These are the various panels needed.
`private javax.swing.JScrollPane`	`matrixScrollPane`
`private javax.swing.JMenuItem`	`menuAbout`
`private javax.swing.JMenuBar`	`menuBar` This is all the stuff for the menu bar.
`private javax.swing.JMenu`	`menuFile`
`private javax.swing.JMenu`	`menuHelp`
`private javax.swing.JMenuItem`	`menuLogout`
`private javax.swing.JMenuItem`	`menuStatus`
`private HeinekenTextArea`	`recievedText`
`private HeinekenPanel`	`recievePanel` These are the various panels needed.
`private javax.swing.JTabbedPane`	`sayToPane`
`private HeinekenPanel`	`sendPanel` These are the various panels needed.
`private static java.awt.Dimension`	`SIZE` The Dimension constant
`private HeinekenTextArea`	`tokenAttr`
`private javax.swing.DefaultListModel`	`tokenListModel`
`private HeinekenPanel`	`tokenPanel` These are the various panels needed.
`private javax.swing.JScrollPane`	`tokenScrollPane`
`private HeinekenList`	`tokensList`
`private javax.swing.JCheckBox`	`whisperCheck`

Constructor Summary

Constructors
Constructor and Description
`Gui()` This method is used for testing so that we don't have to build a client or a server just see the eye candy.
`Gui(NetPuzlClient client)` This is the constructor for this class, needs a client so that it can send Tags to its proxy.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addEnterKeyPress(javax.swing.JButton button)` This method is used so that a button can be pressed when it has focus, by the enter key.
`void`	`addMatrix(ClientMatrix matrix)` This method is used when adding all the matrix components (Cells), to be drawn on the screen.
`void`	`buildAgentPanel()` This method builds that agentPanel the panel that displays all the information about all the agents in the current matrix.
`void`	`buildCenterPanel()` This method builds the drawable surface of the gui.
`void`	`buildEastPanel()` This method builds the EastPanel where all the tabbed panels are.
`void`	`buildGUI()` This method builds the entire look and feel of this window.
`void`	`buildImagePanel()` Builds a Heineken Image panel
`void`	`buildInfoPanel()` This is the tabbed panel that displays the token info.
`void`	`buildKeyPanel()` This is the tabbed panel where keys will be drawn.
`void`	`buildMatrixPanel()` This method builds the the matrix panel where the matricies are drawn.
`void`	`buildMenu()` This method is used to build the menu.
`void`	`buildSayToPane()` Builds a tabbed pane for talking to NetPuzlObjects
`void`	`buildSouthPanel()` This builds the chatPanel where all messages to this client are seen.
`void`	`buildTokenPanel()` This is the tabbed panel where the token info is displayed.
`javax.swing.DefaultListModel`	`getAgentListModel()` A getter method for the agent list model.
`java.lang.String`	`getChatText()` This method is used when chatting to retrieve the input text from the user.
`javax.swing.JFrame`	`getFrame()` A getter method for the frame of this GUI.
`javax.swing.DefaultListModel`	`getImageListModel()`
`javax.swing.DefaultListModel`	`getKeyListModel()`
`Matrix`	`getMatrix()` A getter method for the the current matrix.
`javax.swing.DefaultListModel`	`getMatrixListModel()`
`javax.swing.JTextArea`	`getRecievedText()`
`private Gui`	`getThis()` This method is used to pass a reference to this when inside an anonymous class to be able to reference the GUI's methods
`javax.swing.DefaultListModel`	`getTokenListModel()` A getter method for the token list model.
`private void`	`prefAction()` This is some common behavior between actions.
`void`	`sendMessageToChatHistory(java.lang.String from, java.lang.String to, java.lang.String message)` Sends a message to the chat history box
`private void`	`sendTag(Tag tag)` This method is used to send a tag to the clients' proxy.
`private void`	`setAgentListModel(javax.swing.DefaultListModel listModel)` A setter method for the agents list model.
`void`	`setChatText(java.lang.String str)` This method is used to reset the text of the chat.
`void`	`setFrame(javax.swing.JFrame frame)` This method is used to change the frame of this GUI.
`private void`	`setImageListModel(javax.swing.DefaultListModel defaultListModel)`
`private void`	`setKeyListModel(javax.swing.DefaultListModel defaultListModel)` A setter method for the key list model.
`void`	`setMatrix(ClientMatrix matrix)` This method is used to set the matrix that the client will be in.
`private void`	`setMatrixListModel(javax.swing.DefaultListModel defaultListModel)` A setter method for the matrix list model.
`void`	`setRecievedText(HeinekenTextArea recievedText)` A setter method for the recieved text area.
`private void`	`setTokenListModel(javax.swing.DefaultListModel defaultListModel)` A setter method for the token list model.
`private void`	`talkToNetPuzlObject(NetPuzlObject npo, java.lang.String message)`
`private void`	`whisperToNetPuzlObject(NetPuzlObject npo, java.lang.String message)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SIZE
```
private static java.awt.Dimension SIZE
```
    The Dimension constant
  - mainFrame
```
private javax.swing.JFrame mainFrame
```
    This is the window.
  - agentsPanel
```
private HeinekenPanel agentsPanel
```
    These are the various panels needed.
  - tokenPanel
```
private HeinekenPanel tokenPanel
```
    These are the various panels needed.
  - keyPanel
```
private HeinekenPanel keyPanel
```
    These are the various panels needed.
  - matrixPanel
```
private HeinekenPanel matrixPanel
```
    These are the various panels needed.
  - imagePanel
```
private HeinekenPanel imagePanel
```
    These are the various panels needed.
  - chatPanel
```
private HeinekenPanel chatPanel
```
    These are the various panels needed.
  - sendPanel
```
private HeinekenPanel sendPanel
```
    These are the various panels needed.
  - recievePanel
```
private HeinekenPanel recievePanel
```
    These are the various panels needed.
  - infoPanel
```
private HeinekenPanel infoPanel
```
    These are the various panels needed.
  - eastPanel
```
private HeinekenPanel eastPanel
```
    These are the various panels needed.
  - drawPanel
```
private TransparentPanel drawPanel
```
  - sayToPane
```
private javax.swing.JTabbedPane sayToPane
```
  - agentScrollPane
```
private javax.swing.JScrollPane agentScrollPane
```
  - keyScrollPane
```
private javax.swing.JScrollPane keyScrollPane
```
  - tokenScrollPane
```
private javax.swing.JScrollPane tokenScrollPane
```
  - matrixScrollPane
```
private javax.swing.JScrollPane matrixScrollPane
```
  - imageScrollPane
```
private javax.swing.JScrollPane imageScrollPane
```
  - chatTextPane
```
private javax.swing.JScrollPane chatTextPane
```
  - infoScrollPane
```
private javax.swing.JScrollPane infoScrollPane
```
  - menuBar
```
private javax.swing.JMenuBar menuBar
```
    This is all the stuff for the menu bar.
  - menuFile
```
private javax.swing.JMenu menuFile
```
  - menuHelp
```
private javax.swing.JMenu menuHelp
```
  - menuAbout
```
private javax.swing.JMenuItem menuAbout
```
  - menuLogout
```
private javax.swing.JMenuItem menuLogout
```
  - menuStatus
```
private javax.swing.JMenuItem menuStatus
```
  - agentListModel
```
private javax.swing.DefaultListModel agentListModel
```
    These are other elements that belong to a certain panel.
  - tokenListModel
```
private javax.swing.DefaultListModel tokenListModel
```
  - keyListModel
```
private javax.swing.DefaultListModel keyListModel
```
  - matrixListModel
```
private javax.swing.DefaultListModel matrixListModel
```
  - imageListModel
```
private javax.swing.DefaultListModel imageListModel
```
  - agentsList
```
private HeinekenList agentsList
```
  - tokensList
```
private HeinekenList tokensList
```
  - keysList
```
private HeinekenList keysList
```
  - matrixList
```
private HeinekenList matrixList
```
  - imageList
```
private HeinekenList imageList
```
  - chatText
```
private HeinekenTextField chatText
```
  - recievedText
```
private HeinekenTextArea recievedText
```
  - tokenAttr
```
private HeinekenTextArea tokenAttr
```
  - chatButton
```
private javax.swing.JButton chatButton
```
  - whisperCheck
```
private javax.swing.JCheckBox whisperCheck
```
  - matrix
```
private Matrix matrix
```
  - client
```
private NetPuzlClient client
```
  - HEINEKEN_GREEN
```
private final java.awt.Color HEINEKEN_GREEN
```
    A nice Heineken green color.
- Constructor Detail
  - Gui
```
public Gui()
```
    This method is used for testing so that we don't have to build a client or a server just see the eye candy.
  - Gui
```
public Gui(NetPuzlClient client)
```
    This is the constructor for this class, needs a client so that it can send Tags to its proxy.
    
    Parameters:
    
    client - The client that this GUI should be associated with.
- Method Detail
  - prefAction
```
private void prefAction()
```
    This is some common behavior between actions.
  - whisperToNetPuzlObject
```
private void whisperToNetPuzlObject(NetPuzlObject npo,
                                    java.lang.String message)
```
  - talkToNetPuzlObject
```
private void talkToNetPuzlObject(NetPuzlObject npo,
                                 java.lang.String message)
```
  - addEnterKeyPress
```
public static void addEnterKeyPress(javax.swing.JButton button)
```
    This method is used so that a button can be pressed when it has focus, by the enter key. to Cycle through buttons press the tab key.
    
    Parameters:
    
    button - The button that wants to pressed by the enter key.
  - addMatrix
```
public void addMatrix(ClientMatrix matrix)
```
    This method is used when adding all the matrix components (Cells), to be drawn on the screen.
  - buildAgentPanel
```
public void buildAgentPanel()
```
    This method builds that agentPanel the panel that displays all the information about all the agents in the current matrix.
  - buildImagePanel
```
public void buildImagePanel()
```
    Builds a Heineken Image panel
  - setImageListModel
```
private void setImageListModel(javax.swing.DefaultListModel defaultListModel)
```
  - buildCenterPanel
```
public void buildCenterPanel()
```
    This method builds the drawable surface of the gui.
  - buildEastPanel
```
public void buildEastPanel()
```
    This method builds the EastPanel where all the tabbed panels are.
  - buildGUI
```
public void buildGUI()
```
    This method builds the entire look and feel of this window.
  - buildInfoPanel
```
public void buildInfoPanel()
```
    This is the tabbed panel that displays the token info.
  - buildKeyPanel
```
public void buildKeyPanel()
```
    This is the tabbed panel where keys will be drawn.
  - buildMatrixPanel
```
public void buildMatrixPanel()
```
    This method builds the the matrix panel where the matricies are drawn.
  - buildMenu
```
public void buildMenu()
```
    This method is used to build the menu.
  - buildSayToPane
```
public void buildSayToPane()
```
    Builds a tabbed pane for talking to NetPuzlObjects
  - buildSouthPanel
```
public void buildSouthPanel()
```
    This builds the chatPanel where all messages to this client are seen.
  - buildTokenPanel
```
public void buildTokenPanel()
```
    This is the tabbed panel where the token info is displayed.
  - getAgentListModel
```
public javax.swing.DefaultListModel getAgentListModel()
```
    A getter method for the agent list model.
    
    Returns:
    
    the listModel
  - getChatText
```
public java.lang.String getChatText()
```
    This method is used when chatting to retrieve the input text from the user.
  - getFrame
```
public javax.swing.JFrame getFrame()
```
    A getter method for the frame of this GUI.
  - getKeyListModel
```
public javax.swing.DefaultListModel getKeyListModel()
```
    Returns:
    
    the keyListModel
  - getMatrix
```
public Matrix getMatrix()
```
    A getter method for the the current matrix.
  - getMatrixListModel
```
public javax.swing.DefaultListModel getMatrixListModel()
```
    Returns:
    
    the matrixListModel
  - getRecievedText
```
public javax.swing.JTextArea getRecievedText()
```
    Returns:
    
    the recievedText
  - getThis
```
private Gui getThis()
```
    This method is used to pass a reference to this when inside an anonymous class to be able to reference the GUI's methods
    
    Returns:
    
    A reference to this.
  - getTokenListModel
```
public javax.swing.DefaultListModel getTokenListModel()
```
    A getter method for the token list model.
    
    Returns:
    
    the tokenListModel
  - sendTag
```
private void sendTag(Tag tag)
```
    This method is used to send a tag to the clients' proxy.
    
    Parameters:
    
    tag - The tag to be sent to the proxy.
  - setAgentListModel
```
private void setAgentListModel(javax.swing.DefaultListModel listModel)
```
    A setter method for the agents list model.
    
    Parameters:
    
    listModel - the listModel to set
  - setChatText
```
public void setChatText(java.lang.String str)
```
    This method is used to reset the text of the chat.
  - setFrame
```
public void setFrame(javax.swing.JFrame frame)
```
    This method is used to change the frame of this GUI.
  - setKeyListModel
```
private void setKeyListModel(javax.swing.DefaultListModel defaultListModel)
```
    A setter method for the key list model.
    
    Parameters:
    
    defaultListModel - The new keyListModel.
  - setMatrix
```
public void setMatrix(ClientMatrix matrix)
```
    This method is used to set the matrix that the client will be in.
  - setMatrixListModel
```
private void setMatrixListModel(javax.swing.DefaultListModel defaultListModel)
```
    A setter method for the matrix list model.
    
    Parameters:
    
    defaultListModel - The new matrixListModel.
  - setRecievedText
```
public void setRecievedText(HeinekenTextArea recievedText)
```
    A setter method for the recieved text area.
    
    Parameters:
    
    recievedText - the recievedText to set
  - setTokenListModel
```
private void setTokenListModel(javax.swing.DefaultListModel defaultListModel)
```
    A setter method for the token list model.
    
    Parameters:
    
    defaultListModel - The new tokenListModel.
  - sendMessageToChatHistory
```
public void sendMessageToChatHistory(java.lang.String from,
                                     java.lang.String to,
                                     java.lang.String message)
```
    Sends a message to the chat history box
    
    Parameters:
    
    from - Who the message is from
    
    to - Who the message is to
    
    message - The message sent
  - getImageListModel
```
public javax.swing.DefaultListModel getImageListModel()
```
    Returns:
    
    the imageListModel

Class Gui

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIZE

mainFrame

agentsPanel

tokenPanel

keyPanel

matrixPanel

imagePanel

chatPanel

sendPanel

recievePanel

infoPanel

eastPanel

drawPanel

sayToPane

agentScrollPane

keyScrollPane

tokenScrollPane

matrixScrollPane

imageScrollPane

chatTextPane

infoScrollPane

menuBar

menuFile

menuHelp

menuAbout

menuLogout

menuStatus

agentListModel

tokenListModel

keyListModel

matrixListModel

imageListModel

agentsList

tokensList

keysList

matrixList

imageList

chatText

recievedText

tokenAttr

chatButton

whisperCheck

matrix

client

HEINEKEN_GREEN

Constructor Detail

Gui

Gui

Method Detail

prefAction

whisperToNetPuzlObject

talkToNetPuzlObject

addEnterKeyPress

addMatrix

buildAgentPanel

buildImagePanel

setImageListModel

buildCenterPanel

buildEastPanel

buildGUI

buildInfoPanel

buildKeyPanel

buildMatrixPanel

buildMenu

buildSayToPane

buildSouthPanel

buildTokenPanel

getAgentListModel

getChatText

getFrame

getKeyListModel

getMatrix

getMatrixListModel