edu.rit.draw.item

Class SolidOutline

java.lang.Object

edu.rit.draw.item.SolidOutline

All Implemented Interfaces:

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

public class SolidOutline
extends java.lang.Object
implements Outline

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Fill	NORMAL_FILL The normal solid outline fill paint (black).
static SolidOutline	NORMAL_OUTLINE The normal solid outline (width = 1, fill paint = black).
static float	NORMAL_WIDTH The normal solid outline width (1).

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

NONE

Constructor Summary

Constructors

Constructor and Description
SolidOutline() Construct a new solid outline object with the normal width (1) and the normal fill paint (black).
SolidOutline(SolidOutline theOutline) Construct a new solid outline object with the same width and fill paint as the given solid outline object.

Method Summary

Modifier and Type	Method and Description
Fill	fill() Returns this solid outline object's fill paint.
SolidOutline	fill(Fill theFill) Set this solid outline object's fill paint.
float	getStrokeWidth() Returns the stroke width of this outline.
void	readExternal(java.io.ObjectInput in) Read this solid 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	width() Returns this solid outline object's width.
SolidOutline	width(float theWidth) Set this solid outline object's width.
void	writeExternal(java.io.ObjectOutput out) Write this solid 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 solid outline width (1).

See Also:

Constant Field Values

NORMAL_FILL

public static final Fill NORMAL_FILL

The normal solid outline fill paint (black).

NORMAL_OUTLINE

public static final SolidOutline NORMAL_OUTLINE

The normal solid outline (width = 1, fill paint = black).

Constructor Detail

SolidOutline

public SolidOutline()

Construct a new solid outline object with the normal width (1) and the normal fill paint (black).

SolidOutline

public SolidOutline(SolidOutline theOutline)

Construct a new solid outline object with the same width and fill paint as the given solid outline object.

Parameters:

theOutline - Solid outline object.

Throws:

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

Method Detail

width

public float width()

Returns this solid outline object's width.

Returns:

Width.

width

public SolidOutline width(float theWidth)

Set this solid outline object's width.

Parameters:

theWidth - Width.

Returns:

This solid outline object.

Throws:

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

fill

public Fill fill()

Returns this solid outline object's fill paint.

Returns:

Fill paint.

fill

public SolidOutline fill(Fill theFill)

Set this solid outline object's fill paint.

Parameters:

theFill - Fill paint.

Returns:

This solid outline object.

Throws:

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

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 solid 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 solid 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 solid outline object cannot be found.