EditFrame (CharGer4 Documentation)

Object
- Component
- - Container
  - - Window
    - - Frame
      - JFrame
        
        charger.EditFrame

All Implemented Interfaces:

chargerlib.ManagedWindow, KeyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, RootPaneContainer, WindowConstants
```
public class EditFrame
extends JFrame
implements MouseListener, MouseMotionListener, Runnable, KeyListener, chargerlib.ManagedWindow
```
EditFrame is subordinate to the main frame; this allows more than one graph frame to be created. A graph frame is a window that contains any number of graph objects or sub-graphs. All its contents are considered one "CharGer graph" whether all components are connected or not. Manages basic user interface with graphs so that CanvasPanel and EditManager can operate on them. 12-03-02 : trying to get this class free of responsibility for opening/loading file, etc.

Author:

Harry S. Delugach ( delugach@uah.edu ) Copyright (c) 1998-2020 by Harry S. Delugach.

See Also:

CanvasPanel, EditManager, OperManager, HubFrame, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class EditFrame.HandleCompEvents

class EditFrame.ManageWinEvents
- Nested classes/interfaces inherited from class JFrame
  JFrame.AccessibleJFrame
- Nested classes/interfaces inherited from class Frame
  Frame.AccessibleAWTFrame
- Nested classes/interfaces inherited from class Window
  Window.AccessibleAWTWindow, Window.Type
- Nested classes/interfaces inherited from class Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested Classes
Modifier and Type	Class and Description
`class`	`EditFrame.HandleCompEvents`
`class`	`EditFrame.ManageWinEvents`

Field Summary

Fields
Modifier and Type	Field and Description
`JMenuItem`	`ActualSizeItem`
`private boolean`	`alreadyDragging` to tell routines whether dragging in progress
`JMenuItem`	`BackToHubCmdItem`
`static Font`	`borderFont` The text to be displayed in the status bar of the edit frame
`static int`	`borderWidth`
`double`	`canvasScaleFactor` Scaling factor for this canvas panel.
`chargerlib.GenericTextFrame`	`CGIFDisplay`
`JMenuItem`	`ChangeColorBlackAndWhiteItem`
`JMenuItem`	`ChangeColorDefaultItem`
`JMenuItem`	`ChangeColorFactoryItem`
`JMenuItem`	`ChangeColorGrayscaleItem`
`JMenu`	`changeColorMenu`
`JPanel`	`changedMarker`
`JMenuItem`	`ChangeFillItem`
`JMenu`	`changeFontItem`
`JMenuItem`	`ChangeTextItem`
`private ComponentListener`	`componentAdapter`
`boolean`	`contentHasChanged` whether logical content of the graph has changed
`CanvasPanel`	`cp` Panel that contains the actual drawing objects
`(package private) GEdge`	`currentEdge` used so that mousepressed and mousereleased can communicate
`Font`	`currentFont`
`FontMetrics`	`currentFontMetrics`
`(package private) Graph`	`currentGraph` used so that mousepressed and mousereleased can communicate
`(package private) GNode`	`currentNode` used so that mousepressed and mousereleased can communicate
`(package private) GraphObject`	`currentObject` used so that mousepressed and mousereleased can communicate
`JMenuItem`	`CurrentSizeItem`
`private GraphObject`	`cursorObject` the single object under the cursor
`static Dimension`	`defaultFrameDim`
`static int`	`defaultFrameHeight`
`static int`	`defaultFrameWidth`
`JPanel`	`descriptorPanel`
`boolean`	`dotIsBeingDragged` Whether we're dragging the end of a GEdge or not
`Point2D.Double`	`dragCurrPt`
`Point2D.Double`	`dragStartPt`
`Point2D.Double`	`dragStopPt`
`private JScrollPane`	`dsp`
`JMenuBar`	`editFrameMenuBar`
`int`	`editFrameNum` Global unique number assigned to this frame; never used again in this session.
`(package private) Thread`	`editFrameThread`
`EditToolbar`	`editingToolbar`
`JMenu`	`editMenu`
`ArrayList<GraphObject>`	`EFSelectedNodes` list containing all selected nodes; maintained as nodes are selected/unselected
`ArrayList<GraphObject>`	`EFSelectedObjects` list containing all selected objects (including edges); maintained as objects are selected/unselected
`EditManager`	`emgr`
`JMenu`	`examineMenu`
`JMenu`	`fileMenu`
`JMenuItem`	`FindAgainMenuItem`
`JMenuItem`	`FindMenuItem`
`private FocusListener`	`focusAdapter`
`FormatToolbar`	`formatToolbar`
`File`	`graphAbsoluteFile`
`String`	`graphName` basename of graph, not including any suffixes, modalities, etc.
`File`	`graphSourceFile` an absolute or relative path including trailing sep (e.g., "CG/Graphs/" )
`Point2D.Double`	`lastMouseClickPoint`
`Color`	`LEDcolor`
`Color`	`lineDragColor` Color of an edge whenever we're in the process of an edge being drawn
`JTextField`	`messageBox`
`static Font`	`messageBoxFont`
`static int`	`messageBoxHeight`
`JPanel`	`messagePanel`
`chargerlib.GenericTextFrame`	`metricsDisplay`
`private boolean`	`mShown`
`private GraphObject`	`ObjectBeingDragged`
`OperManager`	`omgr`
`JMenu`	`operateMenu`
`PageFormat`	`pformat`
`PragmaticSense`	`purpose` graph's modality, as an abbreviation
`JMenuItem`	`RedoItem`
`static double`	`scaleIncrement` Quantum increment for scaling.
`int`	`scaleIndex` number of increments to add or subtract from 1.
`boolean`	`selectionIsBeingDragged` Whether we're dragging a selection or just dragging for the fun of it.
`Rectangle2D.Double`	`selectionRect` physical rectangle of the selection
`static Color`	`selectionRectColor`
`JCheckBoxMenuItem`	`ShowGlossMenuItem`
`JMenuItem`	`ShowHistoryMenuItem`
`boolean`	`showRubberBand` whether to display a rubber band while dragging
`boolean`	`somethingHasBeenSelected` whether there is anything already selected
`boolean`	`somethingHasChanged` whether anything (including positioning) in the graph has changed
`JScrollPane`	`sp` the pane in which cp is contained, for scrolling purposes only
`JMenu`	`testingItemsMenu`
`chargerlib.GenericTextFrame`	`textFormDisplay` Utility windows possibly used by this frame
`Graph`	`TheGraph` The root graph of the edit frame
`ThreadGroup`	`threadgroup` the group to which all this window's updaters belong
`JMenuItem`	`UndoItem`
`JMenu`	`viewMenu`
`private WindowAdapter`	`windowAdapter`
`JMenu`	`windowMenu`
`chargerlib.GenericTextFrame`	`XMLDisplay`
`static int`	`xoffsetForCopy`
`static int`	`yoffsetForCopy`
`JMenuItem`	`ZoomInItem`
`JMenuItem`	`ZoomOutItem`

