PictureYourSolution

java.lang.Object
- PictureYourSolution

```
public class PictureYourSolution
extends java.lang.Object
```
This class will be used to display a chess board with eight queens on it, which will serve as the graphical representation of solutions to the eight queens theoretical problem. One such solution is displayed when this program is run. However, that solution is manually programmed in, not found by a method, in the private mySolution() method, as that method simply sets the boolean array to a solution I found not using a computer program. This class will be used by EightQueens to display solutions that that class found using a method. The graphical interface displayed is a JFrame. It has two panels. A header with a JLabel, which has the automatic header text of "My Chess Board," although the header text can be changed. It will also have a grid panel with a GridLayout and 8x8 ChessSquarePanels added to represent the chess board. NOTE: This class used Mrs. Kelly's PracticeGraphics class heavily as a reference.

Author:

AnneMarie Caballero (annemariecabs)

Field Summary

Fields
Modifier and Type	Field	Description
`private static int`	`BEST_PANEL_HEIGHT`	The optimal panel height for the header
`private static int`	`COLS`	The number of columns on the chess board
`private static java.awt.Color`	`DARK_BLUE`	A custom dark blue color to be used for the qs and the header
`private static java.awt.Color`	`DARK_COLOR`	The dark color for the chess board (my custom marigold color)
`private javax.swing.JPanel`	`grid`	The grid panel
`private javax.swing.JPanel`	`header`	The header panel
`private static java.awt.Color`	`HEADER_COLOR`	The color of the header (my custom dark blue color)
`private static java.lang.String`	`HEADER_TEXT`	The de facto title that will be printed on the header JLabel
`private javax.swing.JLabel`	`headerText`	The text to be written on the header
`private static int`	`HEIGHT`	The height of the JFrame
`private static java.awt.Color`	`LIGHT_COLOR`	The light color for the chess board
`private static java.awt.Color`	`MARIGOLD`	The color of the chess square panels that will be put on the chess board - also just a lovely yellow color
`private static int`	`MAX_PANEL_HEIGHT`	The maximum panel height for the header
`private static int`	`MIN_PANEL_HEIGHT`	The minimum panel height for the header
`private static java.awt.Font`	`PANEL_FONT`	The custom font to be used in the panels
`private static java.awt.Color`	`PANEL_TEXT_COLOR`	The text color to be used on the panel
`private boolean[][]`	`queens`	A boolean array of queens that will be keep track of the current solution in terms of a boolean array, rather than a Queen[]
`private static int`	`ROWS`	The number of rows on the chess board
`private ChessSquarePanel[][]`	`squares`	A 2d array of ChessSquarePanels which will display the chess board
`private static java.lang.String`	`TITLE`	The title for the board
`private static int`	`WIDTH`	The width of the JFrame
`private javax.swing.JFrame`	`window`	The window in which all the graphical components will be held

Constructor Summary

Constructors
Constructor Description

PictureYourSolution(boolean[][] qs)
Creates a PictureYourSolution object with a boolean[][] of queens that should represent a viable solution.

Constructors
Constructor	Description
`PictureYourSolution(boolean[][] qs)`	Creates a PictureYourSolution object with a boolean[][] of queens that should represent a viable solution.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`buildFrame()`	Builds the JFrame window to be used including setting its size and layout
`private javax.swing.JPanel`	`buildGridPanel()`	Builds and returns the grid panel representing the chess board using the queens field.
`private javax.swing.JPanel`	`buildHeaderPanel()`	Builds and returns a viable headerPanel including instantiating one, setting size and background color, creating and setting the fields of a JPanel, then adding that JPanel in.
`private java.awt.Color`	`getRightColor(int r, int c)`	Returns which color should be used for each square on the chess board using the row and column of that square
`private boolean`	`getRightFlag(int r, int c)`	Returns whether this square should have a queen on it or not depending on the information in the queens array.
`static void`	`main(java.lang.String[] args)`
`private static boolean[][]`	`mySolution()`	A private method that simply creates a boolean array that represents the first solution that I found, which was found without using a computer program.
`static boolean[][]`	`queenToBooleanArray(java.util.ArrayList<Queen> queens)`	Converts a Queen ArrayList to a boolean array.
`void`	`resetHeader(java.lang.String hText)`	Resets the header text using the passed-in hText
`void`	`resetSquares(boolean[][] qs)`	Resets the chess board squares using queens, which represents a different solution.
`void`	`setVisibility(boolean visible)`	Sets the window panel's visibility

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MARIGOLD
```
private static final java.awt.Color MARIGOLD
```
    The color of the chess square panels that will be put on the chess board - also just a lovely yellow color
  - DARK_BLUE
```
private static final java.awt.Color DARK_BLUE
```
    A custom dark blue color to be used for the qs and the header
  - ROWS
```
private static final int ROWS
```
    The number of rows on the chess board
    
    See Also:
    
    Constant Field Values
  - COLS
```
private static final int COLS
```
    The number of columns on the chess board
    
    See Also:
    
    Constant Field Values
  - HEIGHT
```
private static final int HEIGHT
```
    The height of the JFrame
    
    See Also:
    
    Constant Field Values
  - WIDTH
```
private static final int WIDTH
```
    The width of the JFrame
    
    See Also:
    
    Constant Field Values
  - LIGHT_COLOR
```
private static final java.awt.Color LIGHT_COLOR
```
    The light color for the chess board
  - DARK_COLOR
```
private static final java.awt.Color DARK_COLOR
```
    The dark color for the chess board (my custom marigold color)
  - HEADER_COLOR
