edu.rit.swing

Class Transcript

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

edu.rit.swing.Transcript

All Implemented Interfaces:

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

public class Transcript
extends javax.swing.JScrollPane

Class Transcript is a Java Swing component that displays plain text written to an output stream. It is a JScrollPane containing a JTextArea.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
Transcript() Construct a new transcript.
Transcript(java.awt.Font theFont) Construct a new transcript that will use the given font.
Transcript(java.awt.Font theFont, int theMaxLines) Construct a new transcript that will use the given font and that will display the given maximum number of lines.
Transcript(java.awt.Font theFont, int theMaxLines, int theVisibleLines, int theVisibleColumns) Construct a new transcript 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.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

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

Transcript

public Transcript()

Construct a new transcript. 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).

Transcript

public Transcript(java.awt.Font theFont)

Construct a new transcript 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:

theFont - Font to use for the transcript display.

Throws:

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

Transcript

public Transcript(java.awt.Font theFont,
                  int theMaxLines)

Construct a new transcript 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:

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.

Transcript

public Transcript(java.awt.Font theFont,
                  int theMaxLines,
                  int theVisibleLines,
                  int theVisibleColumns)

Construct a new transcript 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:

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.