Fields inherited from class JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class 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 Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`EditFrame()` Creates an empty editing window, with an empty graph and untitled filename.
`EditFrame(File graphFile, Graph g, boolean needsSaving)` Creates a new editing window based on the filename being a suffix-ed CG file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToSelection(GraphObject go)` Mark an object as being selected, and let the edit frame know that something was selected.
`Point2D.Double`	`antiscaled(Point2D.Double p)` Convert a logical point of the canvas's graphics context into its physical location in the panel.
`Rectangle2D.Double`	`antiscaled(Rectangle2D.Double r)` Convert a logical rectangle of the canvas's graphics context into its physical rectangle in the panel.
`void`	`attachGraphToFrame(String filename, Graph startingGraph, boolean needsSaving)` Attaches a graph to an edit frame, using the filename as a guide.
`void`	`clearStatus()` Blanks out the status line at the bottom of the editing frame
`boolean`	`closeOut()` Does a logical close (with respect to the user).
`void`	`displayOneLiner(String s)` Shows a string in the message box.
`void`	`doDoubleClick(MouseEvent me)` Processes 2-click events; called by mouseClicked.
`boolean`	`entireGraphSelected(Graph g)` Checks to see if the entire (deep) contents of the target context graph are selected
`protected void`	`finalize()`
`void`	`fixToolbarDisplay()` For all the selected nodes, determines what best to show on the format toolbar.
`String`	`getFilename()`
`String`	`getGraphName()` Returns the graph name (NOT the filename) of the current window.
`String`	`getMenuItemLabel()` Part of the ManagedWindow interface
`boolean`	`getShowRubberBand()`
`JMenu`	`getWindowMenu()`
`private String`	`identifyComponent(Component c)`
`void`	`includeContextMembers()` For every selected object, if it's a context, make sure all its components are marked HERE!!
`void`	`includeContextMembers(Graph g)` For the given graph, mark its contents (recursively) as selected
`GraphObject`	`insideGEdge(Point2D.Double p)` Determine whether there is any GEdge whose display rectangle contains a point on the canvas.
`GraphObject`	`insideGNode(Point2D.Double p)` Determine whether a given point is conntained in any GNode's display rectangle.
`void`	`keyPressed(KeyEvent e)` Handles key-presses while on the canvas.
`void`	`keyReleased(KeyEvent e)`
`void`	`keyTyped(KeyEvent e)`
`void`	`makeContext(ArrayList selectedNodes, String what, Rectangle2D.Double border)` Gathers a collection of objects into a single graph we call a context Assumes all selected objects have isSelected set Assumes all selected objects are in the same outer graph
`void`	`mouseClicked(MouseEvent me)` Handles actual mouse clicks, noting that most work is done by press and release.
`void`	`mouseDragged(MouseEvent me)` Performed while the mouse is being dragged.
`void`	`mouseEntered(MouseEvent me)`
`void`	`mouseExited(MouseEvent me)`
`void`	`mouseMoved(MouseEvent me)` Track the mouse's movements.
`void`	`mousePressed(MouseEvent me)` Handles the operations needed when the mouse is pressed.
`void`	`mouseReleased(MouseEvent me)` Handles any actions where the mouse is released.
`void`	`moveSelectedObjects(Graph g, Point2D.Double delta)` Translates all selected objects by a common x,y displacement.
`GraphObject`	`onTopOfGNode(Point2D.Double p)` Determine whether a given point is on top of a GNode's relevent portion.
`GraphObject`	`onTopOfObject(Point2D.Double p)` Determine whether an object's display rectangle contains a point on the canvas.
`boolean`	`performCheckSaved()` Checks whether graph in the edit frame has been saved.
`void`	`refreshBorders()` Refreshes the top border containing the scale factor for the graph, the count for each kind of graph node, and an indication of whether actors are active.
`private void`	`refreshDescriptorPanel(AbstractTypeDescriptor[] something)`
`void`	`renameGraphInFrame(String filename)` Get purpose from the filename, so it works for a newly-opened graph too.
`void`	`requestToStop()` Sets the editFrameThread to null.
`void`	`resetSelection()` Set selection to be empty.
`void`	`run()`
`Point2D.Double`	`scaled(Point2D.Double p)` Convert a physical screen point into its logical scaled point in the context.
`void`	`setEditFrameSizes()` Only bothers with the toolbar for now...
`void`	`setGraphPragmatics(PragmaticSense mode)`
`void`	`setMenuItems()` Tell the EditManager and OperManager to examine menus and gray out items as needed
`void`	`setMyCursor()` Decide which cursor to show if we're positioned on something interesting.
`void`	`setMyFont(Font f)` Sets the font for the edit frame.
`protected void`	`setSelectedGraphObjects(Graph g, Rectangle2D.Double r, boolean select)` For all graph objects in a graph, mark each as selected if it lies within the rect.
`void`	`setup()` Called by both constructors; for convenience.
`private void`	`setupCanvasScrollPane()`
`void`	`setupComponents()`
`private void`	`setupDescriptorPanel()`
`private void`	`setupMenus()` Adds menus to the menu bar.
`void`	`stopDragging(Point2D.Double dragStartPt, Point2D.Double dragStopPt, boolean shiftDown)` Do whatever gets done by dragging; performed when dragging has stopped.
`String`	`summarizeSelection()`
`void`	`takeFromSelection(GraphObject go)` If object is already selected, remove it from the selection.
`void`	`tearDown()` Break down the edit frame and set things to null.
`void`	`thisComponentResized(ComponentEvent e)`
`void`	`thisFocusGained(FocusEvent e)`
`void`	`thisFocusLost(FocusEvent e)`
`void`	`thisWindowActivated()`
`void`	`thisWindowClosing(WindowEvent e)` Handles close events on this frame.
`void`	`thisWindowDeactivated(WindowEvent e)`
`void`	`thisWindowOpened(WindowEvent e)`
`boolean`	`unMakeContext(ArrayList<GraphObject> selectedNodes, Rectangle2D.Double border)` Takes a single context and un-makes its border, moving all its contents out one graph level.
`void`	`windowMenuActionPerformed()`

Methods inherited from class 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 Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class 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 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 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 Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface MenuContainer
getFont, postEvent

- Field Detail
  - editingToolbar
```
public EditToolbar editingToolbar
```
  - messageBox
```
public JTextField messageBox
```
  - messagePanel
```
public JPanel messagePanel
```
  - descriptorPanel
```
public JPanel descriptorPanel
```
  - dsp
```
private JScrollPane dsp
```
  - componentAdapter
```
private ComponentListener componentAdapter
```
  - windowAdapter
```
private WindowAdapter windowAdapter
```
  - focusAdapter
```
private FocusListener focusAdapter
```
  - borderWidth
```
public static int borderWidth
```
  - defaultFrameWidth
```
public static int defaultFrameWidth
```
  - defaultFrameHeight
```
public static int defaultFrameHeight
```
  - defaultFrameDim
```
public static Dimension defaultFrameDim
```
  - messageBoxHeight
```
public static int messageBoxHeight
```
  - messageBoxFont
```
public static Font messageBoxFont
```
  - borderFont
```
public static Font borderFont
```
    The text to be displayed in the status bar of the edit frame
  - selectionRectColor
```
public static Color selectionRectColor
```
  - LEDcolor
```
public Color LEDcolor
```
  - currentFont
```
public Font currentFont
```
  - currentFontMetrics
```
public FontMetrics currentFontMetrics
```
  - changedMarker
```
public JPanel changedMarker
```
  - editFrameMenuBar
```
public JMenuBar editFrameMenuBar
```
  - fileMenu
```
public JMenu fileMenu
```
  - editMenu
```
public JMenu editMenu
```
  - viewMenu
```
public JMenu viewMenu
```
  - examineMenu
```
public JMenu examineMenu
```
  - operateMenu
```
public JMenu operateMenu
```
  - changeFontItem
```
public JMenu changeFontItem
```
  - changeColorMenu
```
public JMenu changeColorMenu
```
  - windowMenu
```
public JMenu windowMenu
```
  - BackToHubCmdItem
```
public JMenuItem BackToHubCmdItem
```
  - UndoItem
```
public JMenuItem UndoItem
```
  - RedoItem
```
public JMenuItem RedoItem
```
  - testingItemsMenu
```
public JMenu testingItemsMenu
```
  - ChangeTextItem
```
public JMenuItem ChangeTextItem
```
  - ChangeFillItem
```
public JMenuItem ChangeFillItem
```
  - ChangeColorDefaultItem
```
public JMenuItem ChangeColorDefaultItem
```
  - ChangeColorFactoryItem
```
public JMenuItem ChangeColorFactoryItem
```
  - ChangeColorBlackAndWhiteItem
```
public JMenuItem ChangeColorBlackAndWhiteItem
```
  - ChangeColorGrayscaleItem
```
public JMenuItem ChangeColorGrayscaleItem
```
  - ZoomInItem
```
public JMenuItem ZoomInItem
```
  - ZoomOutItem
```
public JMenuItem ZoomOutItem
```
  - ActualSizeItem
```
public JMenuItem ActualSizeItem
```
  - CurrentSizeItem
```
public JMenuItem CurrentSizeItem
```
  - FindMenuItem
```
public JMenuItem FindMenuItem
```
  - FindAgainMenuItem
```
public JMenuItem FindAgainMenuItem
```
  - ShowHistoryMenuItem
```
public JMenuItem ShowHistoryMenuItem
```
  - ShowGlossMenuItem
```
public JCheckBoxMenuItem ShowGlossMenuItem
```
  - editFrameNum
```
public int editFrameNum
```
    Global unique number assigned to this frame; never used again in this session.
  - graphName
```
public String graphName
```
    basename of graph, not including any suffixes, modalities, etc.
  - purpose
```
public PragmaticSense purpose
```
    graph's modality, as an abbreviation
  - graphSourceFile
```
public File graphSourceFile
```
    an absolute or relative path including trailing sep (e.g., "CG/Graphs/" )
  - graphAbsoluteFile
```
public File graphAbsoluteFile
```
  - pformat
```
public PageFormat pformat
```
  - TheGraph
```
public Graph TheGraph
```
    The root graph of the edit frame
  - emgr
```
public EditManager emgr
```
  - omgr
```
public OperManager omgr
```
  - formatToolbar
```
public FormatToolbar formatToolbar
```
  - somethingHasChanged
```
public boolean somethingHasChanged
```
    whether anything (including positioning) in the graph has changed
  - contentHasChanged
```
public boolean contentHasChanged
```
    whether logical content of the graph has changed
  - somethingHasBeenSelected
```
public boolean somethingHasBeenSelected
```
    whether there is anything already selected
  - EFSelectedNodes
```
public ArrayList<GraphObject> EFSelectedNodes
```
    list containing all selected nodes; maintained as nodes are selected/unselected
  - EFSelectedObjects
```
public ArrayList<GraphObject> EFSelectedObjects
```
    list containing all selected objects (including edges); maintained as objects are selected/unselected
  - threadgroup
```
public ThreadGroup threadgroup
```
    the group to which all this window's updaters belong
  - xoffsetForCopy
```
public static int xoffsetForCopy
```
  - yoffsetForCopy
```
public static int yoffsetForCopy
```
  - cp
```
public CanvasPanel cp
```
    Panel that contains the actual drawing objects
  - sp
```
public JScrollPane sp
```
    the pane in which cp is contained, for scrolling purposes only
  - selectionRect
```
public Rectangle2D.Double selectionRect
```
    physical rectangle of the selection
  - cursorObject
```
private GraphObject cursorObject
```
    the single object under the cursor
  - showRubberBand
```
public boolean showRubberBand
```
    whether to display a rubber band while dragging
  - alreadyDragging
```
private boolean alreadyDragging
```
    to tell routines whether dragging in progress
  - ObjectBeingDragged
```
private GraphObject ObjectBeingDragged
```
  - dragStartPt
```
public Point2D.Double dragStartPt
```
  - dragStopPt
```
public Point2D.Double dragStopPt
```
  - dragCurrPt
```
public Point2D.Double dragCurrPt
```
  - lastMouseClickPoint
```
public Point2D.Double lastMouseClickPoint
```
  - selectionIsBeingDragged
```
public boolean selectionIsBeingDragged
```
    Whether we're dragging a selection or just dragging for the fun of it.
  - dotIsBeingDragged
```
public boolean dotIsBeingDragged
```
    Whether we're dragging the end of a GEdge or not
  - lineDragColor
```
public Color lineDragColor
```
    Color of an edge whenever we're in the process of an edge being drawn
  - canvasScaleFactor
```
public double canvasScaleFactor
```
    Scaling factor for this canvas panel. Initialized to be the same as the Global's. Scale factor means the percentage of full-size as displayed on the canvas. For example a scale factor of 0.50 means that the graph will appear to be half its normal size.
    
    See Also:
    
    Global.ScalingFactor
  - scaleIncrement
```
public static double scaleIncrement
```
    Quantum increment for scaling. Each unit of scale index corresponds to this much scaling factor.
    
    See Also:
    
    scaleIndex
  - scaleIndex
```
public int scaleIndex
```
    number of increments to add or subtract from 1. Varies from -9 to 20; these values are to be multiplied by an increment
    
    See Also:
    
    scaleIncrement
  - textFormDisplay
```
public chargerlib.GenericTextFrame textFormDisplay
```
    Utility windows possibly used by this frame
  - CGIFDisplay
```
public chargerlib.GenericTextFrame CGIFDisplay
```
  - XMLDisplay
```
public chargerlib.GenericTextFrame XMLDisplay
```
  - metricsDisplay
```
public chargerlib.GenericTextFrame metricsDisplay
```
  - mShown
```
private boolean mShown
```
  - editFrameThread
```
Thread editFrameThread
```
  - currentObject
```
GraphObject currentObject
```
    used so that mousepressed and mousereleased can communicate
  - currentNode
```
GNode currentNode
```
    used so that mousepressed and mousereleased can communicate
  - currentEdge
```
GEdge currentEdge
```
    used so that mousepressed and mousereleased can communicate
  - currentGraph
```
Graph currentGraph
```
    used so that mousepressed and mousereleased can communicate
- Constructor Detail
  - EditFrame
```
public EditFrame()
```
    Creates an empty editing window, with an empty graph and untitled filename. Starts this editing window's thread, and requests focus for the drawing panel.
    
    See Also:
    
    attachGraphToFrame(java.lang.String, charger.obj.Graph, boolean)
  - EditFrame
```
public EditFrame(File graphFile,
                 Graph g,
                 boolean needsSaving)
