Pen

java.lang.Object
- ch.aplu.turtle.Pen

```
public class Pen
extends java.lang.Object
```
The Pen class provides anything used for drawing the lines, such as line width, pen color, end caps, dashed lines, etc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Pen.TextInfo
Text information.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Pen.TextInfo` Text information.

Field Summary

Fields
Modifier and Type Field and Description

static java.awt.Font DEFAULT_FONT
The default font that is used when drawing text.

Fields
Modifier and Type	Field and Description
`static java.awt.Font`	`DEFAULT_FONT` The default font that is used when drawing text.

Constructor Summary

Constructors
Constructor and Description
`Pen()` Constructor with standard pen color (black) and and standard Stroke.
`Pen(java.awt.Color color)` Constructor with given `color` and standard Stroke.

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String[]`	`getAvailableFontFamilies()` Provides information about the currently available font families (e.g.
`java.awt.Color`	`getColor()` Queries the `Pen`s color.
`float[]`	`getDashArray()` Queries the `Pen`s dash array.
`float`	`getDashPhase()` Queries the `Pen`s dash phase.
`int`	`getEndCap()` Queries the `Pen`s end cap style.
`java.awt.Color`	`getFillColor()` Queries the `Pen`s fill color.
`java.awt.Font`	`getFont()` Queries the current font.
`int`	`getFontSize()` Queries the size (in points, rounded to int) of the current font.
`int`	`getLineJoin()` Queries the `Pen`s line join style.
`float`	`getLineWidth()` Queries the `Pen`s line width
`float`	`getMiterLimit()` Queries the `Pen`s miter limit style.
`java.awt.Stroke`	`getStroke()` Gets the `Pen`s `Stroke`
`int`	`getTextAscent()` Returns ascender height of text with current font (in pixels).
`int`	`getTextDescent()` Returns descender height of text with current font (in pixels).
`int`	`getTextHeight()` Returns height of text with current font (in pixels).
`static Pen.TextInfo`	`getTextInfo(java.lang.String text, java.awt.Font font)` Returns text information for given font and text.
`int`	`getTextWidth(java.lang.String text)` Returns width of given text with current font (in pixels).
`void`	`setColor(java.awt.Color color)` Sets the `Pen`s color.
`void`	`setDash(float[] dashArray)` Sets the `Pen`s dash array.
`void`	`setDashPhase(float dashPhase)` Sets the `Pen`s dash phase.
`void`	`setEndCap(int endCap)` Sets the `Pen`s end cap style.
`void`	`setFillColor(java.awt.Color color)` Sets the `Pen`s fill color.
`void`	`setFont(java.awt.Font f)` Changes the font to the given one.
`void`	`setFontSize(float size)` Changes the font size (in points).
`void`	`setFontSize(int size)` Changes the font size (in points).
`void`	`setFontStyle(int style)` Changes the font style.
`void`	`setLineJoin(int join)` Sets the `Pen`s line join style.
`void`	`setLineWidth(float width)` Sets the `Pen`s line width.
`void`	`setMiterLimit(float miterlimit)` Sets the `Pen`s miter limit.

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

- Field Detail
  - DEFAULT_FONT
```
public static java.awt.Font DEFAULT_FONT
```
    The default font that is used when drawing text. First argument must be one of "Serif", "SansSerif", "Monotyped", "Dialog" or "DialogInput" to guarantee that this font exists on all systems.
    
    See Also:
    for more information, e.g. on font styles.
- Constructor Detail
  - Pen
```
public Pen()
```
    Constructor with standard pen color (black) and and standard Stroke. Fill colo same as pen color.
    
    See Also:
    BasicStroke
  - Pen
```
public Pen(java.awt.Color color)
```
    Constructor with given color and standard Stroke. Fill color same as pen color,
    
    See Also:
    BasicStroke
- Method Detail
  - getColor
```
public java.awt.Color getColor()
```
    Queries the Pens color.
  - setColor
```
public void setColor(java.awt.Color color)
```
    Sets the Pens color.
  - setFillColor
```
public void setFillColor(java.awt.Color color)
```
    Sets the Pens fill color.
  - getFillColor
```
public java.awt.Color getFillColor()
```
    Queries the Pens fill color.
  - getStroke
```
public java.awt.Stroke getStroke()
```
    Gets the Pens Stroke
    
    See Also:
    BasicStroke, Stroke
  - getLineWidth
```
public float getLineWidth()
```
    Queries the Pens line width
  - getEndCap
```
public int getEndCap()
```
    Queries the Pens end cap style.
    
    See Also:
    BasicStroke
  - getLineJoin
```
public int getLineJoin()
```
    Queries the Pens line join style.
    
    See Also:
    BasicStroke
  - getMiterLimit
```
public float getMiterLimit()
```
    Queries the Pens miter limit style.
    
    See Also:
    BasicStroke
  - getDashArray
```
public float[] getDashArray()
```
    Queries the Pens dash array.
    
    See Also:
    BasicStroke
  - getDashPhase
```
public float getDashPhase()
```
    Queries the Pens dash phase.
    
    See Also:
    BasicStroke
  - setLineWidth
```
public void setLineWidth(float width)
```
    Sets the Pens line width.
  - setEndCap
```
public void setEndCap(int endCap)
```
    Sets the Pens end cap style.
    
    See Also:
    BasicStroke
  - setLineJoin
```
public void setLineJoin(int join)
```
    Sets the Pens line join style.
    
    See Also:
    BasicStroke
  - setMiterLimit
```
public void setMiterLimit(float miterlimit)
```
    Sets the Pens miter limit.
    
    See Also:
    BasicStroke
  - setDash
```
public void setDash(float[] dashArray)
```
    Sets the Pens dash array.
    
    See Also:
    BasicStroke
  - setDashPhase
```
public void setDashPhase(float dashPhase)
```
    Sets the Pens dash phase.
    
    See Also:
    BasicStroke
  - getAvailableFontFamilies
```
public static java.lang.String[] getAvailableFontFamilies()
```
    Provides information about the currently available font families (e.g. "Roman"). Each font name is a string packed into a array of strings.
    
    See Also:
    for more information about font attributes etc.
  - setFontStyle
```
public void setFontStyle(int style)
```
    Changes the font style.
    
    See Also:
    for possible styles.
  - setFontSize
```
public void setFontSize(int size)
```
    Changes the font size (in points).
  - setFontSize
```
public void setFontSize(float size)
```
    Changes the font size (in points). You will probably only need the int version setFontSize(int).
  - getFontSize
```
public int getFontSize()
```
    Queries the size (in points, rounded to int) of the current font.
  - setFont
```
public void setFont(java.awt.Font f)
```
    Changes the font to the given one.
  - getFont
```
public java.awt.Font getFont()
```
    Queries the current font.
  - getTextInfo
```
public static Pen.TextInfo getTextInfo(java.lang.String text,
                       java.awt.Font font)
```
    Returns text information for given font and text.
  - getTextWidth
```
public int getTextWidth(java.lang.String text)
```
    Returns width of given text with current font (in pixels).
  - getTextHeight
```
public int getTextHeight()
```
    Returns height of text with current font (in pixels).
  - getTextAscent
```
public int getTextAscent()
```
    Returns ascender height of text with current font (in pixels).
  - getTextDescent
```
public int getTextDescent()
```
    Returns descender height of text with current font (in pixels).

Class Pen

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FONT

Constructor Detail

Pen

Pen

Method Detail

getColor

setColor

setFillColor

getFillColor

getStroke

getLineWidth

getEndCap

getLineJoin

getMiterLimit

getDashArray

getDashPhase

setLineWidth

setEndCap

setLineJoin

setMiterLimit

setDash

setDashPhase

getAvailableFontFamilies

setFontStyle

setFontSize

setFontSize

getFontSize

setFont

getFont

getTextInfo

getTextWidth

getTextHeight

getTextAscent

getTextDescent