HubFrame (CharGer4 Documentation)

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

All Implemented Interfaces:

chargerlib.ManagedWindow, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
```
public class HubFrame
extends JFrame
implements chargerlib.ManagedWindow
```
Central frame for coordinating CharGer graphs. Maintains a current list of graphs in the graph directory, and some other miscellaneous information about CharGer.

Author:

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

See Also:

Serialized Form

Nested Class Summary
- 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

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) JLabel`	`AvailLabel`
`(package private) chargerlib.CGButton`	`BrowseButton`
`(package private) JLabel`	`CGLabel`
`(package private) JLabel`	`CharGerLogoLabel`
`(package private) chargerlib.CGButton`	`CloseAllButton`
`(package private) JLabel`	`CopyrightNotice`
`static DatabaseFrame`	`DataBaseLinkToolWindow`
`(package private) JLabel`	`EmailAddressLabel`
`(package private) JLabel`	`freeMemory`
`(package private) JList`	`GraphDisplayList`
`(package private) JScrollPane`	`GraphDisplayPane`
`(package private) JTextField`	`GraphFolderField`
`(package private) JLabel`	`GraphFolderLabel`
`long`	`GraphFolderLastModified` time value at which the graphs folder was modified; used in keeping the graph list up to date.
`(package private) Frame`	`hub`
`(package private) JLabel`	`HubLabel`
`(package private) JLabel`	`icon`
`(package private) JMenuBar`	`mainMenuBar`
`(package private) JMenuItem`	`menuConvertCGXML`
`(package private) JMenu`	`menuFile`
`(package private) JMenuItem`	`menuFileNewGraph`
`(package private) JMenuItem`	`menuFileOpen`
`(package private) JMenuItem`	`menuFileOpenCGIF`
`(package private) JMenuItem`	`menuFilePreferences`
`(package private) JMenu`	`menuTools`
`(package private) JMenuItem`	`menuToolsCraftTool`
`(package private) JMenuItem`	`menuToolsDatabaseLinkingTool`
`(package private) JMenuItem`	`menuToolsQuit`
`Action`	`MMTeamAnalysisAction`
`private boolean`	`mShown`
`(package private) chargerlib.CGButton`	`NewWindowButton`
`JMenuItem`	`NewWindowItem`
`(package private) chargerlib.CGButton`	`OpenAllButton`
`(package private) chargerlib.CGButton`	`OpenButton`
`(package private) chargerlib.CGButton`	`QuitButton`
`(package private) chargerlib.CGButton`	`SaveAllAsCGIFButton`
`(package private) JLabel`	`totalMemory`
`(package private) JLabel`	`usedMemory`
`(package private) JLabel`	`VersionInfo`
`(package private) JButton`	`WebAddressButton`
`(package private) JMenu`	`windowMenu`

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

HubFrame()

Constructors
Constructor and Description
`HubFrame()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addModuleMenuItem(ModulePlugin module)` Method for adding external modules to the Tools menu.
`void`	`addNotify()`
`void`	`BrowseButtonActionPerformed(ActionEvent e)`
`void`	`CloseAllButtonActionPerformed(ActionEvent e)`
`JPanel`	`getAboutPanel()`
`static List<Class<?>>`	`getClassesInPackage(String packageName)`
`String`	`getFilename()`
`JMenu`	`getHelpMenu()` Create a fully populated help menu suitable for adding to a menu bar.
`String`	`getMenuItemLabel()` Part of the ManagedWindow interface
`ArrayList<Class>`	`getPluginClasses()`
`JMenu`	`getWindowMenu()`
`void`	`GraphDisplayListItemStateChanged(ListSelectionEvent e)` Doesn't do anything while user is making selections
`void`	`GraphDisplayListMouseClicked(MouseEvent e)`
`void`	`initComponents()`
`void`	`loadModulePlugins()` Gets an instance of the plugin class for every external module.
`void`	`menuFileNewGraphActionPerformed(ActionEvent e)`
`void`	`menuFileOpenActionPerformed(ActionEvent e)` Loads a graph into a new edit frame.
`void`	`menuFileOpenCGIFActionPerformed(ActionEvent e)`
`void`	`menuFilePreferencesActionPerformed(ActionEvent e)`
`void`	`menuToolsDatabaseLinkingToolActionPerformed(ActionEvent e)`
`void`	`menuToolsQuitActionPerformed(ActionEvent e)`
`void`	`NewWindowButtonActionPerformed(ActionEvent e)`
`void`	`OpenAllButtonActionPerformed(ActionEvent e)`
`void`	`OpenButtonActionPerformed(ActionEvent e)` Get all the selected file names, and convert them from objects to strings, then open them
`void`	`openCGIFActionPerformed(ActionEvent e)`
`void`	`openNamedFiles(String[] files)` Opens a list of files, each in its own editor window.
`void`	`performActionBackToHub()` Go back to the master frame main window, forcing it to be updated.
`void`	`performActionMMTeamAnalysis()` Instantiates an MProject, which then spawns all the other windows and classes needed for the MMAT.
`void`	`QuitButtonActionPerformed(ActionEvent e)`
`void`	`refresh()` Updates all the menus and displays in the master frame, but not responsible for repaint.
`void`	`refreshFileList()` re-reads the directory to re-display the list of graph files in the user directory
`void`	`refreshToolsMenu()` Called at startup, and whenever the mix of tools changes.
`void`	`SaveAllAsCGIFButtonActionPerformed()` Convenience method for calling FileToGraph repeatedly for all files in the displaylist.
`void`	`thisFocusGained(FocusEvent e)`
`void`	`thisWindowActivated(WindowEvent e)`
`void`	`thisWindowClosing(WindowEvent e)`

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
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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface MenuContainer
getFont, postEvent

- Field Detail
  - NewWindowItem
```
public JMenuItem NewWindowItem
```
  - DataBaseLinkToolWindow
```
public static DatabaseFrame DataBaseLinkToolWindow
```
  - GraphFolderLastModified
```
public long GraphFolderLastModified
```
    time value at which the graphs folder was modified; used in keeping the graph list up to date.
  - AvailLabel
```
JLabel AvailLabel
```
  - GraphDisplayList
```
JList GraphDisplayList
```
  - GraphDisplayPane
```
JScrollPane GraphDisplayPane
```
  - OpenAllButton
```
chargerlib.CGButton OpenAllButton
```
  - CloseAllButton
```
chargerlib.CGButton CloseAllButton
```
  - SaveAllAsCGIFButton
```
chargerlib.CGButton SaveAllAsCGIFButton
```
  - BrowseButton
```
chargerlib.CGButton BrowseButton
```
  - OpenButton
```
chargerlib.CGButton OpenButton
```
  - mainMenuBar
```
JMenuBar mainMenuBar
```
  - menuFile
```
JMenu menuFile
```
  - menuFileNewGraph
```
JMenuItem menuFileNewGraph
```
  - menuFileOpen
```
JMenuItem menuFileOpen
```
  - menuFileOpenCGIF
```
JMenuItem menuFileOpenCGIF
```
  - menuFilePreferences
```
JMenuItem menuFilePreferences
```
  - menuToolsQuit
```
JMenuItem menuToolsQuit
```
  - menuConvertCGXML
```
JMenuItem menuConvertCGXML
```
  - menuTools
```
JMenu menuTools
```
  - menuToolsDatabaseLinkingTool
```
JMenuItem menuToolsDatabaseLinkingTool
```
  - menuToolsCraftTool
```
JMenuItem menuToolsCraftTool
```
  - MMTeamAnalysisAction
```
public Action MMTeamAnalysisAction
```
  - windowMenu
```
JMenu windowMenu
```
  - NewWindowButton
```
chargerlib.CGButton NewWindowButton
```
  - QuitButton
```
chargerlib.CGButton QuitButton
```
  - CopyrightNotice
```
JLabel CopyrightNotice
```
  - VersionInfo
```
JLabel VersionInfo
```
  - GraphFolderLabel
```
JLabel GraphFolderLabel
```
  - GraphFolderField
```
JTextField GraphFolderField
```
  - EmailAddressLabel
```
JLabel EmailAddressLabel
```
  - WebAddressButton
```
JButton WebAddressButton
```
  - CharGerLogoLabel
```
JLabel CharGerLogoLabel
```
  - HubLabel
```
JLabel HubLabel
```
  - CGLabel
```
JLabel CGLabel
```
  - totalMemory
```
JLabel totalMemory
```
  - usedMemory
```
JLabel usedMemory
```
  - freeMemory
```
JLabel freeMemory
```
  - icon
```
JLabel icon
```
  - mShown
```
private boolean mShown
```
  - hub
```
Frame hub
```
- Constructor Detail
  - HubFrame
```
public HubFrame()
```
- Method Detail
  - initComponents
```
public void initComponents()
```
  - addNotify
```
public void addNotify()
```
    Overrides:
    
    addNotify in class Frame
  - thisWindowClosing
```
public void thisWindowClosing(WindowEvent e)
```
  - refreshFileList
```
public void refreshFileList()
```
    re-reads the directory to re-display the list of graph files in the user directory
  - thisFocusGained
```
public void thisFocusGained(FocusEvent e)
```
  - GraphDisplayListItemStateChanged
```
public void GraphDisplayListItemStateChanged(ListSelectionEvent e)
```
    Doesn't do anything while user is making selections
    
    See Also:
    
    OpenButtonActionPerformed(java.awt.event.ActionEvent), OpenAllButtonActionPerformed(java.awt.event.ActionEvent)
  - OpenButtonActionPerformed
```
public void OpenButtonActionPerformed(ActionEvent e)
```
    Get all the selected file names, and convert them from objects to strings, then open them
    
    See Also:
    
    openNamedFiles(java.lang.String[])
  - openNamedFiles
```
public void openNamedFiles(String[] files)
```
    Opens a list of files, each in its own editor window.
    
    Parameters:
    
    files - list of (relative) file paths
  - NewWindowButtonActionPerformed
```
public void NewWindowButtonActionPerformed(ActionEvent e)
```
  - QuitButtonActionPerformed
```
public void QuitButtonActionPerformed(ActionEvent e)
```
  - refresh
```
public void refresh()
```
    Updates all the menus and displays in the master frame, but not responsible for repaint.
  - getHelpMenu
```
public JMenu getHelpMenu()
```
    Create a fully populated help menu suitable for adding to a menu bar. Creates all of its own components, so that it's not dependent on the Hub Frame.
    
    Returns:
  - getAboutPanel
```
public JPanel getAboutPanel()
```
  - performActionMMTeamAnalysis
```
public void performActionMMTeamAnalysis()
```
    Instantiates an MProject, which then spawns all the other windows and classes needed for the MMAT.
  - performActionBackToHub
```
public void performActionBackToHub()
```
    Go back to the master frame main window, forcing it to be updated.
  - 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
  - getWindowMenu
```
public JMenu getWindowMenu()
```
    Specified by:
    
    getWindowMenu in interface chargerlib.ManagedWindow
  - thisWindowActivated
```
public void thisWindowActivated(WindowEvent e)
```
  - GraphDisplayListMouseClicked
```
public void GraphDisplayListMouseClicked(MouseEvent e)
```
  - menuToolsDatabaseLinkingToolActionPerformed
```
public void menuToolsDatabaseLinkingToolActionPerformed(ActionEvent e)
```
  - menuToolsQuitActionPerformed
```
public void menuToolsQuitActionPerformed(ActionEvent e)
```
  - menuFilePreferencesActionPerformed
```
public void menuFilePreferencesActionPerformed(ActionEvent e)
```
  - menuFileOpenActionPerformed
```
public void menuFileOpenActionPerformed(ActionEvent e)
```
    Loads a graph into a new edit frame. If the user cancels the load, no window is created.
    
    See Also:
    
    EditManager.actionPerformed(java.awt.event.ActionEvent), IOManager
  - openCGIFActionPerformed
```
public void openCGIFActionPerformed(ActionEvent e)
```
  - menuFileNewGraphActionPerformed
```
public void menuFileNewGraphActionPerformed(ActionEvent e)
```
  - menuFileOpenCGIFActionPerformed
```
public void menuFileOpenCGIFActionPerformed(ActionEvent e)
```
  - OpenAllButtonActionPerformed
```
public void OpenAllButtonActionPerformed(ActionEvent e)
```
  - SaveAllAsCGIFButtonActionPerformed
```
public void SaveAllAsCGIFButtonActionPerformed()
```
    Convenience method for calling FileToGraph repeatedly for all files in the displaylist.
  - CloseAllButtonActionPerformed
```
public void CloseAllButtonActionPerformed(ActionEvent e)
```
  - BrowseButtonActionPerformed
```
public void BrowseButtonActionPerformed(ActionEvent e)
```
  - addModuleMenuItem
```
public void addModuleMenuItem(ModulePlugin module)
```
    Method for adding external modules to the Tools menu. This eliminates the need to know in advance what the modules will be. Generates an action for the Tools menu item that calls the startup() method of the module (or the activate method if it's already activated.
    
    Parameters:
    
    module - Any class that implements the ModulePlugin interface. Although it's expected that this class is a simple "boot" class to invoke more interesting behavior, Charger's responsibility is only to provide a menu item that invokes the startup() method. For example, a module could be entirely in one class.
    
    See Also:
    
    charger.ModulePlugin
  - loadModulePlugins
```
public void loadModulePlugins()
                       throws ModuleException