```
private static final java.awt.Color HEADER_COLOR
```
    The color of the header (my custom dark blue color)
  - PANEL_FONT
```
private static final java.awt.Font PANEL_FONT
```
    The custom font to be used in the panels
  - MIN_PANEL_HEIGHT
```
private static final int MIN_PANEL_HEIGHT
```
    The minimum panel height for the header
    
    See Also:
    
    Constant Field Values
  - MAX_PANEL_HEIGHT
```
private static final int MAX_PANEL_HEIGHT
```
    The maximum panel height for the header
    
    See Also:
    
    Constant Field Values
  - BEST_PANEL_HEIGHT
```
private static final int BEST_PANEL_HEIGHT
```
    The optimal panel height for the header
    
    See Also:
    
    Constant Field Values
  - HEADER_TEXT
```
private static final java.lang.String HEADER_TEXT
```
    The de facto title that will be printed on the header JLabel
    
    See Also:
    
    Constant Field Values
  - PANEL_TEXT_COLOR
```
private static final java.awt.Color PANEL_TEXT_COLOR
```
    The text color to be used on the panel
  - TITLE
```
private static final java.lang.String TITLE
```
    The title for the board
    
    See Also:
    
    Constant Field Values
  - window
```
private javax.swing.JFrame window
```
    The window in which all the graphical components will be held
  - header
```
private javax.swing.JPanel header
```
    The header panel
  - grid
```
private javax.swing.JPanel grid
```
    The grid panel
  - headerText
```
private javax.swing.JLabel headerText
```
    The text to be written on the header
  - squares
```
private ChessSquarePanel[][] squares
```
    A 2d array of ChessSquarePanels which will display the chess board
  - queens
```
private boolean[][] queens
```
    A boolean array of queens that will be keep track of the current solution in terms of a boolean array, rather than a Queen[]
- Constructor Detail
  - PictureYourSolution
```
PictureYourSolution(boolean[][] qs)
```
    Creates a PictureYourSolution object with a boolean[][] of queens that should represent a viable solution. This sets queens to qs, initializes squares, builds the grid and header panel, and then adds these panels to the window.
    
    Parameters:
    
    qs - the solution to be displayed
- Method Detail
  - setVisibility
```
public void setVisibility(boolean visible)
```
    Sets the window panel's visibility
    
    Parameters:
    
    visible - if true, sets the JFrame to visible, else makes it disappear
  - resetSquares
```
public void resetSquares(boolean[][] qs)
```
    Resets the chess board squares using queens, which represents a different solution.
    
    Parameters:
    
    qs - the new solution to be displayed, represented as a boolean 2d array
  - resetHeader
```
public void resetHeader(java.lang.String hText)
```
    Resets the header text using the passed-in hText
    
    Parameters:
    
    hText - the new text to set the header to
  - buildFrame
```
private void buildFrame()
```
    Builds the JFrame window to be used including setting its size and layout
  - buildHeaderPanel
```
private javax.swing.JPanel buildHeaderPanel()
```
    Builds and returns a viable headerPanel including instantiating one, setting size and background color, creating and setting the fields of a JPanel, then adding that JPanel in. The JPanel will have the relevant text.
    
    Returns:
    
    the header panel
  - buildGridPanel
```
private javax.swing.JPanel buildGridPanel()
```
    Builds and returns the grid panel representing the chess board using the queens field. This will have a GridLayout and have 64 ChessSquarePanels.
    
    Returns:
    
    the grid panel
  - getRightColor
```
private java.awt.Color getRightColor(int r,
                                     int c)
```
    Returns which color should be used for each square on the chess board using the row and column of that square
    
    Parameters:
    
    r - the row of the square in question
    
    c - the column of the square in question
    
    Returns:
    
    LIGHT_COLOR for squares on even rows and columns, DARK_COLOR otherwise
  - getRightFlag
```
private boolean getRightFlag(int r,
                             int c)
```
    Returns whether this square should have a queen on it or not depending on the information in the queens array.
    
    Parameters:
    
    r - the row in question
    
    c - the column in question
    
    Returns:
    
    whether there should be a queen on (r, c)
  - mySolution
```
private static boolean[][] mySolution()
```
    A private method that simply creates a boolean array that represents the first solution that I found, which was found without using a computer program. I used literals because it seemed necessary, as this whole method is a way to avoid using literals in the body of the program.
    
    Returns:
    
    the first solution I found (!!)
  - queenToBooleanArray
```
public static boolean[][] queenToBooleanArray(java.util.ArrayList<Queen> queens)
```
    Converts a Queen ArrayList to a boolean array. Will be used in the Eight Queens class. Mostly a reference method.
    
    Parameters:
    
    queens - the Queen ArrayList to be converted
    
    Returns:
    
    the boolean[][] that represents the same information as the Queen ArrayList
  - main
```
public static void main(java.lang.String[] args)
```

Class PictureYourSolution

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARIGOLD

DARK_BLUE

ROWS

COLS

HEIGHT

WIDTH

LIGHT_COLOR

DARK_COLOR

HEADER_COLOR

PANEL_FONT

MIN_PANEL_HEIGHT

MAX_PANEL_HEIGHT

BEST_PANEL_HEIGHT

HEADER_TEXT

PANEL_TEXT_COLOR

TITLE

window

header

grid

headerText

squares

queens

Constructor Detail

PictureYourSolution

Method Detail

setVisibility

resetSquares

resetHeader

buildFrame

buildHeaderPanel

buildGridPanel

getRightColor

getRightFlag

mySolution

queenToBooleanArray

main