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:

CreoleListener, ProgressListener, StatusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class MainFrame
extends JFrame
implements ProgressListener, StatusListener, CreoleListener

The main Gate GUI frame.

See Also:

Serialized Form

Nested Class Summary

protected class	MainFrame.ResourcesTreeCellEditor
protected class	MainFrame.ResourcesTreeCellRenderer
protected class	MainFrame.ResourcesTreeModel

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected gate.gui.MainFrame.CartoonMinder	animator
protected DefaultMutableTreeNode	applicationsRoot
protected JPopupMenu	appsPopup Popup used for right click actions on the Applications node.
protected DefaultMutableTreeNode	datastoresRoot
protected JPopupMenu	dssPopup Popup used for right click actions on the Datastores node.
protected static XJFileChooser	fileChooser
protected JProgressBar	globalProgressBar
protected HelpFrame	helpFrame
protected static String[]	ICON_EXTENSIONS Extensions for icon files to be tried in this order.
protected DefaultMutableTreeNode	languageResourcesRoot
protected JSplitPane	leftSplit
protected static org.apache.log4j.Logger	log
protected LogArea	logArea
protected TabHighlighter	logHighlighter
protected JScrollPane	logScroll
protected JScrollPane	lowerScroll
protected JPopupMenu	lrsPopup Popup used for right click actions on the LRs node.
protected JSplitPane	mainSplit
protected XJTabbedPane	mainTabbedPane
protected JMenuBar	menuBar
protected NewResourceDialog	newResourceDialog
protected OptionsDialog	optionsDialog
protected PluginUpdateManager	pluginManager
protected DefaultMutableTreeNode	processingResourcesRoot
protected JProgressBar	progressBar
protected JPopupMenu	prsPopup Popup used for right click actions on the PRs node.
protected JTree	resourcesTree
protected DefaultTreeModel	resourcesTreeModel
protected DefaultMutableTreeNode	resourcesTreeRoot
protected JScrollPane	resourcesTreeScroll
protected Splash	splash
protected JLabel	statusBar
protected JToolBar	toolbar
protected JCheckBoxMenuItem	verboseModeItem

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()
Deprecated. use getInstance() instead

MainFrame(boolean isSlugGUI, GraphicsConfiguration gc)
Deprecated. use getInstance(GraphicsConfiguration) instead

MainFrame(GraphicsConfiguration gc)
Deprecated. use getInstance(GraphicsConfiguration) instead

Method Summary

protected DataStore	createSearchableDataStore() Method is used in NewDSAction
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
protected Handle	findHandleForResource(Resource res) Locates the handle for a given resource.
static XJFileChooser	getFileChooser() Get the file chooser.
static Collection<Component>	getGuiRoots()
static Icon	getIcon(String baseName)
static MainFrame	getInstance()
static MainFrame	getInstance(GraphicsConfiguration gc)
static Map<String,EventListener>	getListeners() Deprecated. Use Gate.getListeners() instead
PrintStream	getOriginalErr() Gets the original system error output stream, which was later redirected to the messages pane.
PrintStream	getOriginalOut() Gets the original system output stream, which was later redirected to the messages pane.
protected void	initGuiComponents()
protected void	initListeners()
protected void	initLocalData()
protected void	initMacListeners() Set up the handlers to support the Macintosh Application menu.
static void	lockGUI(String message) This method will lock all input to the gui by means of a modal dialog.
protected DataStore	openDocServiceDataStore() Method is used in ....OpenDSAction
protected DataStore	openSearchableDataStore() Method is used in OpenDSAction
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)
Handle	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	showHelpFrame(String urlString, String resourceName)
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, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, 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, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

log

protected static final org.apache.log4j.Logger log

menuBar

protected JMenuBar menuBar

mainSplit

protected JSplitPane mainSplit

leftSplit

protected JSplitPane leftSplit

statusBar

protected JLabel statusBar

progressBar

protected JProgressBar progressBar

globalProgressBar

protected JProgressBar globalProgressBar

mainTabbedPane

protected XJTabbedPane mainTabbedPane

lowerScroll

protected JScrollPane lowerScroll

appsPopup

protected JPopupMenu appsPopup

Popup used for right click actions on the Applications node.

dssPopup

protected JPopupMenu dssPopup

Popup used for right click actions on the Datastores node.

lrsPopup

protected JPopupMenu lrsPopup

Popup used for right click actions on the LRs node.

prsPopup

protected JPopupMenu prsPopup

