edu.mit.blocks.codeblockutil

Class MagicExplorer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

edu.mit.blocks.codeblockutil.MagicExplorer

All Implemented Interfaces:

Explorer, java.awt.event.ComponentListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class MagicExplorer
extends javax.swing.JLayeredPane
implements Explorer, java.awt.event.ComponentListener, java.awt.event.FocusListener

See documentation for Explorer. A MagicExplorer explores the canvas by normally displaying only the buttons. When the user selects a particular button, the corresponding canvas is rolled out from underneath in a glass like scroll pane. We say glass because there exists a special transparency to the background color.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

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

Constructors

Constructor and Description
MagicExplorer() Constructor

Method Summary

Modifier and Type	Method and Description
void	addListener(ExplorerListener gel) Adds listener to the explorer
boolean	anyCanvasSelected() Returns whether any Canvas is currently selected
void	componentHidden(java.awt.event.ComponentEvent e)
void	componentMoved(java.awt.event.ComponentEvent e)
void	componentResized(java.awt.event.ComponentEvent e)
void	componentShown(java.awt.event.ComponentEvent e)
void	focusGained(java.awt.event.FocusEvent e)
void	focusLost(java.awt.event.FocusEvent e) Rolls the canvasPane back underneath when focus is lost
javax.swing.JComponent	getJComponent()
int	getSelectedCanvasWidth() Returns the width of the Canvas when selected
void	reformView() Reforms this explorer based on the new size or location of this explorer.
void	removeListener(ExplorerListener gel) Removes listener from the explorer
void	selectCanvas(int index) Selects the particular canvas at the specified index.
void	setDrawersCard(java.util.List<? extends Canvas> items) Reassigns the set of canvases that this explorer controls.

Methods inherited from class javax.swing.JLayeredPane

getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getPosition, highestLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, remove, removeAll, setLayer, setLayer, setPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, 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, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, 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, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.mit.blocks.codeblockutil.Explorer

getName, setName

Constructor Detail

MagicExplorer

public MagicExplorer()

Constructor

Method Detail

anyCanvasSelected

public boolean anyCanvasSelected()

Description copied from interface: Explorer

Returns whether any Canvas is currently selected

Specified by:

anyCanvasSelected in interface Explorer

getSelectedCanvasWidth

public int getSelectedCanvasWidth()

Description copied from interface: Explorer

Returns the width of the Canvas when selected

Specified by:

getSelectedCanvasWidth in interface Explorer

Returns:

the width of the Canvas when selected

addListener

public void addListener(ExplorerListener gel)

Description copied from interface: Explorer

Adds listener to the explorer

Specified by:

addListener in interface Explorer

removeListener

public void removeListener(ExplorerListener gel)

Description copied from interface: Explorer

Removes listener from the explorer

Specified by:

removeListener in interface Explorer

setDrawersCard

public void setDrawersCard(java.util.List<? extends Canvas> items)

Reassigns the set of canvases that this explorer controls. Though the collection of canvas mnay be empty, it may not be null.

Specified by:

setDrawersCard in interface Explorer

Parameters:

items -

selectCanvas

public void selectCanvas(int index)

Selects the particular canvas at the specified index. THe canvas is placed onto the it's glass pane and the placed onto the canvasPane. A timer is used to roll out the canvasPane.

Specified by:

selectCanvas in interface Explorer

Parameters:

index -

reformView

public void reformView()

Reforms this explorer based on the new size or location of this explorer. For some explorers whose implementation does not depend on the size of itself, this method may trigger no action.

Specified by:

reformView in interface Explorer

getJComponent

public javax.swing.JComponent getJComponent()

Specified by:

getJComponent in interface Explorer

Returns:

a JComponent representation of this explorer

focusLost

public void focusLost(java.awt.event.FocusEvent e)

Rolls the canvasPane back underneath when focus is lost

Specified by:

focusLost in interface java.awt.event.FocusListener

focusGained

public void focusGained(java.awt.event.FocusEvent e)

Specified by:

focusGained in interface java.awt.event.FocusListener

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

Specified by:

componentResized in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

Specified by:

componentMoved in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

Specified by:

componentShown in interface java.awt.event.ComponentListener

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

Specified by:

componentHidden in interface java.awt.event.ComponentListener