com.highqsoft.util

Class PenStroke

java.lang.Object

com.highqsoft.util.PenStroke

All Implemented Interfaces:

java.awt.Stroke

public class PenStroke
extends java.lang.Object
implements java.awt.Stroke

Defines a basic set of rendering attributes for stroked graphics primitives. These attributes describe the shape of a pen drawn along the trajectory of the path and the decorations applied where path segments are joined and where they begin and end. These attributes include:

width

The width of the pen measured perpendicular to its trajectory.

end caps

The decoration of the path where line segments begin and end.

line joins

The decoration of the path between connected line segments.

dash attributes

The definition of how to make a dash pattern along the trajectory of the path by creating new segments which alternate between opaque and transparent sections.

Version:

$Log: PenStroke.java,v $, Revision 1.13 2017/04/06 13:29:13 adil, update copyright., , Revision 1.12 2015/05/20 13:06:26 karst, Update Copyrights to current., , Revision 1.11 2013/01/03 09:51:45 karst, Update copyright to 2013., , Revision 1.10 2012/01/04 08:17:02 karst, Update copyright to 2012., , Revision 1.9 2011/01/05 09:10:25 karst, Update copyright header to 2011, , Revision 1.8 2010/01/11 07:56:14 karst, Update header comment to current, , Revision 1.7 2009/01/05 09:29:43 karst, Modify copyright to 2009, , Revision 1.6 2008/01/10 09:19:09 karst, Change copyright to current., , Revision 1.5 2005/05/17 14:48:14 andy, Add new method that is required to JAVA 1.5 and higher., , Revision 1.4 2005/01/04 08:10:22 karst, Change copyright to current., , Revision 1.3 2004/05/06 13:31:19 andy, Code purged., , Revision 1.2 2004/02/10 13:57:53 andy, Add the dispose method for the FillAdapter (PathConsumer interface changed)., , Revision 1.1 2003/05/27 12:00:35 andy, Initial Version 3.0, , Revision 1.1 2001/02/09 14:37:54 hans, Initial CVS revision., , Revision 1.2 1998/10/01 08:41:48 andy, Weekly security commitment., , Revision 1.1 1998-08-11 12:27:18+02 andy, Weekly security commitment.,

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
static int	CAP_BUTT End unclosed subpaths and dash segments with no added decoration.
static int	CAP_ROUND End unclosed subpaths and dash segments with a round decoration with radius equal to half of the line width.
static int	CAP_SQUARE End unclosed subpaths and dash segments with a square projection that extends beyond the end of the segment to a distance equal to half of the line width.
static int	JOIN_BEVEL Join line segments by connecting the outer corners of their wide outlines with a straight segment.
static int	JOIN_MITER Join line segments by extending their outside edges until they meet.
static int	JOIN_ROUND Join line segments by rounding off the corner at a radius of half the line width.

Constructor Summary

Constructors

Constructor and Description
PenStroke() Construct a new stroke with defaults for all attributes.
PenStroke(float width) Construct a new stroke with the specified line width, and with default values for the cap and join styles and no dashing.
PenStroke(float width, int cap, int join) Construct a new stroke with the specified attributes, but no dashing.
PenStroke(float width, int cap, int join, float miterlimit) Construct a new stroke with the specified attributes, but no dashing.
PenStroke(float width, int cap, int join, float miterlimit, float[] dash, float dash_phase) Construct a new stroke with the specified attributes.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clone the stroke.
java.awt.Shape	createStrokedShape(java.awt.Shape s) Returns a shape whose interior defines the stroked outline of a given shape.
boolean	equals(java.lang.Object obj) Check whether the object is equal to the obejct that is passed.
float[]	getDashArray() Return the array representing the lengths of the dash segments.
float	getDashPhase() Returns the dash phase.
int	getEndCap() Returns the end cap style.
int	getLineJoin() Returns the line join style.
float	getLineWidth() Returns the line width.
float	getMiterLimit() Returns the limit of miter joins.
void	setDashArray(float[] dash) Sets the array representing the lengths of the dash segments.
void	setDashPhase(float dash_phase) Sets the dash phase.
void	setEndCap(int cap) Sets the end cap style.
void	setLineJoin(int join) Sets the line join style.
void	setLineWidth(float width) Sets the line width.
void	setMiterLimit(float miterlimit) Sets the limit of miter joins.
java.lang.String	toString() Returns the string repesentation of te stroke.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

JOIN_MITER

public static final int JOIN_MITER

Join line segments by extending their outside edges until they meet.

See Also:

Constant Field Values

JOIN_ROUND

public static final int JOIN_ROUND

Join line segments by rounding off the corner at a radius of half the line width.

See Also:

Constant Field Values

JOIN_BEVEL

public static final int JOIN_BEVEL

Join line segments by connecting the outer corners of their wide outlines with a straight segment.

See Also:

Constant Field Values

CAP_BUTT

public static final int CAP_BUTT

End unclosed subpaths and dash segments with no added decoration.

See Also:

Constant Field Values

