WinPlotterFX

Constructors
Constructor and Description
`WinPlotterFX()` Default constructor When a new WinPlotter instance is created, its window is initialized to appear at screen coordinates (10,10) with a size of 200 units in both x and y.

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`drawPoint(double x, double y)` Draws a point at the specified logical coordinates using the current pen color.
`void`	`drawTo(double x, double y)` Draws a line from the current pen position to the specified logical coordinates, using the current pen color.
`void`	`erase()` Erases the contents of the current WinPlotterFX window
`void`	`moveTo(double x, double y)` Moves the pen from the current pen position to the specified logical coordinates.
`void`	`printAt(double x, double y, java.lang.String text)` Prints a text string at the specified logical coordinates using the current pen color
`void`	`setBackgroundColor(double red, double green, double blue)` Sets the background color of the WinPlotterFX window.
`boolean`	`setGrid(boolean showGrid, double xIncrement, double yIncrement, javafx.scene.paint.Color gridColor)` Specifies whether a grid is to be automatically drawn within the WinPlotter window, and sets the grid increment.
`void`	`setPenColor(double red, double green, double blue)` Sets the pen color used for drawing lines.
`boolean`	`setWindowSize(double width, double height)` Sets the size of an individual WinPlotter window
`void`	`setWindowTitle(java.lang.String title)` Sets the title of an individual WinPlotter window.
`void`	`showPlotter()` Displays the completed WinPlotterFX window.

java.lang.Object
- javafx.stage.Window
- - javafx.stage.Stage
  - - edu.msoe.winplotterfx.WinPlotterFX

All Implemented Interfaces:

javafx.event.EventTarget
```
public class WinPlotterFX
extends javafx.stage.Stage
```
WinPlotterFX is a port of the WinPlotter class by Mark Hornick adapted for JavaFX. WinPlotterFX is a programmable drawing window. Users will use feed commands into the WinPlotterFX object which in turn will draw lines or points onto a window.

Property Summary

Properties inherited from class javafx.stage.Stage
alwaysOnTopProperty, fullScreenExitHintProperty, fullScreenExitKeyProperty, fullScreenProperty, iconifiedProperty, maxHeightProperty, maximizedProperty, maxWidthProperty, minHeightProperty, minWidthProperty, resizableProperty, titleProperty

Properties inherited from class javafx.stage.Window
eventDispatcherProperty, focusedProperty, heightProperty, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, sceneProperty, showingProperty, widthProperty, xProperty, yProperty

Field Summary

Fields inherited from class javafx.stage.Window
impl_peer, peerListener

Constructor Summary

Constructors
Constructor and Description

WinPlotterFX()
Default constructor When a new WinPlotter instance is created, its window is initialized to appear at screen coordinates (10,10) with a size of 200 units in both x and y.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

void drawPoint(double x, double y)
Draws a point at the specified logical coordinates using the current pen color.

void drawTo(double x, double y)
Draws a line from the current pen position to the specified logical coordinates, using the current pen color.

void erase()
Erases the contents of the current WinPlotterFX window

void moveTo(double x, double y)
Moves the pen from the current pen position to the specified logical coordinates.

void printAt(double x, double y, java.lang.String text)
Prints a text string at the specified logical coordinates using the current pen color

void setBackgroundColor(double red, double green, double blue)
Sets the background color of the WinPlotterFX window.

boolean setGrid(boolean showGrid, double xIncrement, double yIncrement, javafx.scene.paint.Color gridColor)
Specifies whether a grid is to be automatically drawn within the WinPlotter window, and sets the grid increment.

void setPenColor(double red, double green, double blue)
Sets the pen color used for drawing lines.

boolean setWindowSize(double width, double height)
Sets the size of an individual WinPlotter window

void setWindowTitle(java.lang.String title)
Sets the title of an individual WinPlotter window.

void showPlotter()
Displays the completed WinPlotterFX window.

Methods inherited from class javafx.stage.Stage
alwaysOnTopProperty, close, fullScreenExitHintProperty, fullScreenExitKeyProperty, fullScreenProperty, getFullScreenExitHint, getFullScreenExitKeyCombination, getIcons, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getModality, getOwner, getStyle, getTitle, iconifiedProperty, impl_getMXWindowType, impl_setImportant, impl_setPrimary, impl_visibleChanged, impl_visibleChanging, initModality, initOwner, initStyle, isAlwaysOnTop, isFullScreen, isIconified, isMaximized, isResizable, maxHeightProperty, maximizedProperty, maxWidthProperty, minHeightProperty, minWidthProperty, resizableProperty, setAlwaysOnTop, setFullScreen, setFullScreenExitHint, setFullScreenExitKeyCombination, setIconified, setMaxHeight, setMaximized, setMaxWidth, setMinHeight, setMinWidth, setResizable, setScene, setTitle, show, showAndWait, titleProperty, toBack, toFront

