g2d.graphviewer

Class AbstractBaseFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

g2d.graphviewer.AbstractBaseFrame

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseFrame

public abstract class AbstractBaseFrame
extends javax.swing.JFrame
implements javax.swing.event.ChangeListener

Abstract Base frame for any kind of graphviewer window that displays a net, a navigator panel, and tabbed panels to display various things.

Author:

recepticle for code written by linda for pla, ian for graphviewer

See Also:

Serialized Form

Nested Class Summary

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, java.awt.Window.Type

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowsSelections
protected static int	BOTH_COLOR
protected static int	DARK_COLOR
protected static int	FACTOR
protected javax.swing.JMenu	fileMenu
protected static java.awt.Color[]	FILL_COLORS
protected javax.swing.JMenu	graphMenu
protected GraphPanel	graphPanel
protected static java.awt.Dimension	initialSize
protected java.awt.image.BufferedImage	lastThumbnail
protected static int	LIGHT_COLOR
protected static int	MEDIUM_COLOR
static int	NAV_MAX_HEIGHT
static int	NAV_WIDTH
protected NavPanel	navPanel
protected static int	OTHER_COLOR
protected static int	PARENT_COLOR
protected static ProgressDialog	progressDialog
protected javax.swing.JScrollPane	scrollGraph
protected SEPanel	sePanel
protected javax.swing.JLabel	subtitle
protected java.lang.String	title
protected ToolBar	toolBar
protected javax.swing.JMenu	zoomMenu

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

Constructors

Constructor and Description
AbstractBaseFrame(java.lang.String title, javax.swing.JFrame parent, boolean allowsSelections) Creates a window frame for PLA application that is anchored at given parent frame (if not NULL)

Method Summary

Modifier and Type	Method and Description
void	addMenuAt(javax.swing.JMenu menu, int index) Insert a given menu to the current menu bar at given position.
boolean	allowsSelections()
protected javax.swing.JMenu	createFileMenu()
protected javax.swing.JMenu	createGraphMenu()
protected void	createMenus()
protected void	createPanels()
protected void	createToolbar()
protected javax.swing.JMenu	createZoomMenu()
protected void	focusOnTextField(boolean occ)
javax.swing.JMenu	getFileMenu()
static java.awt.Color[]	getFILL_COLORS() Obtain current fill colors for this class.
javax.swing.JMenu	getGraphMenu()
GraphPanel	getGraphPanel()
int	getMenuCount() Obtain number of menus other than the "Window" menu in the current menu bar.
NavPanel	getNavPanel()
SEPanel	getSEPanel()
java.lang.String	getTitleWithoutID()
ToolBar	getToolBar()
BaseFrame	getTopBaseFrame() Walking up the hierarchy of frames until parent is no longer of class BaseFrame and then returns the last base frame found.
javax.swing.JMenu	getZoomMenu()
static void	hideProgressDialog() Hide current modal dialog with progress bar.
boolean	isEmpty()
static void	setFILL_COLORS(java.awt.Color[] fc) Change fill colors for this class.
void	setGraph(IOPGraph graph) Set the graph of this frame to the given one.
void	setSubtitle(java.lang.String text) Adding a subtitle to this frame.
void	setTitle(java.lang.String s)
static void	showProgressDialog(java.lang.String title, java.awt.Component c) Show modal dialog with (indeterminante) progress bar with a given title.
void	stateChanged(javax.swing.event.ChangeEvent event)

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

NAV_WIDTH

public static final int NAV_WIDTH

See Also:

Constant Field Values

NAV_MAX_HEIGHT

public static final int NAV_MAX_HEIGHT

See Also:

Constant Field Values

allowsSelections

protected final boolean allowsSelections

progressDialog

protected static ProgressDialog progressDialog

fileMenu

protected javax.swing.JMenu fileMenu

zoomMenu

protected javax.swing.JMenu zoomMenu

graphMenu

protected javax.swing.JMenu graphMenu

subtitle

protected javax.swing.JLabel subtitle

toolBar

protected ToolBar toolBar

scrollGraph

protected javax.swing.JScrollPane scrollGraph

navPanel

protected NavPanel navPanel

graphPanel

protected GraphPanel graphPanel

sePanel

protected SEPanel sePanel

title

protected java.lang.String title

lastThumbnail

protected java.awt.image.BufferedImage lastThumbnail

initialSize

protected static java.awt.Dimension initialSize

FACTOR

protected static final int FACTOR

See Also:

Constant Field Values

PARENT_COLOR

protected static final int PARENT_COLOR

See Also:

Constant Field Values

OTHER_COLOR

protected static final int OTHER_COLOR

