communicationsWindow (Bradley Ross Examples)

java.lang.Object
- bradleyross.common.communicationsWindow

```
public class communicationsWindow
extends Object
```
This class opens a window for communications with a port on another system.

Author:

Bradley Ross

Field Summary

Fields
Modifier and Type	Field and Description
`private TextArea`	`bottomWindow` The bottomWindow TextArea is used to hold information being prepared for transmission.
`private Button`	`closeButton` The closeButton Button can be used to close the connection when it fails to close normally.
`protected int`	`colsCurrent` The number of columns in the TextArea objects currently.
`protected int`	`colsLarger` The number of columns in the TextArea objects if the window is made wider.
`protected int`	`colsSmaller` The number of columns in the TextArea objects if the window is made narrower.
`private int`	`debugLevel` Determines amount of diagnostic material to be printed.
`protected int`	`heightCurrent` This is the height in pixels returned by the TextArea.getMinimumSize method for a TextArea block rowsCurrent rows in height.
`protected int`	`heightLarger` This is the height in pixels returned by the TextArea.getMinimumSize method for a TextArea block rowsLarger rows in height.
`protected int`	`heightSmaller` This is the height in pixels returned by the TextArea.getMinimumSize method for a TextArea block rowsSmaller rows in height.
`private BufferedReader`	`in`
`protected boolean`	`initialized` Set to true when the objects in the window have been initialized.
`private FlowLayout`	`layout`
`private BufferedWriter`	`logBuffer`
`private FileWriter`	`logFile`
`private boolean`	`logFileActive` Determines whether messages are written to the log file.
`private String`	`logFileName`
`private PrintWriter`	`logWriter` Used for writing the communicated text to a log file.
`private Frame`	`myFrame` Object for the frame in which the application is displayed.
`private Panel`	`myPanel` The myPanel panel provides a place to attach key listeners.
`private PrintWriter`	`pw`
`protected int`	`rowsCurrent`
`protected int`	`rowsLarger`
`protected int`	`rowsSmaller` Used to determine the number of rows that should be in the TextArea objects when the height of TextArea objects is made slightly smaller.
`private Button`	`sendButton` The sendButton Button object causes the material in the lower window to be sent over the communication line.
`private Socket`	`sock`
`private InputStreamReader`	`streamReader`
`private TextArea`	`topWindow` The topWindow TextArea holds the information sent from the other end of the connection.
`protected int`	`widthCurrent` The width of the TextArea objects in pixels when they are colsCurrent columns wide.
`protected int`	`widthLarger` The width of the TextArea objects in pixels when they are colsLarger columns wide.
`protected int`	`widthSmaller` The width of the TextArea objects in pixels when they are colsSmaller columns wide.
`private String`	`windowName`
`private static int`	`windowNumber`

Constructor Summary

Constructors
Constructor and Description

communicationsWindow(String name)

Constructors
Constructor and Description
`communicationsWindow(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addMessage(String display)` This method generates a message and adds it to the log and the Sys.output character stream.
`int`	`getDebugLevel()`
`protected void`	`processKey(KeyEvent e)` This function is called whenever a key is pressed.
`protected void`	`sendMessage()` This method is called when the Send button is depressed on the form or the user depresses the Return key on the keyboard.
`void`	`setDebugLevel(int level)` This method is used to control the amount of diagnostic messages generated.
`void`	`start(Socket inputSock)` This is the main method for creating the communications window and setting up the communications stream.
`protected void`	`windowResizer()` This method is called when the window is resized.

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

- Field Detail
  - debugLevel
```
private int debugLevel
```
    Determines amount of diagnostic material to be printed.
  - windowNumber
```
private static int windowNumber
```
  - layout
```
private FlowLayout layout
```
  - sock
```
private Socket sock
```
  - pw
```
private PrintWriter pw
```
  - in
```
private BufferedReader in
```
  - streamReader
```
private InputStreamReader streamReader
```
  - logFileName
```
private String logFileName
```
  - logFileActive
```
private boolean logFileActive
```
    Determines whether messages are written to the log file.
  - logFile
```
private FileWriter logFile
```
  - logBuffer
```
private BufferedWriter logBuffer
```
  - logWriter
```
private PrintWriter logWriter
```
    Used for writing the communicated text to a log file.
  - colsSmaller
```
protected int colsSmaller
```
    The number of columns in the TextArea objects if the window is made narrower.
  - colsCurrent
```
protected int colsCurrent
```
    The number of columns in the TextArea objects currently.
  - colsLarger