```
    Creates a new editing window based on the filename being a suffix-ed CG file. Starts this editing window's thread, and requests focus for the drawing panel.
    
    Parameters:
    
    graphFile - file in which the graph to be edited is supposed to reside
    
    g - a graph to be displayed in the frame, if one already exists in graph form
    
    needsSaving - whether the graph is to be marked as un-saved or not.
    
    See Also:
    
    Global, EditManager
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - setupComponents
```
public void setupComponents()
                     throws Exception
```
    Throws:
    
    Exception
  - attachGraphToFrame
```
public void attachGraphToFrame(String filename,
                               Graph startingGraph,
                               boolean needsSaving)
```
    Attaches a graph to an edit frame, using the filename as a guide. Assumes that the starting graph is already set up (i.e., non-null).
    
    Parameters:
    
    filename - String to use in setting up the frame's title, etc.
    
    startingGraph - A ready-to-use CharGer graph
    
    needsSaving - Whether the resulting window thinks the graph has changed since saving
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - requestToStop
```
public void requestToStop()
```
    Sets the editFrameThread to null.
  - thisWindowClosing
```
public void thisWindowClosing(WindowEvent e)
```
    Handles close events on this frame. Invokes closeOut() to see if user wants to save, etc., if not, then makes frame visible again.
  - thisWindowActivated
```
public void thisWindowActivated()
```
  - thisWindowOpened
```
public void thisWindowOpened(WindowEvent e)
```
  - thisWindowDeactivated
```
public void thisWindowDeactivated(WindowEvent e)
```
  - setup
```
public void setup()
```
    Called by both constructors; for convenience. Sets up the frame and its listener(s), sets up the mode and canvas panels, creates the message box,
  - tearDown
```
public void tearDown()
```
    Break down the edit frame and set things to null. This may help garbage collection.
  - setupCanvasScrollPane
```
private void setupCanvasScrollPane()
```
  - setupMenus
```
private void setupMenus()
```
    Adds menus to the menu bar. Actual menu contents are initialized by the tool panel's constructor (bad design!)
  - windowMenuActionPerformed
```
public void windowMenuActionPerformed()
```
  - setMenuItems
```
public void setMenuItems()
```
    Tell the EditManager and OperManager to examine menus and gray out items as needed
  - setEditFrameSizes
```
public void setEditFrameSizes()
```
    Only bothers with the toolbar for now...
  - refreshBorders
```
public void refreshBorders()
```
    Refreshes the top border containing the scale factor for the graph, the count for each kind of graph node, and an indication of whether actors are active.
  - thisFocusGained
```
public void thisFocusGained(FocusEvent e)
```
  - thisFocusLost
```
public void thisFocusLost(FocusEvent e)
```
  - identifyComponent
```
private String identifyComponent(Component c)
```
  - keyPressed
```
public void keyPressed(KeyEvent e)
```
    Handles key-presses while on the canvas. The following keys are handled by this method: up,down,left,right arrow keys (with shift moves selection faster); plus, minus to expand or contract; delete key.
    Any other keystrokes are passed to the toolbar.
    
    Specified by:
    
    keyPressed in interface KeyListener
  - keyReleased
```
public void keyReleased(KeyEvent e)
```
    Specified by:
    
    keyReleased in interface KeyListener
  - keyTyped
```
public void keyTyped(KeyEvent e)
```
    Specified by:
    
    keyTyped in interface KeyListener
  - setGraphPragmatics
```
public void setGraphPragmatics(PragmaticSense mode)
```
  - scaled
```
public Point2D.Double scaled(Point2D.Double p)
```
    Convert a physical screen point into its logical scaled point in the context. Primarily useful for mouse-oriented operations.
    
    Parameters:
    
    p - The actual point on the canvas ( relative to the canvas panel's 0,0 point
  - antiscaled
```
public Point2D.Double antiscaled(Point2D.Double p)
```
    Convert a logical point of the canvas's graphics context into its physical location in the panel.
    
    Parameters:
    
    p - The actual point on the canvas ( relative to the canvas panel's 0,0 point
  - antiscaled
```
public Rectangle2D.Double antiscaled(Rectangle2D.Double r)
```
    Convert a logical rectangle of the canvas's graphics context into its physical rectangle in the panel.
    
    Parameters:
    
    r - The actual rectangle on the canvas ( relative to the canvas panel's 0,0 point
  - mousePressed
```
public void mousePressed(MouseEvent me)
```
    Handles the operations needed when the mouse is pressed. Choose the appropriate object (if any) and set variables for mouse released to use. Just for processing a mouse being pressed, no dragging or release yet. Needs to be fast, so we can get it out of the way for real dragging actions. Purpose is to decide what's being selected or chosen for operation. Some operations only require a mouse released to operate (e.g., edit text)
    
    Specified by:
    
    mousePressed in interface MouseListener
    
    See Also:
    
    mouseReleased(java.awt.event.MouseEvent)
  - mouseReleased
```
public void mouseReleased(MouseEvent me)
```
    Handles any actions where the mouse is released. This includes clicks. mouseclicked() is really most useful for double clicks..
    
    Specified by:
    
    mouseReleased in interface MouseListener
    
    Parameters:
    
    me -
    
    See Also:
    
    mouseClicked(java.awt.event.MouseEvent), stopDragging(java.awt.geom.Point2D.Double, java.awt.geom.Point2D.Double, boolean)
  - mouseClicked
```
public void mouseClicked(MouseEvent me)
```
    Handles actual mouse clicks, noting that most work is done by press and release.
    
    Specified by:
    
    mouseClicked in interface MouseListener
    
    See Also:
    
    mouseReleased(java.awt.event.MouseEvent), mouseClicked(java.awt.event.MouseEvent)
  - doDoubleClick
```
public void doDoubleClick(MouseEvent me)
```
    Processes 2-click events; called by mouseClicked.
  - mouseEntered
```
public void mouseEntered(MouseEvent me)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent me)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - mouseDragged
```
public void mouseDragged(MouseEvent me)
```
    Performed while the mouse is being dragged. Handles moving selections and drawing edges between nodes.
    
    Specified by:
    
    mouseDragged in interface MouseMotionListener
    
    See Also:
    
    mouseReleased(java.awt.event.MouseEvent)
  - stopDragging
