, then the copyrights will
be generated by GenerateCopyrights.generateHTML(Configuration)
If the URL is about:expandConfiguration, then the
Ptolemy II configuration will be expanded by and the MoML of the
configuration will be returned. This is a good way to test the
configuration.
This class supports printing and will save the text to a .html file.
The url that is viewed can be changed by calling the setPage method.
- Since:
- Ptolemy II 1.0
- Version:
- $Id: HTMLViewer.java,v 1.44 2004/04/13 02:59:19 cxh Exp $
- Author:
- Steve Neuendorffer and Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
| Nested classes inherited from class javax.swing.JFrame |
javax.swing.JFrame.AccessibleJFrame |
| Nested classes inherited from class java.awt.Frame |
java.awt.Frame.AccessibleAWTFrame |
| Nested classes inherited from class java.awt.Window |
java.awt.Window.AccessibleAWTWindow |
| Nested classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
|
Field Summary |
javax.swing.JEditorPane |
pane
The text pane. |
| 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 |
HTMLViewer()
Construct a blank viewer. |
|
Method Summary |
protected void |
_writeFile(java.io.File file)
Write the model to the specified file. |
java.net.URL |
getPage()
Get the page displayed by this viewer. |
void |
hyperlinkUpdate(javax.swing.event.HyperlinkEvent event)
React to a hyperlink being clicked on in the rendered HTML.
|
int |
print(java.awt.Graphics graphics,
java.awt.print.PageFormat format,
int index)
Print the documentation to a printer. |
void |
setPage(java.net.URL page)
Set the page displayed by this viewer to be that given by the
specified URL. |
void |
setSize(int width,
int height)
Override the base class to set the size of the scroll pane.
|
| Methods inherited from class ptolemy.actor.gui.TableauFrame |
_about, _addMenus, _close, _confirmFile, _exit, _getDefaultIconImage, _getName, _help, _read, _save, _saveAs, getConfiguration, getDirectory, getEffigy, getEffigy, getTableau, isModified, setModified, setTableau |
| Methods inherited from class ptolemy.gui.Top |
_clear, _open, _openURL, _print, _queryForSave, _saveAsFileDialog, centerOnScreen, close, deferIfNecessary, getCentering, pack, report, report, report, setBackground, setCentering, 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, 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, setIconImage, 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, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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 |
pane
public javax.swing.JEditorPane pane
- The text pane.
HTMLViewer
public HTMLViewer()
- Construct a blank viewer.
getPage
public java.net.URL getPage()
- Get the page displayed by this viewer.
- Returns:
- The page displayed by this viewer.
hyperlinkUpdate
public void hyperlinkUpdate(javax.swing.event.HyperlinkEvent event)
- React to a hyperlink being clicked on in the rendered HTML.
This method opens the hyperlink URL in a new window, using
the configuration. This means that hyperlinks can reference
any file that the configuration can open, including MoML files.
It is assumed this is called in the AWT event thread.
- Specified by:
hyperlinkUpdate in interface javax.swing.event.HyperlinkListener
- Parameters:
event - The hyperlink event.
print
public int print(java.awt.Graphics graphics,
java.awt.print.PageFormat format,
int index)
throws java.awt.print.PrinterException
- Print the documentation to a printer. The documentation will be
scaled to fit the width of the paper, growing to as many pages as
is necessary.
- 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.
setPage
public void setPage(java.net.URL page)
throws java.io.IOException
- Set the page displayed by this viewer to be that given by the
specified URL.
- Parameters:
page - The location of the documentation.
- Throws:
java.io.IOException - If the page cannot be read.
setSize
public void setSize(int width,
int height)
- Override the base class to set the size of the scroll pane.
Regrettably, this is necessary because swing packers ignore
the specified size of a container. If this is not called in
the AWT event thread, then execution is deferred and executed
in that thread.
- Parameters:
width - The width of the scroll pane.height - The height of the scroll pane.
_writeFile
protected void _writeFile(java.io.File file)
throws java.io.IOException
- Write the model to the specified file. Note that this does not
defer to the effigy.
- Overrides:
_writeFile in class TableauFrame
- Parameters:
file - The file to write to.
- Throws:
java.io.IOException - If the write fails.