edu.rit.swing

Class TranscriptFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

edu.rit.swing.TranscriptFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class TranscriptFrame
extends javax.swing.JFrame

Class TranscriptFrame is a Java Swing frame (window) that displays plain text written to an output stream. It is a JFrame containing a Transcript.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Font	DEFAULT_FONT Default font: sanserif, plain, 9 point.
static int	DEFAULT_MAX_LINES Default maximum number of lines: 24.
static int	DEFAULT_VISIBLE_COLUMNS Default visible number of columns: 80.
static int	DEFAULT_VISIBLE_LINES Default visible number of lines: 24.

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TranscriptFrame(java.lang.String theTitle) Construct a new transcript frame.
TranscriptFrame(java.lang.String theTitle, java.awt.Font theFont) Construct a new transcript frame that will use the given font.
TranscriptFrame(java.lang.String theTitle, java.awt.Font theFont, int theMaxLines) Construct a new transcript frame that will use the given font and that will display the given maximum number of lines.
TranscriptFrame(java.lang.String theTitle, java.awt.Font theFont, int theMaxLines, int theVisibleLines, int theVisibleColumns) Construct a new transcript frame that will use the given font, that will display the given maximum number of lines, and that will have the given number of lines and columns visible.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear this transcript.
java.io.OutputStream	getOutputStream() Returns the OutputStream used to write into this transcript.
javax.swing.JTextArea	getTextArea() Returns the JTextArea component used to display the text of this transcript.

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT

Default font: sanserif, plain, 9 point.

DEFAULT_MAX_LINES

public static final int DEFAULT_MAX_LINES

Default maximum number of lines: 24.

See Also:

Constant Field Values

DEFAULT_VISIBLE_LINES

public static final int DEFAULT_VISIBLE_LINES

Default visible number of lines: 24.

See Also:

Constant Field Values

DEFAULT_VISIBLE_COLUMNS

public static final int DEFAULT_VISIBLE_COLUMNS

Default visible number of columns: 80.

See Also:

Constant Field Values

Constructor Detail

TranscriptFrame

public TranscriptFrame(java.lang.String theTitle)

Construct a new transcript frame. The transcript will use the default font (9 point monospaced). The transcript will display the default maximum number of lines (24). The transcript will have the default number of lines and columns visible (24x80).

Parameters:

theTitle - Frame title.

TranscriptFrame

public TranscriptFrame(java.lang.String theTitle,
                       java.awt.Font theFont)

Construct a new transcript frame that will use the given font. The transcript will display the default maximum number of lines (24). The transcript will have the default number of lines and columns visible (24x80).

Parameters:

theTitle - Frame title.

theFont - Font to use for the transcript display.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theFont is null.

TranscriptFrame

public TranscriptFrame(java.lang.String theTitle,
                       java.awt.Font theFont,
                       int theMaxLines)

Construct a new transcript frame that will use the given font and that will display the given maximum number of lines. The transcript will have the default number of lines and columns visible (24x80).

Parameters:

theTitle - Frame title.

theFont - Font to use for the transcript display.

theMaxLines - Maximum number of lines displayed.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theFont is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theMaxLines is less than or equal to 0.

TranscriptFrame

public TranscriptFrame(java.lang.String theTitle,
                       java.awt.Font theFont,
                       int theMaxLines,
                       int theVisibleLines,
                       int theVisibleColumns)

Construct a new transcript frame that will use the given font, that will display the given maximum number of lines, and that will have the given number of lines and columns visible.

Parameters:

theTitle - Frame title.

theFont - Font to use for the transcript display.

theMaxLines - Maximum number of lines displayed.

theVisibleLines - Number of lines visible.

theVisibleColumns - Number of columns visible.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theFont is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theMaxLines is less than or equal to 0. Thrown if theVisibleLines is less than or equal to 0. Thrown if theVisibleColumns is less than or equal to 0.

Method Detail

getTextArea

public javax.swing.JTextArea getTextArea()

Returns the JTextArea component used to display the text of this transcript.

getOutputStream

public java.io.OutputStream getOutputStream()

Returns the OutputStream used to write into this transcript.

clear

public void clear()
           throws java.io.IOException

Clear this transcript.

Throws:

java.io.IOException - Thrown if an I/O error occurred.