```
public void stopDragging(Point2D.Double dragStartPt,
                         Point2D.Double dragStopPt,
                         boolean shiftDown)
```
    Do whatever gets done by dragging; performed when dragging has stopped. Does not matter the relative orientation of the two points on the coordinate plane. There's a bug in moving nested contexts. Need to move all the context's inner contents BEFORE determining its new display rect.
    
    Parameters:
    
    dragStartPt - the point at which the user started to drag
    
    dragStopPt - the point at which the user stopped the dragging
    
    shiftDown - whether the user is holding the shift key when the drag stops.
  - mouseMoved
```
public void mouseMoved(MouseEvent me)
```
    Track the mouse's movements. Sets the cursor to the move cursor when the mouse is able to select an object (edge, graph included).
    
    Specified by:
    
    mouseMoved in interface MouseMotionListener
    
    Parameters:
    
    me - used for determining where the mouse is.
  - onTopOfObject
```
public GraphObject onTopOfObject(Point2D.Double p)
```
    Determine whether an object's display rectangle contains a point on the canvas. A context is treated just as a (possibly large) rectangle boundary.
    
    Parameters:
    
    p - the point on the canvas
    
    Returns:
    
    the object if there is one, null otherwise
    
    See Also:
    
    insideGNode(java.awt.geom.Point2D.Double)
  - onTopOfGNode
