Class Board

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

Board

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

Direct Known Subclasses:

TicTacToeHashCode

abstract class Board
extends javax.swing.JFrame
implements java.awt.event.ActionListener

The superclass used for TicTacToeHashCode. This class primarily contains the graphical elements used in TicTacToeHashCode, which is why it extends JFrame. The frame created contains nine buttons representing the nine spots on a TicTacToe board and has labels with the hash code and whether or not this class is a winner. This class has abstract methods because the methods related to hashing and determining the win are supposed to be defined in TicTacToeHashCode. This class was written by my instructor to be used in the assignment.

Author:

Mrs. Kelly

Nested Class Summary

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Frame.AccessibleAWTFrame

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	boardString	This String is the String being used as the current TicTacToe String
private javax.swing.JButton[][]	buttons	The JButton array that displays the TicTacToe board (the xs and os)
private javax.swing.JLabel	lblHashCode	The label on the graphical interface showing the hash code of the current TicTacToe String displayed
private javax.swing.JLabel	lblWinTitle	The label on the graphical interface showing whether the current TicTacToe String being displayed is a winner or a loser

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
Board(java.lang.String title)	Constructs a Board using a title.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)	This method was required by the superclass, but was not defined because it was not needed.
char	charAt(int row, int col)	Returns the value of the char in buttons at [row, col]
char	charAt(java.lang.String s, int row, int col)	Returns the char in a String, which if it were a 3x3 array, would be at position [row, col].
private static char	cycleValue(char ch)	Used to cycle out the values of the board, by replacing certain character with other certain characters.
void	displayRandomString()	Displays a random string on the board.
java.lang.String	getBoardString()	Returns boardString
(package private) abstract boolean	isWin()	An abstract method that should return whether or not the boardString is a winning TicTacToe String, hopefully using an array of winners and hash codes
(package private) abstract boolean	isWin(java.lang.String s)	An abstract method that should return whether or not the String passed in is a winning TicTacToe String, hopefully using an array of winners and hash codes
(package private) abstract int	myHashCode()	An abstract method that is intended to generate a hash code using the boardString
private char	randomXO()	Returns a random option for the TicTacToe board, namely an x, an o, or a space.
void	resetBoardString()	Resets the boardString to an empty String
void	setBoardString(java.lang.String s)	Sets the boardString to s
void	setHashCodeLabel(int hashcode)	Sets the label for the hashcode using a passed in String.
private void	setupFrame()	Sets up basic aspects of the frame like size, layout, and default close operation.
(package private) javax.swing.JPanel	setupPanelOne()	Creates and returns a JPanel with the correct current hash code, winner label, and title of the Board.
private javax.swing.JPanel	setupPanelTwo()	Creates and returns a JPanel to be integrated into the board.
void	setWinnerLabel(boolean result)	Sets the winner label using a given Boolean.
void	setWinnerLabel(java.lang.String result)	Sets the label for the winner using a passed in String.
void	show(java.lang.String s)	Shows the TicTacToe string passed in on the buttons array.

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Field Detail

buttons

private javax.swing.JButton[][] buttons

The JButton array that displays the TicTacToe board (the xs and os)

lblHashCode

private javax.swing.JLabel lblHashCode

The label on the graphical interface showing the hash code of the current TicTacToe String displayed

lblWinTitle

private javax.swing.JLabel lblWinTitle

The label on the graphical interface showing whether the current TicTacToe String being displayed is a winner or a loser

boardString

private java.lang.String boardString

This String is the String being used as the current TicTacToe String

Constructor Detail

Board

public Board(java.lang.String title)

Constructs a Board using a title.

Parameters:

title - the title for hte JFrame

Method Detail

setHashCodeLabel

public void setHashCodeLabel(int hashcode)

Sets the label for the hashcode using a passed in String. Does not calculate the hash code itself.

Parameters:

hashcode - a given integer that is supposed to be the hash code

setWinnerLabel

public void setWinnerLabel(java.lang.String result)

Sets the label for the winner using a passed in String. Does not determine the winner itself.

Parameters:

result - a given String that is supposed to represent whether the boardString is a winner or a loser

setWinnerLabel

public void setWinnerLabel(boolean result)

Sets the winner label using a given Boolean. This method does not calculate this status itself. If the parameter is true, the label will be set to winner. If the boolean is false, the label will be set to loser. This uses the setWinnerLabel with a String method, so it should be used instead of that other method because the label should only be set to winner or loser.

Parameters:

result - a boolean representing the winning status

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

This method was required by the superclass, but was not defined because it was not needed.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - an ActionEvent that will not have any effect on the program given the explanation above

setupPanelOne

javax.swing.JPanel setupPanelOne()

Creates and returns a JPanel with the correct current hash code, winner label, and title of the Board. This method is used as part of the original set up, and is not used every time that something is changed on the board, meaning that the values such as hash code are not automatically re-displayed because of this method.

Returns:

a JPanel that will be used in the JFrame of the board

setupPanelTwo

private javax.swing.JPanel setupPanelTwo()

Creates and returns a JPanel to be integrated into the board. This mainly sets up the button section of the board.

Returns:

a JPanel with buttons on it

cycleValue

private static char cycleValue(char ch)

Used to cycle out the values of the board, by replacing certain character with other certain characters.

Parameters:

ch - an x, o or space character

Returns:

if 'x', an 'o'; if 'o', a ' '; else, 'x'

setupFrame

private void setupFrame()

Sets up basic aspects of the frame like size, layout, and default close operation.

randomXO

private char randomXO()

Returns a random option for the TicTacToe board, namely an x, an o, or a space.

Returns:

a random character out of the three options: an x, and o or a space

myHashCode

abstract int myHashCode()

An abstract method that is intended to generate a hash code using the boardString

Returns:

the hash code corresponding to the boardString

isWin

abstract boolean isWin(java.lang.String s)

An abstract method that should return whether or not the String passed in is a winning TicTacToe String, hopefully using an array of winners and hash codes

Parameters:

s - the String whose winning status should be determined

Returns:

true, if s is a win, false otherwise

isWin

abstract boolean isWin()

An abstract method that should return whether or not the boardString is a winning TicTacToe String, hopefully using an array of winners and hash codes

Returns:

true, if boardString is a win, false otherwise

charAt

public char charAt(int row,
                   int col)

Returns the value of the char in buttons at [row, col]

Parameters:

row - the row the char is on in buttons

col - the col the char is on in buttons

Returns:

the char at the position in the buttons array

charAt

public char charAt(java.lang.String s,
                   int row,
                   int col)

Returns the char in a String, which if it were a 3x3 array, would be at position [row, col]. If the length is not long enough, an * will be returned

Parameters:

s - the String holding the char to be found

row - the row the char would be on

col - the col the char would be on

Returns:

a char at the proper position in s, if s is not long enough, an *

show

public void show(java.lang.String s)

Shows the TicTacToe string passed in on the buttons array. This does not change the labels which show the hash code and the winning status

Parameters:

s - the String to be displayed on the buttons

resetBoardString

public void resetBoardString()

Resets the boardString to an empty String

setBoardString

public void setBoardString(java.lang.String s)

Sets the boardString to s

Parameters:

s - the String boardString is to be set to

getBoardString

public java.lang.String getBoardString()

Returns boardString

Returns:

boardString

displayRandomString

public void displayRandomString()

Displays a random string on the board. It sets both the buttons and the appropriate labels