The Meta-Environment API

nl.cwi.sen1.tide.tool
Class TideTool

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by nl.cwi.sen1.tide.tool.TideTool
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, nl.cwi.sen1.gui.component.StudioComponent
Direct Known Subclasses:
AdapterTool, PreferencesEditor, ProcessTool

public abstract class TideTool
extends javax.swing.JPanel
implements nl.cwi.sen1.gui.component.StudioComponent

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  int id
           
private  javax.swing.event.EventListenerList listenerList
           
private  ToolManager manager
           
private  java.lang.String name
           
private static int next_id
           
private  java.lang.String statusMessage
           
private  java.lang.Object target
           
private  java.lang.String tooltip
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TideTool(ToolManager manager)
           
 
Method Summary
 void addNameChangedListener(nl.cwi.sen1.gui.component.NameChangedListener l)
           
 void addStudioComponentListener(nl.cwi.sen1.gui.component.StudioComponentListener l)
           
 void addTooltipChangedListener(nl.cwi.sen1.gui.component.TooltipChangedListener l)
           
 void close()
           
 void destroy()
           
 void displayError(Expr error)
           
 void displayError(java.lang.String msg, Expr data)
           
protected  void fireComponentFocusReceived()
           
protected  void fireStatusMessageChanged(java.lang.String oldMessage, java.lang.String newMessage)
           
 javax.swing.Icon getIcon()
           
 int getId()
           
 ToolManager getManager()
           
 java.lang.String getName()
           
 javax.swing.JComponent[] getStatusBarComponents()
           
 java.lang.String getStatusMessage()
           
 java.lang.Object getTarget()
           
 java.lang.String getTooltip()
           
 javax.swing.JComponent getViewComponent()
           
protected  javax.swing.Icon loadIcon(java.lang.String name)
           
 void receiveFocus()
           
 void removeNameChangedListener(nl.cwi.sen1.gui.component.NameChangedListener l)
           
 void removeStudioComponentListener(nl.cwi.sen1.gui.component.StudioComponentListener l)
           
 void removeTooltipChangedListener(nl.cwi.sen1.gui.component.TooltipChangedListener l)
           
 void requestClose()
           
 void setName(java.lang.String name)
           
 void setStatusMessage(java.lang.String newMessage)
           
 void setTarget(java.lang.Object target)
           
 void setTooltip(java.lang.String tooltip)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

next_id

private static int next_id

id

private int id

manager

private ToolManager manager

name

private java.lang.String name

tooltip

private java.lang.String tooltip

target

private java.lang.Object target

statusMessage

private java.lang.String statusMessage

listenerList

private javax.swing.event.EventListenerList listenerList
Constructor Detail

TideTool

public TideTool(ToolManager manager)
Method Detail

getManager

public ToolManager getManager()

getId

public int getId()

getName

public java.lang.String getName()
Specified by:
getName in interface nl.cwi.sen1.gui.component.StudioComponent
Overrides:
getName in class java.awt.Component

getTooltip

public java.lang.String getTooltip()
Specified by:
getTooltip in interface nl.cwi.sen1.gui.component.StudioComponent

getTarget

public java.lang.Object getTarget()

setName

public void setName(java.lang.String name)
Specified by:
setName in interface nl.cwi.sen1.gui.component.StudioComponent
Overrides:
setName in class java.awt.Component

setTooltip

public void setTooltip(java.lang.String tooltip)
Specified by:
setTooltip in interface nl.cwi.sen1.gui.component.StudioComponent

setTarget

public void setTarget(java.lang.Object target)

loadIcon

protected javax.swing.Icon loadIcon(java.lang.String name)

displayError

public void displayError(Expr error)

displayError

public void displayError(java.lang.String msg,
                         Expr data)

destroy

public void destroy()

getIcon

public javax.swing.Icon getIcon()
Specified by:
getIcon in interface nl.cwi.sen1.gui.component.StudioComponent

getViewComponent

public javax.swing.JComponent getViewComponent()
Specified by:
getViewComponent in interface nl.cwi.sen1.gui.component.StudioComponent

addStudioComponentListener

public void addStudioComponentListener(nl.cwi.sen1.gui.component.StudioComponentListener l)
Specified by:
addStudioComponentListener in interface nl.cwi.sen1.gui.component.StudioComponent

removeStudioComponentListener

public void removeStudioComponentListener(nl.cwi.sen1.gui.component.StudioComponentListener l)
Specified by:
removeStudioComponentListener in interface nl.cwi.sen1.gui.component.StudioComponent

addNameChangedListener

public void addNameChangedListener(nl.cwi.sen1.gui.component.NameChangedListener l)
Specified by:
addNameChangedListener in interface nl.cwi.sen1.gui.component.StudioComponent

removeNameChangedListener

public void removeNameChangedListener(nl.cwi.sen1.gui.component.NameChangedListener l)
Specified by:
removeNameChangedListener in interface nl.cwi.sen1.gui.component.StudioComponent

addTooltipChangedListener

public void addTooltipChangedListener(nl.cwi.sen1.gui.component.TooltipChangedListener l)
Specified by:
addTooltipChangedListener in interface nl.cwi.sen1.gui.component.StudioComponent

removeTooltipChangedListener

public void removeTooltipChangedListener(nl.cwi.sen1.gui.component.TooltipChangedListener l)
Specified by:
removeTooltipChangedListener in interface nl.cwi.sen1.gui.component.StudioComponent

fireStatusMessageChanged

protected void fireStatusMessageChanged(java.lang.String oldMessage,
                                        java.lang.String newMessage)

fireComponentFocusReceived

protected void fireComponentFocusReceived()

receiveFocus

public void receiveFocus()
Specified by:
receiveFocus in interface nl.cwi.sen1.gui.component.StudioComponent

getStatusMessage

public java.lang.String getStatusMessage()

getStatusBarComponents

public javax.swing.JComponent[] getStatusBarComponents()
Specified by:
getStatusBarComponents in interface nl.cwi.sen1.gui.component.StudioComponent

setStatusMessage

public void setStatusMessage(java.lang.String newMessage)

requestClose

public void requestClose()
Specified by:
requestClose in interface nl.cwi.sen1.gui.component.StudioComponent

close

public void close()
Specified by:
close in interface nl.cwi.sen1.gui.component.StudioComponent

The Meta-Environment API