```
public GraphObject onTopOfGNode(Point2D.Double p)
```
    Determine whether a given point is on top of a GNode's relevent portion. Same as insideGNode() except when applied to a Graph: a point inside the context will not return the context unless the point lies on the thin border enclosing the context.
    
    Parameters:
    
    p - the point on the canvas
    
    Returns:
    
    the GNode if there is one, null otherwise
    
    See Also:
    
    onTopOfObject(java.awt.geom.Point2D.Double), insideGNode(java.awt.geom.Point2D.Double)
  - insideGNode
```
public GraphObject insideGNode(Point2D.Double p)
```
    Determine whether a given point is conntained in any GNode's display rectangle.
    
    Parameters:
    
    p - the point on the canvas
    
    Returns:
    
    the GNode if there is one, null otherwise
    
    See Also:
    
    onTopOfObject(java.awt.geom.Point2D.Double), onTopOfGNode(java.awt.geom.Point2D.Double)
  - insideGEdge
```
public GraphObject insideGEdge(Point2D.Double p)
```
    Determine whether there is any GEdge whose display rectangle contains a point on the canvas.
    
    Parameters:
    
    p - the point on the canvas
    
    Returns:
    
    the GEdge if there is one, null otherwise
    
    See Also:
    
    onTopOfObject(java.awt.geom.Point2D.Double), insideGNode(java.awt.geom.Point2D.Double)
  - includeContextMembers
