ptolemy.actor.gui
Class TextEditor

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      ptolemy.gui.Top
                          ptolemy.actor.gui.TableauFrame
                              ptolemy.actor.gui.TextEditor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

DebugListenerTableau.DebugListenerFrame, TextEditorForStringAttributes

public class TextEditor
extends TableauFrame
implements javax.swing.event.DocumentListener, java.awt.print.Printable

A top-level window containing a simple text editor or viewer. You can access the public member text to set the text, get the text, or set the number of rows or columns. After creating this, it is necessary to call show() for it to appear.

Since:

Ptolemy II 1.0

Version:

$Id: TextEditor.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee, contributors: Christopher Brooks, Ben Leinfelder

See Also:

Serialized Form

Accepted Rating:

Red (eal)

Proposed Rating:

Yellow (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.actor.gui.TableauFrame

TableauFrame.ExtensionFileFilter, TableauFrame.ViewMenuListener

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JScrollPane	_scrollPane The scroll pane containing the text area.
javax.swing.JTextArea	text The text area.

Fields inherited from class ptolemy.actor.gui.TableauFrame

_initialSaveAsFileName, _viewMenu, aboutFile, helpFile

Fields inherited from class ptolemy.gui.Top

_CANCELED, _directory, _DISCARDED, _FAILED, _fileFilter, _fileMenu, _fileMenuItems, _helpMenu, _helpMenuItems, _menubar, _SAVED, _statusBar

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

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 java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

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

TextEditor()
Construct an empty text editor with no name.

TextEditor(java.lang.String title)
Construct an empty text editor with the specified title.

TextEditor(java.lang.String title, javax.swing.text.Document document)
Construct an empty text editor with the specified title and document.

TextEditor(java.lang.String title, javax.swing.text.Document document, Placeable placeable)
Construct an empty text editor with the specified title and document and associated placeable.

Method Summary

protected boolean	_clear() Clear the current contents.
protected void	_help() Display more detailed information than given by _about().
protected void	_print() Print the contents.
void	changedUpdate(javax.swing.event.DocumentEvent e) React to notification that an attribute or set of attributes changed.
java.awt.Color	getBackground() Get the background color.
void	insertUpdate(javax.swing.event.DocumentEvent e) React to notification that there was an insert into the document.
int	print(java.awt.Graphics graphics, java.awt.print.PageFormat format, int index) Print the text to a printer, which is represented by the specified graphics object.
void	removeUpdate(javax.swing.event.DocumentEvent e) React to notification that there was a removal from the document.
void	scrollToEnd() Scroll as necessary so that the last line is visible.
void	setBackground(java.awt.Color background) Set background color.

Methods inherited from class ptolemy.actor.gui.TableauFrame

_about, _addMenus, _close, _confirmFile, _exit, _getDefaultIconImage, _getName, _read, _save, _saveAs, _saveAs, _saveAsHelper, _writeFile, getAlternateTopPack, getConfiguration, getDirectory, getEffigy, getEffigy, getTableau, isModified, pack, printPDF, setModified, setTableau

Methods inherited from class ptolemy.gui.Top

_createFileMenuItems, _getCurrentDirectory, _open, _openURL, _printCrossPlatform, _printNative, _printPDF, _queryForSave, _saveAsFileDialog, centerOnScreen, close, deferIfNecessary, getCentering, hideMenuBar, isMenuPopulated, report, report, report, setCentering, setDirectory, show

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

text

public javax.swing.JTextArea text

The text area.

_scrollPane

protected javax.swing.JScrollPane _scrollPane

The scroll pane containing the text area.

Constructor Detail

TextEditor

public TextEditor()

Construct an empty text editor with no name. After constructing this, it is necessary to call setVisible(true) to make the frame appear.

TextEditor

public TextEditor(java.lang.String title)

Construct an empty text editor with the specified title. After constructing this, it is necessary to call setVisible(true) to make the frame appear.

Parameters:

title - The title to put in the title bar.

TextEditor

public TextEditor(java.lang.String title,
                  javax.swing.text.Document document)

Construct an empty text editor with the specified title and document. After constructing this, it is necessary to call setVisible(true) to make the frame appear.

Parameters:

title - The title to put in the title bar.

document - The document containing text, or null if none.

TextEditor

public TextEditor(java.lang.String title,
                  javax.swing.text.Document document,
                  Placeable placeable)

Construct an empty text editor with the specified title and document and associated placeable. After constructing this, it is necessary to call setVisible(true) to make the frame appear.

Parameters:

title - The title to put in the title bar.

document - The document containing text, or null if none.

placeable - The associated placeable.

Method Detail

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

React to notification that an attribute or set of attributes changed.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

getBackground

public java.awt.Color getBackground()

Get the background color.

Overrides:

getBackground in class java.awt.Component

Returns:

The background color of the scroll pane.

See Also:

setBackground(Color)

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

React to notification that there was an insert into the document.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

print

public int print(java.awt.Graphics graphics,
                 java.awt.print.PageFormat format,
                 int index)
          throws java.awt.print.PrinterException

Print the text to a printer, which is represented by the specified graphics object.

Specified by:

print in interface java.awt.print.Printable

Parameters:

graphics - The context into which the page is drawn.

format - The size and orientation of the page being drawn.

index - The zero based index of the page to be drawn.

Returns:

PAGE_EXISTS if the page is rendered successfully, or NO_SUCH_PAGE if pageIndex specifies a non-existent page.

Throws:

java.awt.print.PrinterException - If the print job is terminated.

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

React to notification that there was a removal from the document.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

scrollToEnd

public void scrollToEnd()

Scroll as necessary so that the last line is visible.

setBackground

public void setBackground(java.awt.Color background)

Set background color. This overrides the base class to set the background of contained scroll pane and text area.

Overrides:

setBackground in class Top

Parameters:

background - The background color.

See Also:

getBackground()

_clear

protected boolean _clear()

Clear the current contents. First, check to see whether the contents have been modified, and if so, then prompt the user to save them. A return value of false indicates that the user has canceled the action.

Overrides:

_clear in class Top

Returns:

False if the user cancels the clear.

_help

protected void _help()

Display more detailed information than given by _about().

Overrides:

_help in class TableauFrame

See Also:

FileParameter

_print

protected void _print()

Print the contents.

Overrides:

_print in class Top