```
protected int colsLarger
```
    The number of columns in the TextArea objects if the window is made wider.
  - widthSmaller
```
protected int widthSmaller
```
    The width of the TextArea objects in pixels when they are colsSmaller columns wide.
  - widthCurrent
```
protected int widthCurrent
```
    The width of the TextArea objects in pixels when they are colsCurrent columns wide.
  - widthLarger
```
protected int widthLarger
```
    The width of the TextArea objects in pixels when they are colsLarger columns wide.
  - rowsSmaller
```
protected int rowsSmaller
```
    Used to determine the number of rows that should be in the TextArea objects when the height of TextArea objects is made slightly smaller.
    The TextArea.getMinimumSize method is applied to an object eight rows taller than the topWindow object. This allows room for bottomWindow and the buttons.
  - rowsCurrent
```
protected int rowsCurrent
```
  - rowsLarger
```
protected int rowsLarger
```
  - heightSmaller
```
protected int heightSmaller
```
    This is the height in pixels returned by the TextArea.getMinimumSize method for a TextArea block rowsSmaller rows in height.
  - heightCurrent
```
protected int heightCurrent
```
    This is the height in pixels returned by the TextArea.getMinimumSize method for a TextArea block rowsCurrent rows in height.
  - heightLarger
```
protected int heightLarger
```
    This is the height in pixels returned by the TextArea.getMinimumSize method for a TextArea block rowsLarger rows in height.
  - initialized
```
protected boolean initialized
```
    Set to true when the objects in the window have been initialized.
    Some events related to window movement and resizing may be generated before the objects fully initialized. These should not be responded to as the sizes and locations have not yet been set.
  - bottomWindow
```
private TextArea bottomWindow
```
    The bottomWindow TextArea is used to hold information being prepared for transmission.
  - topWindow
```
private TextArea topWindow
```
    The topWindow TextArea holds the information sent from the other end of the connection.
  - sendButton
```
private Button sendButton
```
    The sendButton Button object causes the material in the lower window to be sent over the communication line.
    The data is also sent when the user depresses the Return key on the keyboard. This button on the form may be removed at a later date.
  - closeButton
```
private Button closeButton
```
    The closeButton Button can be used to close the connection when it fails to close normally.
  - myFrame
```
private Frame myFrame
```
    Object for the frame in which the application is displayed.
    The menu bar is attached to the frame.
  - myPanel
```
private Panel myPanel
```
    The myPanel panel provides a place to attach key listeners.
    It appears that a Panel is a container, but a Frame isn't. Since listeners must be attached to containers, it was necessary to create a panel within the frame.
    
    After the object is created, a listener is created with an anonymous inner class to react to changes in the size of the panel.
  - windowName
```
private String windowName
```
- Constructor Detail
  - communicationsWindow
```
public communicationsWindow(String name)
```
- Method Detail
  - windowResizer
```
protected void windowResizer()
```
    This method is called when the window is resized.
    It examines the width and height of the windows to determine whether the TextArea objects should have their height and width changed.
  - addMessage
```
protected void addMessage(String display)
```
    This method generates a message and adds it to the log and the Sys.output character stream.
  - processKey
```
protected void processKey(KeyEvent e)
```
    This function is called whenever a key is pressed.
    If the Delete or Backspace key is depressed, the last character in the bottomWindow textArea is removed.
    
    If the Return key is depressed, the contents of bottomWindow are sent to the remote system and contents of bottomWindow are erased.
  - sendMessage
```
protected void sendMessage()
```
    This method is called when the Send button is depressed on the form or the user depresses the Return key on the keyboard.
  - setDebugLevel
```
public void setDebugLevel(int level)
```
    This method is used to control the amount of diagnostic messages generated.
    A value of 0 means no messages are to be printed. Higher values generate larger amounts of messages.
  - getDebugLevel
```
public int getDebugLevel()
```
  - start
```
public void start(Socket inputSock)
```
    This is the main method for creating the communications window and setting up the communications stream.

Class communicationsWindow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debugLevel

windowNumber

layout

sock

pw

in

streamReader

logFileName

logFileActive

logFile

logBuffer

logWriter

colsSmaller

colsCurrent

colsLarger

widthSmaller

widthCurrent

widthLarger

rowsSmaller

rowsCurrent

rowsLarger

heightSmaller

heightCurrent

heightLarger

initialized

bottomWindow

topWindow

sendButton

closeButton

myFrame

myPanel

windowName

Constructor Detail

communicationsWindow

Method Detail

windowResizer

addMessage

processKey

sendMessage

setDebugLevel

getDebugLevel

start