edu.rit.draw.item

Class DashedOutline

java.lang.Object

edu.rit.draw.item.DashedOutline

All Implemented Interfaces:

Outline, java.io.Externalizable, java.io.Serializable

public class DashedOutline
extends java.lang.Object
implements Outline

Class DashedOutline provides an object that outlines an area in a DrawingItem with a square-cornered dashed stroke in a solid color.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static float	NORMAL_DOWN_FACTOR The normal dashed outline down factor (10).
static Fill	NORMAL_FILL The normal dashed outline fill paint (black).
static DashedOutline	NORMAL_OUTLINE The normal dashed outline (width = 1, fill paint = black, down factor = 5, up factor = 3).
static float	NORMAL_UP_FACTOR The normal dashed outline up factor (6).
static float	NORMAL_WIDTH The normal dashed outline width (1).

Fields inherited from interface edu.rit.draw.item.Outline

NONE

Constructor Summary

Constructors

Constructor and Description
DashedOutline() Construct a new dashed outline object with the normal width (1), the normal fill paint (black), the normal down factor (10), and the normal up factor (6).
DashedOutline(DashedOutline theOutline) Construct a new dashed outline object with the same width, fill paint, down factor, and up factor as the given dashed outline object.

Method Summary

Modifier and Type	Method and Description
float	down() Returns this dashed outline object's down factor.
DashedOutline	down(float theDownFactor) Set this dashed outline object's down factor.
Fill	fill() Returns this dashed outline object's fill paint.
DashedOutline	fill(Fill theFill) Set this dashed outline object's fill paint.
float	getStrokeWidth() Returns the stroke width of this outline.
void	readExternal(java.io.ObjectInput in) Read this dashed outline object from the given object input stream.
void	setGraphicsContext(java.awt.Graphics2D g2d) Set the given graphics context's stroke and paint attributes as specified by this outline object.
float	up() Returns this dashed outline object's up factor.
DashedOutline	up(float theUpFactor) Set this dashed outline object's up factor.
float	width() Returns this dashed outline object's width.
DashedOutline	width(float theWidth) Set this dashed outline object's width.
void	writeExternal(java.io.ObjectOutput out) Write this dashed outline object to the given object output stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NORMAL_WIDTH

public static final float NORMAL_WIDTH

The normal dashed outline width (1).

See Also:

Constant Field Values

NORMAL_FILL

public static final Fill NORMAL_FILL

The normal dashed outline fill paint (black).

NORMAL_DOWN_FACTOR

public static final float NORMAL_DOWN_FACTOR

The normal dashed outline down factor (10).

See Also:

Constant Field Values

NORMAL_UP_FACTOR

public static final float NORMAL_UP_FACTOR

The normal dashed outline up factor (6).

See Also:

Constant Field Values

NORMAL_OUTLINE

public static final DashedOutline NORMAL_OUTLINE

The normal dashed outline (width = 1, fill paint = black, down factor = 5, up factor = 3).

Constructor Detail

DashedOutline

public DashedOutline()

Construct a new dashed outline object with the normal width (1), the normal fill paint (black), the normal down factor (10), and the normal up factor (6).

DashedOutline

public DashedOutline(DashedOutline theOutline)

Construct a new dashed outline object with the same width, fill paint, down factor, and up factor as the given dashed outline object.

Parameters:

theOutline - Dashed outline object.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theOutline is null.

Method Detail

width

public float width()

Returns this dashed outline object's width.

Returns:

Width.

width

public DashedOutline width(float theWidth)

Set this dashed outline object's width.

Parameters:

theWidth - Width.

Returns:

This dashed outline object.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theWidth is less than or equal to 0.

fill

public Fill fill()

Returns this dashed outline object's fill paint.

Returns:

Fill paint.

fill

public DashedOutline fill(Fill theFill)

Set this dashed outline object's fill paint.

Parameters:

theFill - Fill paint.

Returns:

This dashed outline object.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theFill is null.

down

public float down()

Returns this dashed outline object's down factor. The down factor is the length, relative to this dashed outline object's width, that the "pen" is "down" drawing a dash.

Returns:

Down factor.

down

public DashedOutline down(float theDownFactor)

Set this dashed outline object's down factor. The down factor is the length, relative to this dashed outline object's width, that the "pen" is "down" drawing a dash.

Parameters:

theDownFactor - Down factor.

Returns:

This dashed outline object.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theDownFactor is less than or equal to 0.

up

public float up()

Returns this dashed outline object's up factor. The up factor is the length, relative to this dashed outline object's width, that the "pen" is "up" between dashes.

Returns:

Up factor.

up

public DashedOutline up(float theUpFactor)

Set this dashed outline object's up factor. The down factor is the length, relative to this dashed outline object's width, that the "pen" is "up" between dashes.

Parameters:

theUpFactor - Up factor.

Returns:

This dashed outline object.

Throws:

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theUpFactor is less than or equal to 0.

getStrokeWidth

public float getStrokeWidth()

Returns the stroke width of this outline.

Specified by:

getStrokeWidth in interface Outline

Returns:

Stroke width.

setGraphicsContext

public void setGraphicsContext(java.awt.Graphics2D g2d)

Set the given graphics context's stroke and paint attributes as specified by this outline object.

Specified by:

setGraphicsContext in interface Outline

Parameters:

g2d - 2-D graphics context.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write this dashed outline object to the given object output stream.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - Object output stream.

Throws:

java.io.IOException - Thrown if an I/O error occurred.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Read this dashed outline object from the given object input stream.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - Object input stream.

Throws:

java.io.IOException - Thrown if an I/O error occurred.

java.lang.ClassNotFoundException - Thrown if any class needed to deserialize this dashed outline object cannot be found.