Popup used for right click actions on the PRs node.

verboseModeItem

protected JCheckBoxMenuItem verboseModeItem

resourcesTree

protected JTree resourcesTree

resourcesTreeScroll

protected JScrollPane resourcesTreeScroll

resourcesTreeModel

protected DefaultTreeModel resourcesTreeModel

resourcesTreeRoot

protected DefaultMutableTreeNode resourcesTreeRoot

applicationsRoot

protected DefaultMutableTreeNode applicationsRoot

languageResourcesRoot

protected DefaultMutableTreeNode languageResourcesRoot

processingResourcesRoot

protected DefaultMutableTreeNode processingResourcesRoot

datastoresRoot

protected DefaultMutableTreeNode datastoresRoot

splash

protected Splash splash

pluginManager

protected PluginUpdateManager pluginManager

logArea

protected LogArea logArea

logScroll

protected JScrollPane logScroll

toolbar

protected JToolBar toolbar

fileChooser

protected static XJFileChooser fileChooser

optionsDialog

protected OptionsDialog optionsDialog

animator

protected gate.gui.MainFrame.CartoonMinder animator

logHighlighter

protected TabHighlighter logHighlighter

newResourceDialog

protected NewResourceDialog newResourceDialog

helpFrame

protected HelpFrame helpFrame

ICON_EXTENSIONS

protected static final String[] ICON_EXTENSIONS

Extensions for icon files to be tried in this order.

Constructor Detail

MainFrame

@Deprecated
public MainFrame()

Deprecated. use getInstance() instead

MainFrame

@Deprecated
public MainFrame(boolean isSlugGUI,
                            GraphicsConfiguration gc)

Deprecated. use getInstance(GraphicsConfiguration) instead

MainFrame

@Deprecated
public MainFrame(GraphicsConfiguration gc)

Deprecated. use getInstance(GraphicsConfiguration) instead

Construct the frame.

Parameters:

gc - graphics configuration used, see JFrame.JFrame(java.awt.GraphicsConfiguration)

Method Detail

getIcon

public static Icon getIcon(String baseName)

getInstance

public static MainFrame getInstance()

getInstance

public static MainFrame getInstance(GraphicsConfiguration gc)

getFileChooser

public static XJFileChooser getFileChooser()

Get the file chooser.

Returns:

the current file chooser

getOriginalOut

public PrintStream getOriginalOut()

Gets the original system output stream, which was later redirected to the messages pane.

Returns:

a PrintStream value.

getOriginalErr

public PrintStream getOriginalErr()

Gets the original system error output stream, which was later redirected to the messages pane.

Returns:

a PrintStream value.

findHandleForResource

protected Handle findHandleForResource(Resource res)

Locates the handle for a given resource.

Parameters:

res - the resource for which the handle is sought.

Returns:

the Handle for the resource, if it it was found.

select

public Handle select(Resource res)

Selects a resource if loaded in the system and not invisible.

Parameters:

res - the resource to be selected.

Returns:

the Handle for the resource, null if not found.

select

protected void select(Handle handle)

initLocalData

protected void initLocalData()

initGuiComponents

protected void initGuiComponents()

initListeners

protected void initListeners()

initMacListeners

protected void initMacListeners()

Set up the handlers to support the Macintosh Application menu. This makes the About, Quit and Preferences menu items map to their equivalents in GATE. If an exception occurs during this process we print a warning.

progressChanged

public void progressChanged(int i)

Description copied from interface: ProgressListener

Called when the progress has changed

Specified by:

progressChanged in interface ProgressListener

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

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<String,EventListener> getListeners()

Deprecated. Use Gate.getListeners() instead

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.

Returns:

the listeners map

getGuiRoots

public static Collection<Component> 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

Returns:

the new datastore or null if an error occurs

openSerialDataStore

protected DataStore openSerialDataStore()

Method is used in OpenDSAction

Returns:

the opened datastore or null if an error occurs

openDocServiceDataStore

protected DataStore openDocServiceDataStore()

Method is used in ....OpenDSAction

Returns:

the opened datastore or null if an error occurs

createSearchableDataStore

protected DataStore createSearchableDataStore()

Method is used in NewDSAction

Returns:

the new datastore or null if an error occurs

openSearchableDataStore

protected DataStore openSearchableDataStore()

Method is used in OpenDSAction

Returns:

the opened datastore or null if an error occurs

showHelpFrame

public void showHelpFrame(String urlString,
                          String resourceName)