```
public void includeContextMembers()
```
    For every selected object, if it's a context, make sure all its components are marked HERE!!
  - includeContextMembers
```
public void includeContextMembers(Graph g)
```
    For the given graph, mark its contents (recursively) as selected
  - setSelectedGraphObjects
```
protected void setSelectedGraphObjects(Graph g,
                                       Rectangle2D.Double r,
                                       boolean select)
```
    For all graph objects in a graph, mark each as selected if it lies within the rect. NEED TO LOOK HERE!!! but why?
    
    Parameters:
    
    g - look through all objects in this graph
    
    r - bounding rectangle within which to select
    
    select - whether to select or de-select the objects in question
  - moveSelectedObjects
```
public void moveSelectedObjects(Graph g,
                                Point2D.Double delta)
```
    Translates all selected objects by a common x,y displacement.
    
    Parameters:
    
    g - outermost graph in which anything could be moved into or out of
    
    delta - the translation displacement
  - addToSelection
```
public void addToSelection(GraphObject go)
```
    Mark an object as being selected, and let the edit frame know that something was selected.
    
    Parameters:
    
    go - Object to be marked as selected. If already selected, has no effect.
  - takeFromSelection
```
public void takeFromSelection(GraphObject go)
```
    If object is already selected, remove it from the selection. If not selected, has no effect.
    
    Parameters:
    
    go - Object to be removed if possible.
  - resetSelection
