gate.gui
Class MainFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--gate.gui.MainFrame
All Implemented Interfaces:
Accessible, CreoleListener, EventListener, ImageObserver, MenuContainer, ProgressListener, RootPaneContainer, Serializable, StatusListener, WindowConstants
Direct Known Subclasses:
ShellSlacFrame

public class MainFrame
extends JFrame
implements ProgressListener, StatusListener, CreoleListener

The main Gate GUI frame.

See Also:
Serialized Form

Nested Class Summary
(package private)  class MainFrame.CartoonMinder
          During longer operations it is nice to keep the user entertained so (s)he doesn't fall asleep looking at a progress bar that seems have stopped.
(package private)  class MainFrame.CleanMarkedCorpusEvalAction
          This class represent an action which brings up the corpus evaluation tool
(package private)  class MainFrame.CloseSelectedResourcesAction
           
(package private)  class MainFrame.CloseViewAction
          Closes the view associated to a resource.
(package private)  class MainFrame.ExitGateAction
          Closes the view associated to a resource.
(package private)  class MainFrame.GenerateStoredCorpusEvalAction
          This class represent an action which brings up the corpus evaluation tool
(package private)  class MainFrame.HelpAboutAction
           
(package private)  class MainFrame.HelpUserGuideAction
           
(package private)  class MainFrame.LoadANNIEWithDefaultsAction
          This class represent an action which loads ANNIE with default params
(package private)  class MainFrame.LoadANNIEWithoutDefaultsAction
          This class represent an action which loads ANNIE with default params
(package private)  class MainFrame.LoadANNIEWithoutDefaultsAction1
          This class represent an action which loads ANNIE without default param
(package private)  class MainFrame.LoadCreoleRepositoryAction
           
(package private)  class MainFrame.LoadResourceFromFileAction
           
(package private)  class MainFrame.LocaleSelectorMenuItem
           
(package private)  class MainFrame.NewAnnotDiffAction
          This class represent an action which brings up the Annot Diff tool
(package private)  class MainFrame.NewBootStrapAction
           
(package private)  class MainFrame.NewCorpusAnnotDiffAction
          This class represent an action which brings up the Corpus Annot Diff tool
(package private)  class MainFrame.NewCorpusEvalAction
          This class represent an action which brings up the corpus evaluation tool
(package private)  class MainFrame.NewDSAction
           
(package private)  class MainFrame.NewGazetteerEditorAction
          This class represent an action which brings up the Gazetteer Editor tool
(package private)  class MainFrame.NewOntologyEditorAction
          ontotext.bp This class represent an action which brings up the Ontology Editor tool
(package private)  class MainFrame.NewResourceAction
           
(package private)  class MainFrame.OpenDSAction
           
(package private)  class MainFrame.ProgressBarUpdater
          Model for the tree representing the resources loaded in the system
(package private)  class MainFrame.RenameResourceAction
           
protected  class MainFrame.ResourcesTreeCellEditor
           
protected  class MainFrame.ResourcesTreeCellRenderer
           
protected  class MainFrame.ResourcesTreeModel
           
(package private)  class MainFrame.StatusBarUpdater
           
(package private) static class MainFrame.StopAction
           
(package private)  class MainFrame.StoredMarkedCorpusEvalAction
          This class represent an action which brings up the corpus evaluation tool
(package private)  class MainFrame.VerboseModeCorpusEvalToolAction
          This class represent an action which brings up the corpus evaluation tool
 
Field Summary
(package private)  MainFrame.CartoonMinder animator
           
(package private)  AppearanceDialog appearanceDialog
           
(package private)  DefaultMutableTreeNode applicationsRoot
           
(package private)  JPopupMenu appsPopup
           
(package private)  MainFrame.CleanMarkedCorpusEvalAction cleanMarkedCorpusEvalAction
           
(package private)  DefaultMutableTreeNode datastoresRoot
           
(package private)  JPopupMenu dssPopup
           
(package private) static JFileChooser fileChooser
           
(package private)  MainFrame.GenerateStoredCorpusEvalAction generateStoredCorpusEvalAction
           
private static JDialog guiLock
           
protected static Collection guiRoots
           
(package private)  MainFrame.HelpAboutAction helpAboutAction
           
