org.norvelle.textcite.gui
Class MainFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.norvelle.textcite.gui.MainFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class MainFrame
extends javax.swing.JFrame

Title: MainFrame.java.

Description: The main JFrame for the BookCite GUI. Also provides controller functionality for the simpler Actions required for handling main menu/toolbar events.

Copyright: Copyright Erik Norvelle (c) 2006

Version:

0.4d

Author:

Erik Norvelle

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

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

MainFrame()
Constructor ... just calls component initializtion routine.

Method Summary

CitationDisplayPanel	getCitationDisplay()
FilterToolBar	getFilterToolBar()
MainMenuBar	getMainMenuBar() A getter method for accessing the menu bar from Actions
MainToolBar	getMainToolBar()
StatusBar	getStatusBar()
TablePanel	getTablePanel()
void	guiLoad(java.io.File l) Since file loading can be initiated by several GUI elements, guiLoad() encapsulates common functionality needed by the various loading methods.
void	macOSXRegistration() Generic registration with the Mac OS X application menu.
void	menuFileExit(java.awt.event.ActionEvent actionEvent) File | Exit action performed.
void	menuFileImportBibliography(java.awt.event.ActionEvent actionEvent) File | Import Bibliography action performed.
void	menuFileNewAuthor(java.awt.event.ActionEvent actionEvent) File | New | New Author action performed.
void	menuFileNewBook(java.awt.event.ActionEvent actionEvent) File | New | New Book action performed.
void	menuFileNewCategory(java.awt.event.ActionEvent actionEvent) File | New | New Category action performed.
void	menuFileNewCitation(java.awt.event.ActionEvent actionEvent) File | New | Citation action performed.
void	menuFileNewCitebook(java.awt.event.ActionEvent actionEvent) File | New Citebook action performed.
void	menuHelpAbout(java.awt.event.ActionEvent actionEvent) Help | About action performed.
void	menuHelpShowHelp(java.awt.event.ActionEvent actionEvent) Help | TextCite Help action performed.
void	menuInterfaceEnglish(java.awt.event.ActionEvent actionEvent) View | Interface | English action performed.
void	menuInterfaceSpanish(java.awt.event.ActionEvent actionEvent) View | Interface | Spanish action performed.
void	menuPreferences(java.awt.event.ActionEvent actionEvent) File | Preferences
void	menuViewClipboard(java.awt.event.ActionEvent actionEvent) View | View Clipboard
void	refreshGUI() Reset the various GUI objects that depend on newly-loaded data, or after a new CiteBook has been created.
void	setAppTitle() Discovers the name of the currently loaded CiteBook, and displays an application title that reflects that name
void	showTip() Show the Tip of the Day, if the preference is set to allow it.

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, 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.MenuContainer

getFont, postEvent

Constructor Detail

MainFrame

public MainFrame()

Constructor ... just calls component initializtion routine.

Method Detail

showTip

public void showTip()

Show the Tip of the Day, if the preference is set to allow it.

macOSXRegistration

public void macOSXRegistration()

Generic registration with the Mac OS X application menu. Checks the platform, then attempts to register with the Apple EAWT. (Code taken from Apple Developer Connection, with permission). This method calls OSXAdapter.registerMacOSXApplication() and OSXAdapter.enablePrefs(). See OSXAdapter.java for the signatures of these methods.

guiLoad

public void guiLoad(java.io.File l)

Since file loading can be initiated by several GUI elements, guiLoad() encapsulates common functionality needed by the various loading methods. Calls the load() method of the Application object, but also acts to refresh the various GUI elements, such as the OutlookBar, etc., that have to be repainted on loading new data.

Parameters:

loadFile - The File pointing to the CiteBook to be loaded.

setAppTitle

public void setAppTitle()

Discovers the name of the currently loaded CiteBook, and displays an application title that reflects that name

getMainMenuBar

public MainMenuBar getMainMenuBar()

A getter method for accessing the menu bar from Actions

Returns:

The MainMenuBar instance.

refreshGUI

public void refreshGUI()

Reset the various GUI objects that depend on newly-loaded data, or after a new CiteBook has been created.

menuFileNewCitebook

public void menuFileNewCitebook(java.awt.event.ActionEvent actionEvent)

File | New Citebook action performed.

Parameters:

actionEvent - ActionEvent

menuFileNewCitation

public void menuFileNewCitation(java.awt.event.ActionEvent actionEvent)

File | New | Citation action performed.

Parameters:

actionEvent - ActionEvent

menuFileNewBook

public void menuFileNewBook(java.awt.event.ActionEvent actionEvent)

File | New | New Book action performed.

Parameters:

actionEvent - ActionEvent

menuFileNewAuthor

public void menuFileNewAuthor(java.awt.event.ActionEvent actionEvent)

File | New | New Author action performed.

Parameters:

actionEvent - ActionEvent

menuFileNewCategory

public void menuFileNewCategory(java.awt.event.ActionEvent actionEvent)

File | New | New Category action performed.

Parameters:

actionEvent - ActionEvent

menuFileImportBibliography

public void menuFileImportBibliography(java.awt.event.ActionEvent actionEvent)

File | Import Bibliography action performed.

Parameters:

actionEvent - ActionEvent

menuInterfaceEnglish

public void menuInterfaceEnglish(java.awt.event.ActionEvent actionEvent)

View | Interface | English action performed.

Parameters:

actionEvent - ActionEvent

menuInterfaceSpanish

public void menuInterfaceSpanish(java.awt.event.ActionEvent actionEvent)

View | Interface | Spanish action performed.

Parameters:

actionEvent - ActionEvent

menuViewClipboard

public void menuViewClipboard(java.awt.event.ActionEvent actionEvent)

View | View Clipboard

Parameters:

actionEvent - ActionEvent

menuFileExit

public void menuFileExit(java.awt.event.ActionEvent actionEvent)

File | Exit action performed. Checks to see if the user should be asked to save the CiteBook before exiting.

Parameters:

actionEvent - ActionEvent

menuPreferences

public void menuPreferences(java.awt.event.ActionEvent actionEvent)

File | Preferences

Parameters:

actionEvent - ActionEvent

menuHelpAbout

public void menuHelpAbout(java.awt.event.ActionEvent actionEvent)

Help | About action performed.

Parameters:

actionEvent - ActionEvent

menuHelpShowHelp

public void menuHelpShowHelp(java.awt.event.ActionEvent actionEvent)

Help | TextCite Help action performed. If we get here, it's because no JavaHelp exists for the current interface language.

Parameters:

actionEvent - ActionEvent

getTablePanel

public TablePanel getTablePanel()

getStatusBar

public StatusBar getStatusBar()

getCitationDisplay

public CitationDisplayPanel getCitationDisplay()

Returns:

Returns the citationDisplay.

getFilterToolBar

public FilterToolBar getFilterToolBar()

getMainToolBar

public MainToolBar getMainToolBar()