```
public void resetSelection()
```
    Set selection to be empty. Don't show a "rubber band" selection rectangle and
  - summarizeSelection
```
public String summarizeSelection()
```
  - getShowRubberBand
```
public boolean getShowRubberBand()
```
    Returns:
    
    whether "rubber band" border is to be shown or not
  - fixToolbarDisplay
```
public void fixToolbarDisplay()
```
    For all the selected nodes, determines what best to show on the format toolbar.
  - makeContext
```
public void makeContext(ArrayList selectedNodes,
                        String what,
                        Rectangle2D.Double border)
                 throws CGContextException
```
    Gathers a collection of objects into a single graph we call a context Assumes all selected objects have isSelected set Assumes all selected objects are in the same outer graph
    
    Parameters:
    
    selectedNodes - Collection of the objects to be placed into the context
    
    what - either "context" or "cut"
    
    border - The minimum rectangle to form the context boundary; may be expanded if necessary.
    
    Throws:
    
    CGContextException
  - unMakeContext
```
public boolean unMakeContext(ArrayList<GraphObject> selectedNodes,
                             Rectangle2D.Double border)
                      throws CGContextException
```
    Takes a single context and un-makes its border, moving all its contents out one graph level. Leaves everything in the selection set, but they may be in different contexts.
    
    Parameters:
    
    selectedNodes - Nodes to be un-made; must be a single context.
    
    border - the enclosed area -- should contain exactly one context.
    
    Returns:
    
    whether any change was made Actually, this probably works as long as only one dominated context is enclosed, ignoring others
    
    Throws:
    
    CGContextException
  - entireGraphSelected
