cusack.hcg.gui.controller

Class Controller

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

cusack.hcg.gui.controller.Controller

All Implemented Interfaces:

Controllable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.Observer, javax.accessibility.Accessible

Direct Known Subclasses:

PuzzleController, TableController

public abstract class Controller
extends javax.swing.JPanel
implements java.util.Observer, Controllable

This class will server as a general Controller type for all the different kinds of controllers that can be integrated into the splitpane. Mainly, this class serves to create the three different JPanel that make up a generic Controller. The top panel in this class needs to be edits here as it is not accessble to the sub classes. The same is true with the botton panel. Subclasses are responsible for setting up the middle panel as they see fit. The getMiddlePanel accessor gives them access to the panel.

Author:

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

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.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
Controller()
Controller(GUI g) The default constructor that sets up the three panels that make up a controller and any of the controller subclasses.

Method Summary

Modifier and Type	Method and Description
void	cleanup() What should I do when I am no longer needed?
javax.swing.JComponent	getComponent() Implement as: return this; Stupid, but only way to get the job done.
abstract java.lang.String	getControllerTitle()
abstract GenericHelpPanel	getHelpPanel()
abstract 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.
javax.swing.JPanel	getNavigationPanel() This should generally be called so this panel can be placed on another panel, not to populate it.
void	init(StackedScreen g, boolean useScrollpane)
void	showHelp()
void	showProgessPanel(boolean doit)
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) The method that is called when an instance of this object is observing another object that fires an event notification.
void	updateBorder(java.lang.String newBorderName)

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

Controller

public Controller()

Controller

public Controller(GUI g)

The default constructor that sets up the three panels that make up a controller and any of the controller subclasses.

Method Detail

getControllerTitle

public abstract java.lang.String getControllerTitle()

Returns:

the controllerTitle

getHelpPanel

public abstract GenericHelpPanel getHelpPanel()

getName

public abstract 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. It is important that this name match the name in the problems table in the database exactly or it will not work correctly!

Overrides:

getName in class java.awt.Component

init

public void init(StackedScreen g,
                 boolean useScrollpane)

updateBorder

public void updateBorder(java.lang.String newBorderName)

update

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

The method that is called when an instance of this object is observing another object that fires an event notification.

Specified by:

update in interface java.util.Observer

getNavigationPanel

public javax.swing.JPanel getNavigationPanel()

This should generally be called so this panel can be placed on another panel, not to populate it. Populating it should be done with addToNavigationPanel (or addMoreToNavigationPanel for subclasses of TableController).

Returns:

showProgessPanel

public void showProgessPanel(boolean doit)

showHelp

public void showHelp()

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

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

Returns:

start

public void start()

Description copied from interface: Controllable

What should I do when I am first displayed?

Specified by:

start in interface Controllable

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