See Also:

Constant Field Values

BOTH_COLOR

protected static final int BOTH_COLOR

See Also:

Constant Field Values

LIGHT_COLOR

protected static final int LIGHT_COLOR

See Also:

Constant Field Values

MEDIUM_COLOR

protected static final int MEDIUM_COLOR

See Also:

Constant Field Values

DARK_COLOR

protected static final int DARK_COLOR

See Also:

Constant Field Values

FILL_COLORS

protected static java.awt.Color[] FILL_COLORS

Constructor Detail

AbstractBaseFrame

public AbstractBaseFrame(java.lang.String title,
                         javax.swing.JFrame parent,
                         boolean allowsSelections)

Creates a window frame for PLA application that is anchored at given parent frame (if not NULL)

Parameters:

title - String with title of window; if empty or NULL, will display "untitled"

parent - parent window of this window

allowsSelections - If true, shows "Selections" tab to set goals etc.

See Also:

NavPanel, SEPanel

Method Detail

allowsSelections

public boolean allowsSelections()

createFileMenu

protected javax.swing.JMenu createFileMenu()

createGraphMenu

protected javax.swing.JMenu createGraphMenu()

createZoomMenu

protected javax.swing.JMenu createZoomMenu()

createToolbar

protected void createToolbar()

createMenus

protected void createMenus()

createPanels

protected void createPanels()

getMenuCount

public int getMenuCount()

Obtain number of menus other than the "Window" menu in the current menu bar.

Returns:

Number of current menus

addMenuAt

public void addMenuAt(javax.swing.JMenu menu,
                      int index)

Insert a given menu to the current menu bar at given position. If given position is 0, it will prepend the given menu. If given position equals getMenuCount() it will append given menu at end but always before the "Window" menu (which should remain at the last position).

Will throw exceptions if the given menu is null or the given position is not in the above specified range [0..getMenuCount()]

Parameters:

menu - JMenu to be added to current menu bar

index - Number indicating position where to insert the menu

setTitle

public void setTitle(java.lang.String s)

Overrides:

setTitle in class java.awt.Frame

getTitleWithoutID

public java.lang.String getTitleWithoutID()

setSubtitle

public void setSubtitle(java.lang.String text)

Adding a subtitle to this frame. If the subtitle contains newlines and tabs, these will be converted to HTML tags for proper display. Also, if text has more than one line or lines are too long for current window width, will only show the first 1.3 lines by default. User can resize the area using a split pane.

Parameters:

text - String potentially containing newline and tab characters that denotes subtitle of this frame

getTopBaseFrame

public BaseFrame getTopBaseFrame()

Walking up the hierarchy of frames until parent is no longer of class BaseFrame and then returns the last base frame found.

Returns:

Last base frame encountered walking up frame hierarchy or this base frame if none such found

getFILL_COLORS

public static java.awt.Color[] getFILL_COLORS()

Obtain current fill colors for this class.

Returns:

Array of 12 Color objects that denote 4 colors each given in order of 3 shades dark - medium - light

setFILL_COLORS

public static void setFILL_COLORS(java.awt.Color[] fc)

Change fill colors for this class.

Does not prompt existing frames to update.

Parameters:

fc - Array of 12 Color objects that denote 4 colors each given in order of 3 shades dark - medium - light

focusOnTextField

protected void focusOnTextField(boolean occ)

getFileMenu

public javax.swing.JMenu getFileMenu()

getZoomMenu

public javax.swing.JMenu getZoomMenu()

getGraphMenu

public javax.swing.JMenu getGraphMenu()

getToolBar

public ToolBar getToolBar()

getGraphPanel

public GraphPanel getGraphPanel()

getSEPanel

public SEPanel getSEPanel()

getNavPanel

public NavPanel getNavPanel()

setGraph

public void setGraph(IOPGraph graph)

Set the graph of this frame to the given one. Sets the buffered image of the graph in the navigator. Infers lists of occurrences and rules from the given graph, and then updates the SE panel accordingly. Will hide any open progress dialog. Will also remove any categorization of the occurrences. To maintain the categorization, call

     setGraph(graph, getCategorization())
 

Parameters:

graph - IOPGraph to be set in this frame

isEmpty

public boolean isEmpty()

showProgressDialog

public static void showProgressDialog(java.lang.String title,
                                      java.awt.Component c)

Show modal dialog with (indeterminante) progress bar with a given title.

Parameters:

title - String with title for dialog

c - Component to center dialog over

hideProgressDialog

public static void hideProgressDialog()

Hide current modal dialog with progress bar.

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent event)

Specified by:

stateChanged in interface javax.swing.event.ChangeListener