(package private) static Map iconByName
          Holds all the icons used in the Gate GUI indexed by filename.
(package private)  DefaultMutableTreeNode languageResourcesRoot
           
(package private)  JSplitPane leftSplit
           
private static Map listeners
          A Map which holds listeners that are singletons (e.g.
(package private)  JMenu loadANNIEMenu
           
(package private)  LogArea logArea
           
(package private)  TabHighlighter logHighlighter
           
(package private)  JScrollPane logScroll
           
(package private)  JScrollPane lowerScroll
           
(package private)  JPopupMenu lrsPopup
           
(package private)  JSplitPane mainSplit
           
(package private)  XJTabbedPane mainTabbedPane
           
(package private)  JMenuBar menuBar
           
(package private)  MainFrame.NewAnnotDiffAction newAnnotDiffAction
           
(package private)  JMenu newAppMenu
           
(package private)  JMenu newAppPopupMenu
           
(package private)  MainFrame.NewBootStrapAction newBootStrapAction
           
(package private)  MainFrame.NewCorpusAnnotDiffAction newCorpusAnnotDiffAction
           
(package private)  MainFrame.NewCorpusEvalAction newCorpusEvalAction
           
(package private)  MainFrame.NewDSAction newDSAction
           
(package private)  MainFrame.NewGazetteerEditorAction newGazetteerEditorAction
           
(package private)  JMenu newLrMenu
          used in menu bar
(package private)  JMenu newLrsPopupMenu
          used in popups
(package private)  MainFrame.NewOntologyEditorAction newOntologyEditorAction
          ontology editor action ontotext.bp
(package private)  JMenu newPrMenu
           
(package private)  JMenu newPrsPopupMenu
           
(package private)  NewResourceDialog newResourceDialog
           
(package private)  MainFrame.OpenDSAction openDSAction
           
(package private)  OptionsDialog optionsDialog
           
(package private)  DefaultMutableTreeNode processingResourcesRoot
           
(package private)  JProgressBar progressBar
           
(package private)  JScrollPane projectTreeScroll
           
(package private)  JPopupMenu prsPopup
           
(package private)  JTree resourcesTree
           
(package private)  DefaultTreeModel resourcesTreeModel
           
(package private)  DefaultMutableTreeNode resourcesTreeRoot
           
(package private)  JScrollPane resourcesTreeScroll
           
(package private)  Box southBox
           
(package private)  Splash splash
           
(package private)  JLabel statusBar
           
(package private)  Action stopActionx
           
(package private)  JButton stopBtnx
           
(package private)  MainFrame.StoredMarkedCorpusEvalAction storedMarkedCorpusEvalAction
           
private  boolean titleChangable
          Flag to protect Frame title to be changed
(package private)  JToolBar toolbar
           
(package private)  MainFrame.VerboseModeCorpusEvalToolAction verboseModeCorpusEvalToolAction
           
(package private)  WaitDialog waitDialog
           
 
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.Window
 
Fields inherited from class java.awt.Container
 
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()
           
MainFrame(boolean isShellSlacGIU)
          Construct the frame
 
Method Summary
protected  DataStore createSerialDataStore()
          Method is used in NewDSAction
 void datastoreClosed(CreoleEvent e)
          Called when a DataStore has been closed
 void datastoreCreated(CreoleEvent e)
          Called when a DataStore has been created
 void datastoreOpened(CreoleEvent e)
          Called when a DataStore has been opened
static JFileChooser getFileChooser()
           
static Collection getGuiRoots()
           
static Icon getIcon(String filename)
           
static Map getListeners()
          Returns the listeners map, a map that holds all the listeners that are singletons (e.g.
protected  void initGuiComponents(boolean isShellSlacGIU)
           
protected  void initListeners(boolean isShellSlacGIU)
           
protected  void initLocalData(boolean isShellSlacGIU)
           
static void lockGUI(String message)
          This method will lock all input to the gui by means of a modal dialog.
protected  DataStore openSerialDataStore()
          Method is used in OpenDSAction
 void processFinished()
          Called when the process is finished.
protected  void processWindowEvent(WindowEvent e)
          Overridden so we can exit when window is closed
 void progressChanged(int i)
          Called when the progress has changed
 void resourceLoaded(CreoleEvent e)
          Called when a new Resource has been loaded into the system
 void resourceRenamed(Resource resource, String oldName, String newName)
          Called when the creole register has renamed a resource.1
 void resourceUnloaded(CreoleEvent e)
          Called when a Resource has been removed from the system
protected  void select(Handle handle)
           
 void select(Resource res)
          Selects a resource if loaded in the system and not invisible.
 void setTitle(String title)
          Override to avoid Protege to change Frame title
 void setTitleChangable(boolean isChangable)
           
 void statusChanged(String text)
          Calleed when there a new status message.
static void unlockGUI()
           
 
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, 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, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, 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
 

Field Detail

menuBar

JMenuBar menuBar

mainSplit

JSplitPane mainSplit

leftSplit

JSplitPane leftSplit

southBox

Box southBox

statusBar

JLabel statusBar

progressBar

JProgressBar progressBar

mainTabbedPane

XJTabbedPane mainTabbedPane

projectTreeScroll

JScrollPane projectTreeScroll

lowerScroll

JScrollPane lowerScroll

appsPopup

JPopupMenu appsPopup

dssPopup

JPopupMenu dssPopup

lrsPopup

JPopupMenu lrsPopup

prsPopup

JPopupMenu prsPopup

newLrsPopupMenu

JMenu newLrsPopupMenu
used in popups


newPrsPopupMenu

JMenu newPrsPopupMenu

newAppPopupMenu

JMenu newAppPopupMenu

newLrMenu

JMenu newLrMenu
used in menu bar


newPrMenu

JMenu newPrMenu

newAppMenu

JMenu newAppMenu

loadANNIEMenu

JMenu loadANNIEMenu

stopBtnx

JButton stopBtnx

stopActionx

Action stopActionx

resourcesTree

JTree resourcesTree

resourcesTreeScroll

JScrollPane resourcesTreeScroll

resourcesTreeModel

DefaultTreeModel resourcesTreeModel

resourcesTreeRoot

DefaultMutableTreeNode resourcesTreeRoot

applicationsRoot

DefaultMutableTreeNode applicationsRoot

languageResourcesRoot

DefaultMutableTreeNode languageResourcesRoot

processingResourcesRoot

DefaultMutableTreeNode processingResourcesRoot

datastoresRoot

DefaultMutableTreeNode datastoresRoot

splash

Splash splash

logArea

LogArea logArea

logScroll

JScrollPane logScroll

toolbar

JToolBar toolbar

fileChooser

static JFileChooser fileChooser

appearanceDialog

AppearanceDialog appearanceDialog

optionsDialog

OptionsDialog optionsDialog

animator

MainFrame.CartoonMinder animator

logHighlighter

TabHighlighter logHighlighter

newResourceDialog

NewResourceDialog newResourceDialog

waitDialog

WaitDialog waitDialog

newDSAction

MainFrame.NewDSAction newDSAction

openDSAction

MainFrame.OpenDSAction openDSAction

helpAboutAction

MainFrame.HelpAboutAction helpAboutAction

newAnnotDiffAction

MainFrame.NewAnnotDiffAction newAnnotDiffAction

newCorpusAnnotDiffAction

MainFrame.NewCorpusAnnotDiffAction newCorpusAnnotDiffAction

newBootStrapAction

MainFrame.NewBootStrapAction newBootStrapAction

newCorpusEvalAction

MainFrame.NewCorpusEvalAction newCorpusEvalAction

generateStoredCorpusEvalAction

MainFrame.GenerateStoredCorpusEvalAction generateStoredCorpusEvalAction

storedMarkedCorpusEvalAction

MainFrame.StoredMarkedCorpusEvalAction storedMarkedCorpusEvalAction

cleanMarkedCorpusEvalAction

MainFrame.CleanMarkedCorpusEvalAction cleanMarkedCorpusEvalAction

verboseModeCorpusEvalToolAction

MainFrame.VerboseModeCorpusEvalToolAction verboseModeCorpusEvalToolAction

newOntologyEditorAction

MainFrame.NewOntologyEditorAction newOntologyEditorAction
ontology editor action ontotext.bp


newGazetteerEditorAction

MainFrame.NewGazetteerEditorAction newGazetteerEditorAction

iconByName

static Map iconByName
Holds all the icons used in the Gate GUI indexed by filename. This is needed so we do not need to decode the icon everytime we need it as that would use unecessary CPU time and memory. Access to this data is avaialable through the getIcon(String) method.


listeners

private static Map listeners
A Map which holds listeners that are singletons (e.g. the status listener that updates the status bar on the main frame or the progress listener that updates the progress bar on the main frame). The keys used are the class names of the listener interface and the values are the actual listeners (e.g "gate.event.StatusListener" -> this).


guiRoots

protected static Collection guiRoots

guiLock

private static JDialog guiLock

titleChangable

private boolean titleChangable
Flag to protect Frame title to be changed

Constructor Detail

MainFrame

public MainFrame()

MainFrame

public MainFrame(boolean isShellSlacGIU)
Construct the frame

Method Detail

getIcon

public static Icon getIcon(String filename)

getFileChooser

public static JFileChooser getFileChooser()

select

public void select(Resource res)
Selects a resource if loaded in the system and not invisible.

Parameters:
res - the resource to be selected.

select

protected void select(Handle handle)

initLocalData

protected void initLocalData(boolean isShellSlacGIU)

initGuiComponents

protected void initGuiComponents(boolean isShellSlacGIU)

initListeners

protected void initListeners(boolean isShellSlacGIU)

progressChanged

public void progressChanged(int i)
Description copied from interface: ProgressListener
Called when the progress has changed

Specified by:
progressChanged in interface ProgressListener
Parameters:
i -

processFinished

public void processFinished()
Called when the process is finished.

Specified by:
processFinished in interface ProgressListener

statusChanged

public void statusChanged(String text)
Description copied from interface: StatusListener
Calleed when there a new status message.

Specified by:
statusChanged in interface StatusListener
Parameters:
text -

resourceLoaded

public void resourceLoaded(CreoleEvent e)
Description copied from interface: CreoleListener
Called when a new Resource has been loaded into the system

Specified by:
resourceLoaded in interface CreoleListener

resourceUnloaded

public void resourceUnloaded(CreoleEvent e)
Description copied from interface: CreoleListener
Called when a Resource has been removed from the system

Specified by:
resourceUnloaded in interface CreoleListener

datastoreOpened

public void datastoreOpened(CreoleEvent e)
Called when a DataStore has been opened

Specified by:
datastoreOpened in interface CreoleListener

datastoreCreated

public void datastoreCreated(CreoleEvent e)
Called when a DataStore has been created

Specified by:
datastoreCreated in interface CreoleListener

datastoreClosed

public void datastoreClosed(CreoleEvent e)
Called when a DataStore has been closed

Specified by:
datastoreClosed in interface CreoleListener

resourceRenamed

public void resourceRenamed(Resource resource,
                            String oldName,
                            String newName)
Description copied from interface: CreoleListener
Called when the creole register has renamed a resource.1

Specified by:
resourceRenamed in interface CreoleListener

processWindowEvent

protected void processWindowEvent(WindowEvent e)
Overridden so we can exit when window is closed

Overrides:
processWindowEvent in class JFrame

getListeners

public static Map getListeners()
Returns the listeners map, a map that holds all the listeners that are singletons (e.g. the status listener that updates the status bar on the main frame or the progress listener that updates the progress bar on the main frame). The keys used are the class names of the listener interface and the values are the actual listeners (e.g "gate.event.StatusListener" -> this). The returned map is the actual data member used to store the listeners so any changes in this map will be visible to everyone.


getGuiRoots

public static Collection getGuiRoots()

lockGUI

public static void lockGUI(String message)
This method will lock all input to the gui by means of a modal dialog. If Gate is not currently running in GUI mode this call will be ignored. A call to this method while the GUI is locked will cause the GUI to be unlocked and then locked again with the new message. If a message is provided it will show in the dialog.

Parameters:
message - the message to be displayed while the GUI is locked

unlockGUI

public static void unlockGUI()

setTitleChangable

public void setTitleChangable(boolean isChangable)

setTitle

public void setTitle(String title)
Override to avoid Protege to change Frame title

Overrides:
setTitle in class Frame

createSerialDataStore

protected DataStore createSerialDataStore()
Method is used in NewDSAction


openSerialDataStore

protected DataStore openSerialDataStore()
Method is used in OpenDSAction