cusack.hcg.gui.controller

Class PuzzleController<T extends PuzzleInstance>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

cusack.hcg.gui.controller.Controller

cusack.hcg.gui.controller.PuzzleController<T>

All Implemented Interfaces:

Controllable, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, java.util.Observer, javax.accessibility.Accessible, javax.swing.event.MouseInputListener, javax.swing.event.PopupMenuListener

Direct Known Subclasses:

GenericPuzzleScreenController, ReplayController

public abstract class PuzzleController<T extends PuzzleInstance>
extends Controller
implements java.awt.event.KeyListener, javax.swing.event.MouseInputListener, java.util.Observer, javax.swing.event.PopupMenuListener, java.awt.event.MouseWheelListener

This class has a superclass of controller and because it is abstract, it will never be instantiated. This class's purpose is to allow the user to interact with a graph through the mouse and keyboard. It is also important to make sure that all methods in this class can apply to all types of graphs; not just any one specific instance since it is meant to be a generic class.

Author:

Ryan Alfuth, modified by Chuck Cusack, January, 2010.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PuzzleController.ScreenMode

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.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
PuzzleController()

Method Summary

Modifier and Type	Method and Description
java.awt.Point	getClickedPoint()
Vertex	getClickedVertex()
javax.swing.JComponent	getComponent() Implement as: return this; Stupid, but only way to get the job done.
PuzzleController.ScreenMode	getMode()
java.lang.String	getName() This should return the name of the game (from the problems table in the database) or the name of the table if it is not a game table.
abstract void	handleKeyPressed(int theKeyCode)
abstract void	handleKeyPressedWithCTRL(int theKeyCode)
abstract void	handleKeyTyped(char theKey)
abstract void	handleLCC(int extendedModifiers, java.awt.Point clickedPoint)
abstract void	handleMouseWheel(java.awt.event.MouseWheelEvent e)
abstract void	handleMSLC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleMSRC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleOSLC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleOSRC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleRCC(int extendedModifiers, java.awt.Point clickedPoint)
abstract void	handleZSLC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleZSRC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	init(StackedScreen g2, T g, GraphView v, PuzzleController.ScreenMode mode)
abstract boolean	isMovingEnabled()
abstract boolean	isSelectingEnabled()
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
void	popupMenuCanceled(javax.swing.event.PopupMenuEvent e)
void	popupMenuWillBecomeInvisible(javax.swing.event.PopupMenuEvent e)
void	popupMenuWillBecomeVisible(javax.swing.event.PopupMenuEvent e)
void	setPuzzleInstance(T game) This method allows a new instance of a gameInstance class to be assigned to this controller
void	showPopup(javax.swing.JPopupMenu popup)
boolean	wasPopupTriggered()

Methods inherited from class cusack.hcg.gui.controller.Controller

cleanup, getControllerTitle, getHelpPanel, getNavigationPanel, init, showHelp, showProgessPanel, start, stop, update, updateBorder

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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

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, remove, removeAll, 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, 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 java.util.Observer

update

Constructor Detail

PuzzleController

public PuzzleController()

Method Detail

init

public void init(StackedScreen g2,
                 T g,
                 GraphView v,
                 PuzzleController.ScreenMode mode)

handleLCC

public abstract void handleLCC(int extendedModifiers,
                               java.awt.Point clickedPoint)

handleRCC

public abstract void handleRCC(int extendedModifiers,
                               java.awt.Point clickedPoint)

handleZSLC

public abstract void handleZSLC(int extendedModifiers,
                                Vertex clickedVertex,
                                java.awt.Point clickedPoint)

handleZSRC

public abstract void handleZSRC(int extendedModifiers,
                                Vertex clickedVertex,
                                java.awt.Point clickedPoint)

handleOSLC

public abstract void handleOSLC(int extendedModifiers,
                                Vertex clickedVertex,
                                java.awt.Point clickedPoint)

handleOSRC

public abstract void handleOSRC(int extendedModifiers,
                                Vertex clickedVertex,
                                java.awt.Point clickedPoint)

handleMSLC

public abstract void handleMSLC(int extendedModifiers,
                                Vertex clickedVertex,
                                java.awt.Point clickedPoint)

handleMSRC

public abstract void handleMSRC(int extendedModifiers,
                                Vertex clickedVertex,
                                java.awt.Point clickedPoint)

handleMouseWheel

public abstract void handleMouseWheel(java.awt.event.MouseWheelEvent e)

handleKeyPressed

public abstract void handleKeyPressed(int theKeyCode)

handleKeyPressedWithCTRL

public abstract void handleKeyPressedWithCTRL(int theKeyCode)

handleKeyTyped

public abstract void handleKeyTyped(char theKey)

isSelectingEnabled

public abstract boolean isSelectingEnabled()

isMovingEnabled

public abstract boolean isMovingEnabled()

getName

public java.lang.String getName()

Description copied from class: Controller

This should return the name of the game (from the problems table in the database) or the name of the table if it is not a game table. It is important that this name match the name in the problems table in the database exactly or it will not work correctly!

Specified by:

getName in class Controller

getComponent

public javax.swing.JComponent getComponent()

Description copied from interface: Controllable

Implement as: return this; Stupid, but only way to get the job done.

Specified by:

getComponent in interface Controllable

Overrides:

getComponent in class Controller

Returns:

setPuzzleInstance

public void setPuzzleInstance(T game)

This method allows a new instance of a gameInstance class to be assigned to this controller

Parameters:

game - The instance of the game to be assigned

getClickedVertex

public Vertex getClickedVertex()

getClickedPoint

public java.awt.Point getClickedPoint()

getMode

public PuzzleController.ScreenMode getMode()

keyPressed

public final void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public final void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public final void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

mousePressed

public final void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseDragged

public final void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseReleased

public final void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseMoved

public final void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseClicked

public final void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public final void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public final void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseWheelMoved

public final void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

wasPopupTriggered

public boolean wasPopupTriggered()

showPopup

public void showPopup(javax.swing.JPopupMenu popup)

popupMenuWillBecomeVisible

public void popupMenuWillBecomeVisible(javax.swing.event.PopupMenuEvent e)

Specified by:

popupMenuWillBecomeVisible in interface javax.swing.event.PopupMenuListener

popupMenuWillBecomeInvisible

public void popupMenuWillBecomeInvisible(javax.swing.event.PopupMenuEvent e)

Specified by:

popupMenuWillBecomeInvisible in interface javax.swing.event.PopupMenuListener

popupMenuCanceled

public void popupMenuCanceled(javax.swing.event.PopupMenuEvent e)

Specified by:

popupMenuCanceled in interface javax.swing.event.PopupMenuListener