cusack.hcg.gui.view

Class GraphView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

javax.swing.JDesktopPane

cusack.hcg.gui.view.GraphView

All Implemented Interfaces:

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

Direct Known Subclasses:

ContinualReplayView

public class GraphView
extends javax.swing.JDesktopPane
implements Controllable, java.util.Observer

This class occupies the left side of the split screen object and it will generally display any objects that need to appear graphically on the graph that is associated with this game. This is a JDesktopPane because we want to put internal dialogs on it for tutorial mode.

Author:

Jeff Largent, Ryan Alfuth, Eric DePree, Updated 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

Modifier and Type	Field and Description
static int	FRAME_RATE
static int	TUTORIAL_FRAME_WIDTH

Fields inherited from class javax.swing.JDesktopPane

LIVE_DRAG_MODE, OUTLINE_DRAG_MODE

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
GraphView()
GraphView(PuzzleInstance thePuzzle, java.lang.String theTitle) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	checkWithinBox(java.awt.Point p) Checks to see if a point is within the area defined by the selection box
void	cleanup() What should I do when I am no longer needed?
void	closeBox() Used when a selection box should not be drawn any more.
void	displayInternalFrame(java.lang.String title, java.lang.String contents, java.util.ArrayList<java.awt.Point> pointsOfInterest, boolean showNextButton)
javax.swing.JComponent	getComponent() Implement as: return this; Stupid, but only way to get the job done.
int	getMinHeight()
int	getMinWidth()
java.awt.Point	getVertexCenter()
int	getVertexHeight() Return the scale of this jTableView: the complete height of the drawn vertex image
int	getVertexWidth() Return the scale of this jTableView: the complete width of the drawn vertex image
double	getZoom()
void	init(PuzzleInstance thePuzzle, java.lang.String theTitle)
boolean	isStillAnimating()
void	resizeCanvas(boolean adjustTutorialDialog) Resize the area of the canvas to fit the layout of the vertices.
void	setCurrentPoint(java.awt.Point p) Sets the current point that the mouse is at in drawing a selection box
void	setInitialPoint(java.awt.Point p) Sets the initial point that the mouse was at for drawing the selection box
void	setPuzzle(PuzzleInstance game)
void	start() What should I do when I am first displayed?
void	startTimer()
void	stop() What should I do when I am not being displayed?
void	stopTimer() Stops the timer.
void	tick()
java.awt.Point	transformPointFromGraphCoordinatesToView(java.awt.Point p)
java.awt.Point	transformPointFromViewToGraphCoordinates(java.awt.Point p) Transform the point according to the current transform.
void	update(java.util.Observable o, java.lang.Object arg) This is the method that is called when an object that this class is listening to, fires an event.
void	zoomHome()
void	zoomIn()
void	zoomOut()

Methods inherited from class javax.swing.JDesktopPane

getAccessibleContext, getAllFrames, getAllFramesInLayer, getDesktopManager, getDragMode, getSelectedFrame, getUI, getUIClassID, remove, remove, removeAll, selectFrame, setComponentZOrder, setDesktopManager, setDragMode, setSelectedFrame, setUI, updateUI

Methods inherited from class javax.swing.JLayeredPane

getComponentCountInLayer, getComponentsInLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getPosition, highestLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, 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, 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

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, removeContainerListener, 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

Field Detail

FRAME_RATE

public static final int FRAME_RATE

See Also:

Constant Field Values

TUTORIAL_FRAME_WIDTH

public static final int TUTORIAL_FRAME_WIDTH

See Also:

Constant Field Values

Constructor Detail

GraphView

public GraphView()

GraphView

public GraphView(PuzzleInstance thePuzzle,
                 java.lang.String theTitle)

Constructor

Parameters:

currentlySelectedPuzzle - The game instance you want to have associated with this jTableView

themeName - The theme name that this jTableView should use to draw

Method Detail

init

public void init(PuzzleInstance thePuzzle,
                 java.lang.String theTitle)

displayInternalFrame

public void displayInternalFrame(java.lang.String title,
                                 java.lang.String contents,
                                 java.util.ArrayList<java.awt.Point> pointsOfInterest,
                                 boolean showNextButton)

setPuzzle

public void setPuzzle(PuzzleInstance game)

tick

public void tick()

stopTimer

public void stopTimer()

Stops the timer. This must be called when a graph jTableView is done being used otherwise it might keep running before it gets garbage collected and keep running. If the thread keeps running then the repainting for animation will get thrown off

startTimer

public void startTimer()

update

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

This is the method that is called when an object that this class is listening to, fires an event.

Specified by:

update in interface java.util.Observer

setInitialPoint

public void setInitialPoint(java.awt.Point p)

Sets the initial point that the mouse was at for drawing the selection box

Parameters:

p - The initial point that the mouse was at when the selection box started being drawn

setCurrentPoint

public void setCurrentPoint(java.awt.Point p)

Sets the current point that the mouse is at in drawing a selection box

Parameters:

p - The current point the mouse is at in drawing the selection box

closeBox

public void closeBox()

Used when a selection box should not be drawn any more.

checkWithinBox

public boolean checkWithinBox(java.awt.Point p)

Checks to see if a point is within the area defined by the selection box

Parameters:

p - The point that you want check against the boxes selection area

Returns:

Weather or not the point is in the selection box

getVertexWidth

public int getVertexWidth()

Return the scale of this jTableView: the complete width of the drawn vertex image

Returns:

The width scale

getVertexHeight

public int getVertexHeight()

Return the scale of this jTableView: the complete height of the drawn vertex image

Returns:

The height scale

getVertexCenter

public java.awt.Point getVertexCenter()

resizeCanvas

public void resizeCanvas(boolean adjustTutorialDialog)

Resize the area of the canvas to fit the layout of the vertices.

Parameters:

adjustTutorialDialog - TODO

width - The desired width

height - The desired height

zoomHome

public void zoomHome()

zoomIn

public void zoomIn()

zoomOut

public void zoomOut()

transformPointFromViewToGraphCoordinates

public java.awt.Point transformPointFromViewToGraphCoordinates(java.awt.Point p)

Transform the point according to the current transform. Given a clicked location, give the actual coordinates in the graph.

Parameters:

p -

Returns:

transformPointFromGraphCoordinatesToView

public java.awt.Point transformPointFromGraphCoordinatesToView(java.awt.Point p)

getZoom

public double getZoom()

isStillAnimating

public boolean isStillAnimating()

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

getMinWidth

public int getMinWidth()

getMinHeight

public int getMinHeight()