CIDER Toolkit
Version 0.1.0-beta

au.edu.monash.csse.tonyj.cider.canvas
Class InterpretedTokenCanvas

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--TokenCanvas
                                |
                                +--InterpretedTokenCanvas
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class InterpretedTokenCanvas
extends TokenCanvas

This class extends the TokenCanvas class to be used with an Interpreter for processing diagrammatic languages.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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
InterpretedTokenCanvas(java.awt.Dimension d, Interpreter inter)
          Creates a new InterpretedTokenCanvas object.
InterpretedTokenCanvas(int width, int height, Interpreter inter)
          Creates a new InterpretedTokenCanvas object.
 
Method Summary
 boolean add(int index, DrawableToken t)
          Overrides the add methods in the TokenCanvas class (which are all implemented via this method).
 Interpreter getInterpreter()
          Returns the Interpreter used by the canvas.
 boolean load(java.lang.String filename)
          Restores a previously saved state, and updates the canvas accordingly.
 boolean remove(DrawableToken t)
          Overrides this method in the TokenCanvas class.
 boolean save(java.lang.String filename)
          Saves the current state.
 void updateFromInterpreter()
          Updates the canvas so that it contains all the terminal symbols that are controlled by the Interpreter, but no other tokens.
 
Methods inherited from class TokenCanvas
add, addToBottom, addToTop, clear, getBackground, getBottomToken, getNumTokens, getToken, getTokensContaining, getTopToken, indexOf, move, moveToBottom, moveToTop, paintComponent, setBackground
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InterpretedTokenCanvas

public InterpretedTokenCanvas(java.awt.Dimension d,
                              Interpreter inter)
Creates a new InterpretedTokenCanvas object.

Parameters:
d - The dimensions of the new canvas.
inter - The Interpreter object the canvas is to use.

InterpretedTokenCanvas

public InterpretedTokenCanvas(int width,
                              int height,
                              Interpreter inter)
Creates a new InterpretedTokenCanvas object.

Parameters:
width - The width of the new canvas.
height - The height of the new canvas.
inter - The Interpreter object the canvas is to use.
Method Detail

updateFromInterpreter

public void updateFromInterpreter()
Updates the canvas so that it contains all the terminal symbols that are controlled by the Interpreter, but no other tokens.


save

public boolean save(java.lang.String filename)
Saves the current state.

Parameters:
filename - The name of the file where the state will be saved to.
Returns:
true if successful, false otherwise.

load

public boolean load(java.lang.String filename)
Restores a previously saved state, and updates the canvas accordingly. Note that this method clears the current state.

Parameters:
filename - The name of the file that contains the saved state.
Returns:
true if successful, false otherwise.

add

public boolean add(int index,
                   DrawableToken t)
Overrides the add methods in the TokenCanvas class (which are all implemented via this method). If an invalid index is specified the token will be placed at the bottom of the stack.

Overrides:
add in class TokenCanvas
Parameters:
index - Location in the stack in the range 0 (top) to TokenCanvas.getNumTokens() - 1 (bottom).
t - The token to be added.
Returns:
true if successful, or false if the Interpreter would not accept the token as a valid terminal symbol.

remove

public boolean remove(DrawableToken t)
Overrides this method in the TokenCanvas class.

Overrides:
remove in class TokenCanvas
Parameters:
t - The token to be removed.
Returns:
true if successful, or false if the token could not be removed from the Interpreter.

getInterpreter

public Interpreter getInterpreter()
Returns the Interpreter used by the canvas.


CIDER Toolkit
Version 0.1.0-beta