```
    Gets an instance of the plugin class for every external module. Looks either in each jar file in the class path or in a folder containing classes in a class path. All plugins are instantiated, whether they are going to be activated or not.
    
    Throws:
    
    ModuleException
    
    See Also:
    
    charger.ModulePlugin
  - refreshToolsMenu
```
public void refreshToolsMenu()
```
    Called at startup, and whenever the mix of tools changes.
  - getPluginClasses
```
public ArrayList<Class> getPluginClasses()
```
    Returns:
  - getClassesInPackage
```
public static final List<Class<?>> getClassesInPackage(String packageName)
```

Class HubFrame

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

NewWindowItem

DataBaseLinkToolWindow

GraphFolderLastModified

AvailLabel

GraphDisplayList

GraphDisplayPane

OpenAllButton

CloseAllButton

SaveAllAsCGIFButton

BrowseButton

OpenButton

mainMenuBar

menuFile

menuFileNewGraph

menuFileOpen

menuFileOpenCGIF

menuFilePreferences

menuToolsQuit

menuConvertCGXML

menuTools

menuToolsDatabaseLinkingTool

menuToolsCraftTool

MMTeamAnalysisAction

windowMenu

NewWindowButton

QuitButton

CopyrightNotice

VersionInfo

GraphFolderLabel

GraphFolderField

EmailAddressLabel

WebAddressButton

CharGerLogoLabel

HubLabel

CGLabel

totalMemory

usedMemory

freeMemory

icon

mShown

hub

Constructor Detail

HubFrame

Method Detail

initComponents

addNotify

thisWindowClosing

refreshFileList

thisFocusGained

GraphDisplayListItemStateChanged

OpenButtonActionPerformed

openNamedFiles

NewWindowButtonActionPerformed

QuitButtonActionPerformed

refresh

getHelpMenu

getAboutPanel