cusack.hcg.gui.controller

Class GenericPuzzleScreenController<S 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<S>

cusack.hcg.gui.controller.GenericPuzzleScreenController<S>

Type Parameters:

S -

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:

EditConfoundItController, EditFindDesignsController, EditGraphController, EditLightsOutController, EditOptimizeItController, EditPortalForgerController, EditPowerHousesController, EditPowerLinesController, EditPowerZonesController, EditReachItController, EditRockItController, GenericPebbleController, GenericWeightedController, PlayEdgeChooseController, PlayLightsOutController, PlayPortalForgerController, PlayPowerGraphController

public abstract class GenericPuzzleScreenController<S extends PuzzleInstance>
extends PuzzleController<S>

This is a controller for editors and, strangely enough, play screens. The PlayGenericController adds a few things and changes the behavior of saving since it saves solutions, not games. It would be best to have that method abstract to force overriding, but it seems like edit/play are the two possibilities, and both are covered already. Oh, and Graph. Oops. Forgot about that one.

Author:

Chuck Cusack, Feb, 2010.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class cusack.hcg.gui.controller.PuzzleController

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
GenericPuzzleScreenController()

Method Summary

Modifier and Type	Method and Description
void	cleanup() What should I do when I am no longer needed?
java.lang.String	getControllerTitle()
GenericHelpPanel	getHelpPanel()
javax.swing.JPanel	getMiddlePanel() We replace the MiddlePanel with our own so subclasses put stuff on our sub-middle panel and not on the real middle panel, because then they might modify stuff we don't want them to..
void	handleEnd()
void	handleKeyPressed(int theKeyCode)
void	handleKeyPressedWithCTRL(int theKeyCode)
void	handleKeyTyped(char theKey)
void	handleLCC(int extendedModifiers, java.awt.Point clickedPoint)
abstract void	handleLeftCanvasClick(int extendedModifiers)
void	handleLeftCanvasClickGE(int extendedModifiers, java.awt.Point clickedPoint)
void	handleMouseWheel(java.awt.event.MouseWheelEvent e)
void	handleMSLC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleMSRC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleMultipleSelectedLeftClick(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleMultipleSelectedLeftClickGE(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleMultipleSelectedRightClick(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleMultipleSelectedRightClickGE(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleOneSelectedLeftClick(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleOneSelectedLeftClickGE(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleOneSelectedRightClick(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleOneSelectedRightClickGE(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleOSLC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleOSRC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handlePuzzleSpecificKeyPressed(int theKeyCode)
abstract void	handlePuzzleSpecificKeyPressedWithCTRL(int theKeyCode)
abstract void	handlePuzzleSpecificKeyTyped(char theKey)
void	handleRCC(int extendedModifiers, java.awt.Point clickedPoint)
abstract void	handleRightCanvasClick(int extendedModifiers)
void	handleRightCanvasClickGE(int extendedModifiers, java.awt.Point clickedPoint)
abstract void	handleZeroSelectedLeftClick(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleZeroSelectedLeftClickGE(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
abstract void	handleZeroSelectedRightClick(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleZeroSelectedRightClickGE(int extendedModifiers)
void	handleZSLC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
void	handleZSRC(int extendedModifiers, Vertex clickedVertex, java.awt.Point clickedPoint)
boolean	isInEditGraphMode() I just added the check for not null because I got a crash.
boolean	isMovingEnabled()
boolean	isSelectingEnabled()
boolean	saveIt()
void	showPuzzleCompletedDialog()
void	start() What should I do when I am first displayed?
void	stop() What should I do when I am not being displayed?
void	update(java.util.Observable o, java.lang.Object arg) This keeps the undo/redo buttons up to date.
void	updateTutorialComments(Event<?> e)

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

getClickedPoint, getClickedVertex, getComponent, getMode, getName, init, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, popupMenuCanceled, popupMenuWillBecomeInvisible, popupMenuWillBecomeVisible, setPuzzleInstance, showPopup, wasPopupTriggered

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

getNavigationPanel, init, showHelp, showProgessPanel, 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

Constructor Detail

GenericPuzzleScreenController

public GenericPuzzleScreenController()

Method Detail

handleLeftCanvasClick

public abstract void handleLeftCanvasClick(int extendedModifiers)

handleRightCanvasClick

public abstract void handleRightCanvasClick(int extendedModifiers)

handleZeroSelectedLeftClick

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

handleZeroSelectedRightClick

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

handleOneSelectedLeftClick

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

handleOneSelectedRightClick

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

handleMultipleSelectedLeftClick

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

handleMultipleSelectedRightClick

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

handlePuzzleSpecificKeyPressed

public abstract void handlePuzzleSpecificKeyPressed(int theKeyCode)

handlePuzzleSpecificKeyPressedWithCTRL

public abstract void handlePuzzleSpecificKeyPressedWithCTRL(int theKeyCode)

handlePuzzleSpecificKeyTyped

public abstract void handlePuzzleSpecificKeyTyped(char theKey)

getControllerTitle

public java.lang.String getControllerTitle()

Specified by:

getControllerTitle in class Controller

Returns:

the controllerTitle

isInEditGraphMode

public boolean isInEditGraphMode()

I just added the check for not null because I got a crash. But it appears the radioButton is always created, just sometimes not shown. So how did the error happen? CAC, 7/8/11

Returns:

update

public final void update(java.util.Observable o,
                         java.lang.Object arg)

This keeps the undo/redo buttons up to date. CAC, Feb 2010.

Specified by:

update in interface java.util.Observer

Overrides:

update in class Controller

handleEnd

public void handleEnd()

getMiddlePanel

public javax.swing.JPanel getMiddlePanel()

We replace the MiddlePanel with our own so subclasses put stuff on our sub-middle panel and not on the real middle panel, because then they might modify stuff we don't want them to..

updateTutorialComments

public void updateTutorialComments(Event<?> e)

start

public void start()

Description copied from interface: Controllable

What should I do when I am first displayed?

Specified by:

start in interface Controllable

Overrides:

start in class Controller

stop

public void stop()

Description copied from interface: Controllable

What should I do when I am not being displayed?

Specified by:

stop in interface Controllable

Overrides:

stop in class Controller

cleanup

public void cleanup()

Description copied from interface: Controllable

What should I do when I am no longer needed?

Specified by:

cleanup in interface Controllable

Overrides:

cleanup in class Controller

saveIt

public boolean saveIt()

getHelpPanel

public GenericHelpPanel getHelpPanel()

Specified by:

getHelpPanel in class Controller

handleZSRC

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

Specified by:

handleZSRC in class PuzzleController<S extends PuzzleInstance>

handleZSLC

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

Specified by:

handleZSLC in class PuzzleController<S extends PuzzleInstance>

handleOSRC

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

Specified by:

handleOSRC in class PuzzleController<S extends PuzzleInstance>

handleOSLC

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

Specified by:

handleOSLC in class PuzzleController<S extends PuzzleInstance>

handleMSRC

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

Specified by:

handleMSRC in class PuzzleController<S extends PuzzleInstance>

handleMSLC

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

Specified by:

handleMSLC in class PuzzleController<S extends PuzzleInstance>

handleRCC

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

Specified by:

handleRCC in class PuzzleController<S extends PuzzleInstance>

handleLCC

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

Specified by:

handleLCC in class PuzzleController<S extends PuzzleInstance>

handleZeroSelectedRightClickGE

public void handleZeroSelectedRightClickGE(int extendedModifiers)

handleZeroSelectedLeftClickGE

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

handleOneSelectedRightClickGE

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

handleOneSelectedLeftClickGE

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

handleMultipleSelectedLeftClickGE

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

handleMultipleSelectedRightClickGE

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

handleRightCanvasClickGE

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

handleLeftCanvasClickGE

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

handleMouseWheel

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

Specified by:

handleMouseWheel in class PuzzleController<S extends PuzzleInstance>

isMovingEnabled

public boolean isMovingEnabled()

Specified by:

isMovingEnabled in class PuzzleController<S extends PuzzleInstance>

isSelectingEnabled

public boolean isSelectingEnabled()

Specified by:

isSelectingEnabled in class PuzzleController<S extends PuzzleInstance>

handleKeyTyped

public final void handleKeyTyped(char theKey)

Specified by:

handleKeyTyped in class PuzzleController<S extends PuzzleInstance>

handleKeyPressed

public final void handleKeyPressed(int theKeyCode)

Specified by:

handleKeyPressed in class PuzzleController<S extends PuzzleInstance>

handleKeyPressedWithCTRL

public final void handleKeyPressedWithCTRL(int theKeyCode)

Specified by:

handleKeyPressedWithCTRL in class PuzzleController<S extends PuzzleInstance>

showPuzzleCompletedDialog

public void showPuzzleCompletedDialog()