byucc.jhdl.apps.Viewers
Class ViewerFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      byucc.jhdl.util.ui.AppUIFrame
                          byucc.jhdl.apps.Viewers.ViewerFrame

All Implemented Interfaces:

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

Direct Known Subclasses:

cvtFrame, MemoryViewerFrame, SchematicViewerFrame, TreeBrowserFrame, TreeBrowserFrame, WavesWireFrame, WiresTableFrame

public abstract class ViewerFrame

extends AppUIFrame

implements java.awt.event.ActionListener

Provides constants and code common to various frame generator class in byucc.jhdl.apps.Viewers. Subclasses must implement the abstract methods found in this class, as well as the actionPerformed method of the ActionListener interface. In the constructor of the subclass, the buildAndShowFrame method should be called. Note that this class makes the JFrame do nothing on a window closing event. Instead, an ActionEvent with the action specified in ACTION_CLOSE is generated and sent to the actionPerformed method.

Author:

Anthony L. Slade

See Also:

Serialized Form

Nested Class Summary

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

static java.lang.String	ACTION_CLOSE String used for the close action command
static java.lang.String	ACTION_EXIT String used for the exit action command
static int	DEFAULT_LOCATION_X The default horizontal offset for position on screen
static int	DEFAULT_LOCATION_Y The default vertical offset for position on screen
static boolean	DEFAULT_SHOW_CONFIRM_DIALOG_ON_CLOSE
static boolean	DEFAULT_SHOW_CONFIRM_DIALOG_ON_EXIT
static boolean	DEFAULT_SYSTEM_EXIT_WHEN_ALL_VIEWERFRAMES_CLOSED This constant is true
protected boolean	showConfirmDialogOnClose
protected boolean	showConfirmDialogOnExit

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

ViewerFrame()

ViewerFrame(java.lang.String title)

Method Summary

protected void	buildAndShowFrame() Calling this method will initialize the content panel by calling the buildContentPanel method, initialize the menu bar by calling buildMenuBar, and will setup other properties of the frame, especially window closing handling.
protected abstract java.awt.Container	buildContentPanel() Use this method to create the sole main panel for the frame.
protected abstract javax.swing.JMenuBar	buildMenuBar() Use this method to create the JMenuBar for the frame
void	dispose() This method overridden to call System.exit() when all of the ViewerFrames are closed unless systemExitWhenAllViewerFramesClosed is false.
static boolean	setSystemExitOnAllViewerFramesClosed(boolean b) Used to update the behavior after all ViewerFrames have been closed

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, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, 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, 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, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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.event.ActionListener

actionPerformed

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

ACTION_CLOSE

public static final java.lang.String ACTION_CLOSE

String used for the close action command

See Also:

Constant Field Values

ACTION_EXIT

public static final java.lang.String ACTION_EXIT

String used for the exit action command

See Also:

Constant Field Values

DEFAULT_LOCATION_X

public static final int DEFAULT_LOCATION_X

The default horizontal offset for position on screen

See Also:

Constant Field Values

DEFAULT_LOCATION_Y

public static final int DEFAULT_LOCATION_Y

The default vertical offset for position on screen

See Also:

Constant Field Values

DEFAULT_SYSTEM_EXIT_WHEN_ALL_VIEWERFRAMES_CLOSED

public static final boolean DEFAULT_SYSTEM_EXIT_WHEN_ALL_VIEWERFRAMES_CLOSED

This constant is true

See Also:

Constant Field Values

DEFAULT_SHOW_CONFIRM_DIALOG_ON_EXIT

public static final boolean DEFAULT_SHOW_CONFIRM_DIALOG_ON_EXIT

See Also:

Constant Field Values

DEFAULT_SHOW_CONFIRM_DIALOG_ON_CLOSE

public static final boolean DEFAULT_SHOW_CONFIRM_DIALOG_ON_CLOSE

See Also:

Constant Field Values

showConfirmDialogOnExit

protected boolean showConfirmDialogOnExit

showConfirmDialogOnClose

protected boolean showConfirmDialogOnClose

Constructor Detail

ViewerFrame

public ViewerFrame()

ViewerFrame

public ViewerFrame(java.lang.String title)

Method Detail

setSystemExitOnAllViewerFramesClosed

public static boolean setSystemExitOnAllViewerFramesClosed(boolean b)

Used to update the behavior after all ViewerFrames have been closed

Parameters:

b - if true System.exit will be called when the last open ViewerFrame is disposed, otherwise, nothing beyond closing will happen when closing the ViewerFrames

Returns:

the previous setting for systemExitWhenAllViewerFramesClosed

dispose

public void dispose()

This method overridden to call System.exit() when all of the ViewerFrames are closed unless systemExitWhenAllViewerFramesClosed is false.

buildContentPanel

protected abstract java.awt.Container buildContentPanel()

Use this method to create the sole main panel for the frame. This panel may be comprised of other subpanels.

Returns:

a Container to be used as the content panel for the frame.

buildMenuBar

protected abstract javax.swing.JMenuBar buildMenuBar()

Use this method to create the JMenuBar for the frame

Returns:

the JMenuBar for the frame.

buildAndShowFrame

protected void buildAndShowFrame()

Calling this method will initialize the content panel by calling the buildContentPanel method, initialize the menu bar by calling buildMenuBar, and will setup other properties of the frame, especially window closing handling. Then this method packs the frame and sets it visible.