CAP_ROUND

public static final int CAP_ROUND

End unclosed subpaths and dash segments with a round decoration with radius equal to half of the line width.

See Also:

Constant Field Values

CAP_SQUARE

public static final int CAP_SQUARE

End unclosed subpaths and dash segments with a square projection that extends beyond the end of the segment to a distance equal to half of the line width.

See Also:

Constant Field Values

Constructor Detail

PenStroke

public PenStroke(float width,
         int cap,
         int join,
         float miterlimit,
         float[] dash,
         float dash_phase)

Construct a new stroke with the specified attributes.

Parameters:

width - The width of the stroke.

cap - The style of the ends of a stroke.

join - The style to join strokes together.

miterlimit - The limit to trim the miter join.

dash - The array representing the dashing pattern.

dash_phase - The offset to start the dashing pattern.

PenStroke

public PenStroke(float width,
         int cap,
         int join,
         float miterlimit)

Construct a new stroke with the specified attributes, but no dashing.

Parameters:

width - The width of the stroke.

cap - The style of the ends of a stroke.

join - The style to join strokes together.

miterlimit - The limit to trim the miter join.

PenStroke

public PenStroke(float width,
         int cap,
         int join)

Construct a new stroke with the specified attributes, but no dashing. The miter limit parameter is unnecessary in cases where the default is allowable or the line joins are not specified as JOIN_MITER.

Parameters:

width - The width of the stroke.

cap - The style of the ends of a stroke.

join - The style to join strokes together.

PenStroke

public PenStroke(float width)

Construct a new stroke with the specified line width, and with default values for the cap and join styles and no dashing.

Parameters:

width - The width of the stroke.

PenStroke

public PenStroke()

Construct a new stroke with defaults for all attributes. The default attributes are a line width of 1.0, CAP_SQUARE, JOIN_MITER, a miter limit of 10.0, and no dashing.

Method Detail

clone

public java.lang.Object clone()

Clone the stroke.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Returns the string repesentation of te stroke.

Overrides:

toString in class java.lang.Object

createStrokedShape

public java.awt.Shape createStrokedShape(java.awt.Shape s)

Returns a shape whose interior defines the stroked outline of a given shape.

Specified by:

createStrokedShape in interface java.awt.Stroke

Parameters:

s - The shape whose boundary should be stroked.

Returns:

The shape of the stroked outline.

See Also:

Stroke.createStrokedShape(java.awt.Shape)

getLineWidth

public float getLineWidth()

Returns the line width. Line width is represented in user space.

Returns:

The line width of the stroke.

See Also:

setLineWidth(float)

setLineWidth

public void setLineWidth(float width)

Sets the line width. Line width is represented in user space.

See Also:

getLineWidth()

getEndCap

public int getEndCap()

Returns the end cap style.

Returns:

The end cap style of the stroke.

See Also:

getEndCap()

setEndCap

public void setEndCap(int cap)

Sets the end cap style.

See Also:

setEndCap(int)

getLineJoin

public int getLineJoin()

Returns the line join style.

Returns:

The line join style of the stroke.

See Also:

setLineJoin(int)

setLineJoin

public void setLineJoin(int join)

Sets the line join style.

See Also:

getLineJoin()

getMiterLimit

public float getMiterLimit()

Returns the limit of miter joins.

Returns:

The limit of miter joins.

See Also:

setMiterLimit(float)

setMiterLimit

public void setMiterLimit(float miterlimit)

Sets the limit of miter joins.

See Also:

getMiterLimit()

getDashArray

public float[] getDashArray()

Return the array representing the lengths of the dash segments. Alternate entries in the array represent the user space lengths of the opaque and transparent segments of the dashes. As the pen moves along the path to be stroked, the user space distance that the pen travels will be accumulated to index into the dash array. The pen will be opaque when its current cumulative distance maps to an odd element of the dash array and transparent otherwise.

Returns:

The dash array.

See Also:

setDashArray(float[])

setDashArray

public void setDashArray(float[] dash)

Sets the array representing the lengths of the dash segments. Alternate entries in the array represent the user space lengths of the opaque and transparent segments of the dashes. As the pen moves along the path to be stroked, the user space distance that the pen travels will be accumulated to index into the dash array. The pen will be opaque when its current cumulative distance maps to an odd element of the dash array and transparent otherwise.

See Also:

getDashArray()

getDashPhase

public float getDashPhase()

Returns the dash phase. The dash phase is a user space distance that is used to initialize the path distance accumulation variable before the first segment of the first subpath is stroked.

Returns:

the dash phase.

See Also:

setDashPhase(float)

setDashPhase

public void setDashPhase(float dash_phase)

Sets the dash phase. The dash phase is a user space distance that is used to initialize the path distance accumulation variable before the first segment of the first subpath is stroked.

See Also:

getDashPhase()

equals

public boolean equals(java.lang.Object obj)

Check whether the object is equal to the obejct that is passed.

Overrides:

equals in class java.lang.Object

Returns:

A boolean that is true, if the objects are equal.