Methods inherited from class javafx.stage.Window
addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getProperties, getScene, getUserData, getWidth, getX, getY, hasProperties, heightProperty, hide, impl_getPeer, impl_getWindows, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setFocused, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setUserData, setWidth, setX, setY, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

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

- Constructor Detail
  - WinPlotterFX
```
public WinPlotterFX()
```
    Default constructor When a new WinPlotter instance is created, its window is initialized to appear at screen coordinates (10,10) with a size of 200 units in both x and y. The background color is initialized to WHITE, and the pen color is initialized to BLACK. The window title is initialized to "A plot of something". The pen position is initialized to (0,0) in logical coordinates. Positive x (horizontal) coordinates extend to the right, while positive y (vertical) coordinates' extend upward. The default font size for text is 14 point.
- Method Detail
  - drawPoint
```
public void drawPoint(double x,
                      double y)
```
    Draws a point at the specified logical coordinates using the current pen color. The default diameter of a point is 10 pixels.
    
    Parameters:
    
    x - x (horizontal) coordinate of the point
    
    y - y (vertical) coordinate of the point
  - drawTo
```
public void drawTo(double x,
                   double y)
```
    Draws a line from the current pen position to the specified logical coordinates, using the current pen color. The current pen position is wherever the last line was drawn to; otherwise wherever the current pen position was moved to via the moveTo() method.
    
    Parameters:
    
    x - x (horizontal) coordinate of the line endpoint
    
    y - y (vertical) coordinate of the line endpoint
  - erase
```
public void erase()
```
    Erases the contents of the current WinPlotterFX window
  - moveTo
```
public void moveTo(double x,
                   double y)
```
    Moves the pen from the current pen position to the specified logical coordinates. A line drawn subsequently begins at this set of coordinates.
    
    Parameters:
    
    x - x (horizontal) coordinate of the pen position
    
    y - y (vertical) coordinate of the pen position
  - printAt
```
public void printAt(double x,
                    double y,
                    java.lang.String text)
```
    Prints a text string at the specified logical coordinates using the current pen color
    
    Parameters:
    
    x - x (horizontal) coordinate of the first character in the string
    
    y - y (vertical) coordinate of the first character in the string
    
    t - The text to be printed
  - setBackgroundColor
```
public void setBackgroundColor(double red,
                               double green,
                               double blue)
```
    Sets the background color of the WinPlotterFX window. Invalid values will be set to 0
    
    Parameters:
    
    red - the red component of the color value, a value between 0 and 1.0
    
    green - the green component of the color value, a value between 0 and 1.0
    
    blue - the blue component of the color value, a value between 0 and 1.0
  - setGrid
```
public boolean setGrid(boolean showGrid,
                       double xIncrement,
                       double yIncrement,
                       javafx.scene.paint.Color gridColor)
```
    Specifies whether a grid is to be automatically drawn within the WinPlotter window, and sets the grid increment.
    
    Parameters:
    
    showGrid - flag indicating whether to display a grid
    
    xIncrement - grid increment in logical x coordinates
    
    yIncrement - grid increment in logical y coordinates
    
    gridColor - color of the grid lines
    
    Returns:
    
    true if successful; false if invalid grid increments (negative or greater than max-min) are specified. Note: no checking is done if showGrid is false
  - setPenColor
```
public void setPenColor(double red,
                        double green,
                        double blue)
```
    Sets the pen color used for drawing lines. Invalid values will be set to 0
    
    Parameters:
    
    red - the red component of the color value, a value between 0 and 1.0
    
    green - the green component of the color value, a value between 0 and 1.0
    
    blue - the blue component of the color value, a value between 0 and 1.0
  - showPlotter
```
public void showPlotter()
```
    Displays the completed WinPlotterFX window. Adds the drawing to the window and displays to the screen.
  - setWindowSize
```
public boolean setWindowSize(double width,
                             double height)
```
    Sets the size of an individual WinPlotter window
    
    Parameters:
    
    width - window width in pixel units
    
    height - window height in pixel units
    
    Returns:
    
    true if successful; false if invalid (negative) coordinates are specified
  - setWindowTitle
```
public void setWindowTitle(java.lang.String title)
```
    Sets the title of an individual WinPlotter window.
    
    Parameters:
    
    title - the window title

Class WinPlotterFX

Property Summary

Properties inherited from class javafx.stage.Stage

Properties inherited from class javafx.stage.Window

Field Summary

Fields inherited from class javafx.stage.Window

Constructor Summary

Method Summary

Methods inherited from class javafx.stage.Stage

Methods inherited from class javafx.stage.Window

Methods inherited from class java.lang.Object

Constructor Detail

WinPlotterFX

Method Detail

drawPoint

drawTo

erase

moveTo

printAt

setBackgroundColor

setGrid

setPenColor

showPlotter

setWindowSize

setWindowTitle