org.annotation.wordfreak
Class Gui

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.annotation.wordfreak.Gui

All Implemented Interfaces:

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

public class Gui

extends javax.swing.JFrame

implements GuiListener, EventListener, java.awt.event.WindowListener

This object represents the main WordFreak GUI. Only one such object exists when runnig WordFreak.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

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

Method Summary

static void	addFloatingWindow(java.awt.Window w)
void	addViewer(java.lang.String name, java.awt.Component viewer) Adds the specified viewer to the GUI with the specified name.
javax.swing.JButton	createButton(java.lang.String path, java.lang.String event, java.lang.String tip)
javax.swing.JToggleButton	createToggleButton(java.lang.String path, java.lang.String event, java.lang.String tip)
static void	errorMessage(java.lang.Exception e, java.lang.String message)
boolean	eventTranspired(java.lang.String com, java.lang.Object source)
static Gui	getGui() Return an instance of Gui if one exists or null if a gui has not been created.
static Gui	getInstance() Return an instance of Gui.
void	hide()
protected void	processWindowEvent(java.awt.event.WindowEvent e)
static void	removeFloatingWindow(java.lang.String t)
void	removeViewer(java.lang.String name, java.awt.Component viewer) Removes the specified viewer with the specified name from the GUI.
void	renameProject(java.lang.String name) Renames the current project to the specified name.
void	setAnnotatedFileManager(AnnotatedFileManager m)
void	setChangeListener(javax.swing.event.ChangeListener cl)
void	show()
void	showViewer(java.lang.String name)
void	windowActivated(java.awt.event.WindowEvent e)
void	windowClosed(java.awt.event.WindowEvent e)
void	windowClosing(java.awt.event.WindowEvent e)
void	windowDeactivated(java.awt.event.WindowEvent e)
void	windowDeiconified(java.awt.event.WindowEvent e)
void	windowIconified(java.awt.event.WindowEvent e)
void	windowOpened(java.awt.event.WindowEvent e)

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Method Detail

getGui

public static Gui getGui()

Return an instance of Gui if one exists or null if a gui has not been created. This method is used to allow low-level components within WordFreak to know how to display error messages.

Returns:

An instance of Gui if one exist or null if no instance has been created.

getInstance

public static Gui getInstance()

Return an instance of Gui.

Returns:

The single instance of Gui.

errorMessage

public static void errorMessage(java.lang.Exception e,
                                java.lang.String message)

createButton

public javax.swing.JButton createButton(java.lang.String path,
                                        java.lang.String event,
                                        java.lang.String tip)

createToggleButton

public javax.swing.JToggleButton createToggleButton(java.lang.String path,
                                                    java.lang.String event,
                                                    java.lang.String tip)

addFloatingWindow

public static void addFloatingWindow(java.awt.Window w)

removeFloatingWindow

public static void removeFloatingWindow(java.lang.String t)

setAnnotatedFileManager

public void setAnnotatedFileManager(AnnotatedFileManager m)

processWindowEvent

protected void processWindowEvent(java.awt.event.WindowEvent e)

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)

Specified by:

windowOpened in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)

Specified by:

windowClosed in interface java.awt.event.WindowListener

hide

public void hide()

show

public void show()

eventTranspired

public boolean eventTranspired(java.lang.String com,
                               java.lang.Object source)

Specified by:

eventTranspired in interface EventListener

setChangeListener

public void setChangeListener(javax.swing.event.ChangeListener cl)

addViewer

public void addViewer(java.lang.String name,
                      java.awt.Component viewer)

Description copied from interface: GuiListener

Adds the specified viewer to the GUI with the specified name.

Specified by:

addViewer in interface GuiListener

Parameters:

name - The name of the viewer to be added.

viewer - The viewer or multi-viewer to be added to the GUI.

showViewer

public void showViewer(java.lang.String name)

removeViewer

public void removeViewer(java.lang.String name,
                         java.awt.Component viewer)

Description copied from interface: GuiListener

Removes the specified viewer with the specified name from the GUI.

Specified by:

removeViewer in interface GuiListener

Parameters:

name - The name of the viewer being removed.

viewer - The viewer being removed.

renameProject

public void renameProject(java.lang.String name)

Description copied from interface: GuiListener

Renames the current project to the specified name. This is used when saving the current project to a different name.

Specified by:

renameProject in interface GuiListener

Parameters:

name - The new name of the project.