```
public boolean entireGraphSelected(Graph g)
```
    Checks to see if the entire (deep) contents of the target context graph are selected
    
    Parameters:
    
    g - The graph to be checked
    
    Returns:
    
    Whether all objects (nodes) are selected
  - setMyCursor
```
public void setMyCursor()
```
    Decide which cursor to show if we're positioned on something interesting. If we're deleting something, use a crosshair. If we're editing text, use a text cursor. Otherwise, use a move cursor.
  - setMyFont
```
public void setMyFont(Font f)
```
    Sets the font for the edit frame.
    
    Parameters:
    
    f - font to which the edit frame should be set.
  - clearStatus
```
public void clearStatus()
```
    Blanks out the status line at the bottom of the editing frame
  - displayOneLiner
```
public void displayOneLiner(String s)
```
    Shows a string in the message box.
    
    Parameters:
    
    s - String to be displayed.
  - closeOut
```
public boolean closeOut()
```
    Does a logical close (with respect to the user). This is where most of the real cleanup code goes -- since we cannot reliably depend on finalize.
    
    Returns:
    
    true if everything worked out okay; false if we still need to do something (e.g., save it, or cancel).
  - performCheckSaved
```
public boolean performCheckSaved()
```
    Checks whether graph in the edit frame has been saved. If not, then prompts user for whether to save it or not.
    
    Returns:
    
    false if user cancels, true if user either saves or chooses not to save.
  - getGraphName
```
public String getGraphName()
```
    Returns the graph name (NOT the filename) of the current window.
    
    Returns:
    
    the graph name plus a modality if they are active
  - renameGraphInFrame
```
public void renameGraphInFrame(String filename)
```
    Get purpose from the filename, so it works for a newly-opened graph too.
    
    Parameters:
    
    filename - fully qualified path/file for the new graph
  - thisComponentResized
```
public void thisComponentResized(ComponentEvent e)
```
  - refreshDescriptorPanel
```
private void refreshDescriptorPanel(AbstractTypeDescriptor[] something)
```
  - setupDescriptorPanel
```
private void setupDescriptorPanel()
```
  - getMenuItemLabel
```
public String getMenuItemLabel()
```
    Part of the ManagedWindow interface
    
    Specified by:
    
    getMenuItemLabel in interface chargerlib.ManagedWindow
    
    See Also:
    
    ManagedWindow
  - getFilename
```
public String getFilename()
```
    Specified by:
    
    getFilename in interface chargerlib.ManagedWindow
    
    Returns:
    
    Absolute path name for the file in this frame
  - getWindowMenu
```
public JMenu getWindowMenu()
```
    Specified by:
    
    getWindowMenu in interface chargerlib.ManagedWindow

Class EditFrame

Nested Class Summary

Nested classes/interfaces inherited from class JFrame

Nested classes/interfaces inherited from class Frame

Nested classes/interfaces inherited from class Window

Nested classes/interfaces inherited from class Container

Nested classes/interfaces inherited from class Component

Field Summary

Fields inherited from class JFrame

Fields inherited from class Frame

Fields inherited from class Component

Fields inherited from interface WindowConstants

Fields inherited from interface ImageObserver

Constructor Summary

Method Summary

Methods inherited from class JFrame

Methods inherited from class Frame

Methods inherited from class Window

Methods inherited from class Container

Methods inherited from class Component

Methods inherited from class Object

Methods inherited from interface MenuContainer

Field Detail

editingToolbar

messageBox

messagePanel

descriptorPanel

dsp

componentAdapter

windowAdapter

focusAdapter

borderWidth

defaultFrameWidth

defaultFrameHeight

defaultFrameDim

messageBoxHeight

messageBoxFont

borderFont

selectionRectColor

LEDcolor

currentFont

currentFontMetrics

changedMarker

editFrameMenuBar

fileMenu

editMenu

viewMenu

examineMenu

operateMenu

changeFontItem

changeColorMenu

windowMenu

BackToHubCmdItem

UndoItem

RedoItem

testingItemsMenu

ChangeTextItem

ChangeFillItem

ChangeColorDefaultItem

ChangeColorFactoryItem

ChangeColorBlackAndWhiteItem

ChangeColorGrayscaleItem

ZoomInItem

ZoomOutItem

ActualSizeItem

CurrentSizeItem

FindMenuItem

FindAgainMenuItem

ShowHistoryMenuItem

ShowGlossMenuItem

editFrameNum

graphName

purpose

graphSourceFile

graphAbsoluteFile

pformat

TheGraph

emgr

omgr

formatToolbar