Window

java.lang.Object
- cs2.Window

```
public class Window
extends java.lang.Object
```
The Window class provides a simple Swing Window. The window class provides an abstraction of a user interface window that provides the common and basic components already configured. The Window has a menu bar, four separate areas surrounding the center of the window. Menus can be built dynamically from the code. The four areas around the center can contain any number of buttons for executing commands. The center area can display any Java Swing Graphics2D object. The display and management of the area is up to the developer by using Shape objects.

Author:

loran, mapq, maellis

Constructor Summary

Constructors
Constructor	Description
`Window()`	Default constructor, uses window.title from properties file for title, if available.
`Window(java.lang.String title)`	Constructor, creates window and sets window title

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addButton(Button b, WindowSide w)`	Adds a button to the window on the appropriate side.
`void`	`addShape(Shape s)`	Adds shape s to the window.
`void`	`clickButton(WindowSide side, java.lang.String buttonName)`	simulates clicking the specified Button, for use in testing by students.
`static java.awt.Color`	`getColorProperty(java.lang.String key)`	Given a 'key', return a Color object as value of the property.
`int`	`getGraphPanelHeight()`	gets the graph panel's height
`int`	`getGraphPanelWidth()`	gets the graph panel's width
`int`	`getHeight()`	gets the graph panel's height
`static java.lang.String`	`getProperty(java.lang.String key)`	Given a 'key', return the value of the property stored in the default.properties file.
`java.util.Iterator<Shape>`	`getShapesIterator()`	Returns an iterator for all the shapes in the window.
`java.lang.String`	`getTitle()`	Getter for the title of the window.
`int`	`getWidth()`	gets the window's width
`void`	`hideInfoPanel()`	Hides the InfoPanel
`boolean`	`isInfoPanelVisible()`	Returns true/false indicating whether the Infolabel is visible or not
`void`	`moveToBack(Shape s)`	Changes the z-order of shapes, moving s behind all other shapes.
`void`	`moveToFront(Shape s)`	Changes the z-order of shapes, moving s to the front of all other shapes.
`void`	`removeAllShapes()`	Removes all shapes from this window.
`void`	`removeButton(Button b, WindowSide w)`	Removes the button given from the side indicated of this window.
`void`	`removeShape(Shape s)`	Removes Shape s from this Window.
`void`	`repaint()`	Requests a repaint of the whole window.
`void`	`setInfoText(java.lang.String info)`	Sets the info label's text to be the info given.
`void`	`setSize(int windowWidth, int windowHeight)`	sets the window's size
`void`	`setTitle(java.lang.String title)`	Setter for the window title.
`void`	`showInfoPanel()`	Shows the InfoPanel
`void`	`toggleInfoPanel()`	Toggles the visibility of the InfoPanel

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

- Constructor Detail
  - Window
```
public Window()
```
    Default constructor, uses window.title from properties file for title, if available.
  - Window
```
public Window(java.lang.String title)
```
    Constructor, creates window and sets window title
    
    Parameters:
    
    title - String indicating this Window's title.
- Method Detail
  - clickButton
```
public void clickButton(WindowSide side,
                        java.lang.String buttonName)
```
    simulates clicking the specified Button, for use in testing by students.
    
    Parameters:
    
    side - the WindowSide in which your button is located
    
    buttonName - the string which you gave your button name
  - setSize
```
public void setSize(int windowWidth,
                    int windowHeight)
```
    sets the window's size
  - getWidth
```
public int getWidth()
```
    gets the window's width
    
    Returns:
    
    integer width in pixels
  - getHeight
```
public int getHeight()
```
    gets the window's height
    
    Returns:
    
    integer height in pixels
  - getGraphPanelWidth
```
public int getGraphPanelWidth()
```
    gets the graph panel's width
    
    Returns:
    
    integer width in pixels
  - getGraphPanelHeight
```
public int getGraphPanelHeight()
```
    gets the graph panel's height
    
    Returns:
    
    integer height in pixels
  - getProperty
```
public static java.lang.String getProperty(java.lang.String key)
```
    Given a 'key', return the value of the property stored in the default.properties file. If the key is not found, it return null.
    
    Parameters:
    
    key - String indicating the desired property
    
    Returns:
    
    value associated with key
  - getColorProperty
```
public static java.awt.Color getColorProperty(java.lang.String key)
```
    Given a 'key', return a Color object as value of the property. The color is stored as r,g,b where r/g/b are all integers.
    
    Parameters:
    
    key - String indicating the property containing this window's color
    
    Returns:
    
    Color object
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Setter for the window title. Precondition: title != null
    
    Parameters:
    
    title - the String to use for setting the window's title
  - getTitle
```
public java.lang.String getTitle()
```
    Getter for the title of the window.
    
    Returns:
    
    window title
  - repaint
```
public void repaint()
```
    Requests a repaint of the whole window. Avoid this call if possible, instead force a repaint of individual items or just let Java handle the repainting.
  - addButton
```
public void addButton(Button b,
                      WindowSide w)
```
    Adds a button to the window on the appropriate side.
    
    Parameters:
    
    b - button to add
    
    w - side of window
  - removeButton
```
public void removeButton(Button b,
                         WindowSide w)
```
    Removes the button given from the side indicated of this window.
    
    Parameters:
    
    b - remove this button
    
    w - from this side of the window
  - addShape
```
public void addShape(Shape s)
```
    Adds shape s to the window. If the shape is null, nothing happens.
    
    Parameters:
    
    s - the Shape to add to this Window
  - removeShape
```
public void removeShape(Shape s)
```
    Removes Shape s from this Window.
    
    Parameters:
    
    s - the shape to remove from this Window.
  - removeAllShapes
```
public void removeAllShapes()
```
    Removes all shapes from this window.
  - moveToFront
```
public void moveToFront(Shape s)
```
    Changes the z-order of shapes, moving s to the front of all other shapes. This is called automatically on a shape when the mouse is pressed inside of a shape. If Shape not found, nothing happens.
    
    Parameters:
    
    s - the Shape to move to the front
  - moveToBack
```
public void moveToBack(Shape s)
```
    Changes the z-order of shapes, moving s behind all other shapes.
    
    Parameters:
    
    s - the Shape to move to the back
  - getShapesIterator
```
public java.util.Iterator<Shape> getShapesIterator()
```
    Returns an iterator for all the shapes in the window.
    
    Returns:
    
    an Interator of type Shape containing all of this Window's Shapes
  - isInfoPanelVisible
```
public boolean isInfoPanelVisible()
```
    Returns true/false indicating whether the Infolabel is visible or not
    
    Returns:
    
    visible status
  - setInfoText
```
public void setInfoText(java.lang.String info)
```
    Sets the info label's text to be the info given.
    
    Parameters:
    
    info - String of information
  - showInfoPanel
```
public void showInfoPanel()
```
    Shows the InfoPanel
  - hideInfoPanel
```
public void hideInfoPanel()
```
    Hides the InfoPanel
  - toggleInfoPanel
```
public void toggleInfoPanel()
```
    Toggles the visibility of the InfoPanel

Class Window

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Window

Window

Method Detail

clickButton

setSize

getWidth

getHeight

getGraphPanelWidth

getGraphPanelHeight

getProperty

getColorProperty

setTitle

getTitle

repaint

addButton

removeButton

addShape

removeShape

removeAllShapes

moveToFront

moveToBack

getShapesIterator

isInfoPanelVisible

setInfoText

showInfoPanel

hideInfoPanel

toggleInfoPanel