ptolemy.actor.gui
Class WelcomeWindow

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.HTMLViewer
                                  ptolemy.actor.gui.WelcomeWindow

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.HyperlinkListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class WelcomeWindow
extends HTMLViewer

A toplevel frame that can view HTML documents, but has no menus.

This window uses the _showWelcomeWindowAtStartup SingletonParameter preference in PtolemyPreferences to determine whether the window is shown or not. If this parameter is not present or is true, then the window is show, if the parameter is false, then it is not shown. This parameter is set in ~/.ptolemyII/PtolemyPreferences.xml, which under Windows might be in c:/Documents and Settings/yourlogin/.ptolemyII/PtolemyPreferences.xml

The easiest way to adjust the configuration so that this window is used is to edit the welcomeWindow.xml file that corresponds with the configuration and set the tableau to be ptolemy.actor.gui.WelcomeWindowTableau For example, $PTII/ptolemy/configs/full/welcomeWindow.xml might look like:

 <?xml version="1.0" standalone="no"?>
 <!DOCTYPE plot PUBLIC "-//UC Berkeley//DTD MoML 1//EN"
 "http://ptolemy.eecs.berkeley.edu/xml/dtd/MoML_1.dtd">
 <entity name="directory">
 <entity name="doc" class="ptolemy.actor.gui.HTMLEffigy">
 <entity name="tableau" class="ptolemy.actor.gui.WelcomeWindowTableau">
 <!-- If you adjust the size, be sure to try it under Java 1.5 -->
 <property name="size" value="[600, 220]"/>
 <property name="url" value="ptolemy/configs/full/intro.htm"/>
 </entity>
 </entity>
 </entity>
 

The above configuration will create a WelcomeWindow with a 600x200 size that displays the contents of ptolemy/configs/full/intro.htm

Note that since this widow has no menus, if you use this window, then you will want to set the _applicationBlankPtolemyEffigyAtStartup parameter in the configuration so that a blank Graph Editor window pops up along with this welcome window. For example:

 <property name="_applicationBlankPtolemyEffigyAtStartup"
 class="ptolemy.data.expr.Parameter"
 value="true"/>
 

Since:

Ptolemy II 5.2

Version:

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

Author:

Christopher Brooks, Nandita Mangal

See Also:

Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

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

private javax.swing.JButton	_closeButton
private javax.swing.JPanel	_closePanel The panel at the bottom that contains the "Show this dialog on startup" checkbox and the close button.
private BooleanToken	_showWelcomeWindowAtStartup True if the welcome window is shown at startup.
private javax.swing.JCheckBox	_startupCheck

Fields inherited from class ptolemy.actor.gui.HTMLViewer

_scroller, pane

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

WelcomeWindow()
Construct a blank HTML Viewer with no menu items.

Method Summary

protected boolean	_close() Read the "Show this dialog on startup" checkbox, update the preferences if necessary and then call the super class and close this window.
protected java.lang.String	_getName() Get the name of this object, which in this case is the string "Welcome".
void	pack() Make this window displayable.
void	setTitle(java.lang.String title) Always set the title to the string "Welcome".
void	show() Show the window if the _showWelcomeWindowAtStartup parameter is not set or is true.

Methods inherited from class ptolemy.actor.gui.HTMLViewer

_addMainPane, _setScrollerSize, _writeFile, getPage, hyperlinkUpdate, print, setBase, setPage, setSize, setText

Methods inherited from class ptolemy.actor.gui.TableauFrame

_about, _addMenus, _confirmFile, _exit, _getDefaultIconImage, _help, _read, _save, _saveAs, _saveAs, _saveAsHelper, getAlternateTopPack, getConfiguration, getDirectory, getEffigy, getEffigy, getTableau, isModified, printPDF, setModified, setTableau

Methods inherited from class ptolemy.gui.Top

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

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, 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, 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, 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, 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

_closePanel

private javax.swing.JPanel _closePanel

The panel at the bottom that contains the "Show this dialog on startup" checkbox and the close button.

_showWelcomeWindowAtStartup

private BooleanToken _showWelcomeWindowAtStartup

True if the welcome window is shown at startup.

_startupCheck

private javax.swing.JCheckBox _startupCheck

_closeButton

private javax.swing.JButton _closeButton

Constructor Detail

WelcomeWindow

public WelcomeWindow()

Construct a blank HTML Viewer with no menu items.

Method Detail

pack

public void pack()

Make this window displayable. The menubar is hidden and close panel is added.

Overrides:

pack in class TableauFrame

setTitle

public void setTitle(java.lang.String title)

Always set the title to the string "Welcome".

Overrides:

setTitle in class java.awt.Frame

Parameters:

title - The title, which is ignored. The title is always the value returned by _getName().

show

public void show()

Show the window if the _showWelcomeWindowAtStartup parameter is not set or is true.

Overrides:

show in class Top

_close

protected boolean _close()

Read the "Show this dialog on startup" checkbox, update the preferences if necessary and then call the super class and close this window. This method is called by Top.close().

Overrides:

_close in class TableauFrame

Returns:

False if the user cancels on a save query.

_getName

protected java.lang.String _getName()

Get the name of this object, which in this case is the string "Welcome".

Overrides:

_getName in class TableauFrame

Returns:

The string "Welcome";