gate.gui

Interface Handle

All Superinterfaces:

EventListener, ProgressListener, StatusListener

All Known Implementing Classes:

NameBearerHandle

public interface Handle
extends ProgressListener, StatusListener

Interface for classes used to store the information about an open resource. Such information will include icon to be used for tree components, popup menu for right click events, etc.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Called when this handle is not required any more.
Icon	getIcon()
JComponent	getLargeView() Returns the large view for this resource.
JPopupMenu	getPopup()
JComponent	getSmallView() Returns a GUI component to be used as a small viewer/editor, e.g.
Object	getTarget()
String	getTitle()
String	getTooltipText()
Window	getWindow() Returns the top level GUI component that is a parent to all other GUI components
void	removeViews() A call to this method will cause the handle to destroy all the views built for the target resource.
boolean	viewsBuilt() Returns true if the views have already been built for this handle.

Methods inherited from interface gate.event.ProgressListener

processFinished, progressChanged

Methods inherited from interface gate.event.StatusListener

statusChanged

Method Detail

getIcon

Icon getIcon()

getTitle

String getTitle()

getSmallView

JComponent getSmallView()

Returns a GUI component to be used as a small viewer/editor, e.g. below the main tree in the Gate GUI for the selected resource

getLargeView

JComponent getLargeView()

Returns the large view for this resource. This view will go into the main display area.

viewsBuilt

boolean viewsBuilt()

Returns true if the views have already been built for this handle.

Returns:

a boolean value.

cleanup

void cleanup()

Called when this handle is not required any more.

removeViews

void removeViews()

A call to this method will cause the handle to destroy all the views built for the target resource.

getPopup

JPopupMenu getPopup()

getTooltipText

String getTooltipText()

getTarget

Object getTarget()

getWindow

Window getWindow()

Returns the top level GUI component that is a parent to all other GUI components