| java.lang.Object
 java.awt.BasicStroke
| BasicStroke | | public class BasicStroke implements Stroke(Code) | | The BasicStroke class defines a basic set of rendering
attributes for the outlines of graphics primitives, which are rendered
with a
Graphics2D object that has its Stroke attribute set to
this BasicStroke.
The rendering attributes defined by BasicStroke describe
the shape of the mark made by a pen drawn along the outline of a
Shape and the decorations applied at the ends and joins of
path segments of the Shape.
These rendering attributes include:
- width
- The pen width, measured perpendicularly to the pen trajectory.
- end caps
- The decoration applied to the ends of unclosed subpaths and
dash segments. Subpaths that start and end on the same point are
still considered unclosed if they do not have a CLOSE segment.
See
java.awt.geom.PathIterator.SEG_CLOSE SEG_CLOSE for more information on the CLOSE segment.
The three different decorations are:
BasicStroke.CAP_BUTT ,
BasicStroke.CAP_ROUND , and
BasicStroke.CAP_SQUARE .
- line joins
- The decoration applied at the intersection of two path segments
and at the intersection of the endpoints of a subpath that is closed
using
java.awt.geom.PathIterator.SEG_CLOSE SEG_CLOSE .
The three different decorations are:
BasicStroke.JOIN_BEVEL ,
BasicStroke.JOIN_MITER , and
BasicStroke.JOIN_ROUND .
- miter limit
- The limit to trim a line join that has a JOIN_MITER decoration.
A line join is trimmed when the ratio of miter length to stroke
width is greater than the miterlimit value. The miter length is
the diagonal length of the miter, which is the distance between
the inside corner and the outside corner of the intersection.
The smaller the angle formed by two line segments, the longer
the miter length and the sharper the angle of intersection. The
default miterlimit value of 10.0f causes all angles less than
11 degrees to be trimmed. Trimming miters converts
the decoration of the line join to bevel.
- dash attributes
- The definition of how to make a dash pattern by alternating
between opaque and transparent sections.
All attributes that specify measurements and distances controlling
the shape of the returned outline are measured in the same
coordinate system as the original unstroked Shape
argument. When a Graphics2D object uses a
Stroke object to redefine a path during the execution
of one of its draw methods, the geometry is supplied
in its original form before the Graphics2D transform
attribute is applied. Therefore, attributes such as the pen width
are interpreted in the user space coordinate system of the
Graphics2D object and are subject to the scaling and
shearing effects of the user-space-to-device-space transform in that
particular Graphics2D.
For example, the width of a rendered shape's outline is determined
not only by the width attribute of this BasicStroke,
but also by the transform attribute of the
Graphics2D object. Consider this code:
// sets the Graphics2D object's Tranform attribute
g2d.scale(10, 10);
// sets the Graphics2D object's Stroke attribute
g2d.setStroke(new BasicStroke(1.5f));
Assuming there are no other scaling transforms added to the
Graphics2D object, the resulting line
will be approximately 15 pixels wide.
As the example code demonstrates, a floating-point line
offers better precision, especially when large transforms are
used with a Graphics2D object.
When a line is diagonal, the exact width depends on how the
rendering pipeline chooses which pixels to fill as it traces the
theoretical widened outline. The choice of which pixels to turn
on is affected by the antialiasing attribute because the
antialiasing rendering pipeline can choose to color
partially-covered pixels.
For more information on the user space coordinate system and the
rendering process, see the Graphics2D class comments.
See Also: Graphics2D
version:
1.50, 06/08/07
author:
Jim Graham |
| Field Summary | |
| final public static int | CAP_BUTT
Ends unclosed subpaths and dash segments with no added
decoration. | | final public static int | CAP_ROUND
Ends unclosed subpaths and dash segments with a round
decoration that has a radius equal to half of the width
of the pen. | | final public static int | CAP_SQUARE
Ends 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. | | final public static int | JOIN_BEVEL
Joins path segments by connecting the outer corners of their
wide outlines with a straight segment. | | final public static int | JOIN_MITER
Joins path segments by extending their outside edges until
they meet. | | final public static int | JOIN_ROUND
Joins path segments by rounding off the corner at a radius
of half the line width. | | int | cap
| | float | dash
| | float | dash_phase
| | int | join
| | float | miterlimit
| | float | width
|
| Constructor Summary | |
| public | BasicStroke(float width, int cap, int join, float miterlimit, float dash, float dash_phase)
Constructs a new BasicStroke with the specified
attributes.
Parameters:
width - the width of this BasicStroke. | | public | BasicStroke(float width, int cap, int join, float miterlimit)
Constructs a solid BasicStroke with the specified
attributes. | | public | BasicStroke(float width, int cap, int join)
Constructs a solid BasicStroke with the specified
attributes. | | public | BasicStroke(float width)
Constructs a solid BasicStroke with the specified
line width and with default values for the cap and join
styles. | | public | BasicStroke()
Constructs a new BasicStroke with defaults for all
attributes. |
| Method Summary | |
| public Shape | createStrokedShape(Shape s)
Returns a Shape whose interior defines the
stroked outline of a specified Shape. | | public boolean | equals(Object obj)
Tests if a specified object is equal to this BasicStroke
by first testing if it is a BasicStroke and then comparing
its width, join, cap, miter limit, dash, and dash phase attributes with
those of this BasicStroke. | | public float[] | getDashArray()
Returns 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 outline of the Shape
to be stroked, the user space
distance that the pen travels is accumulated. | | public float | getDashPhase()
Returns the current dash phase.
The dash phase is a distance specified in user coordinates that
represents an offset into the dashing pattern. | | public int | getEndCap()
Returns the end cap style. | | public int | getLineJoin()
Returns the line join style. | | public float | getLineWidth()
Returns the line width. | | public float | getMiterLimit()
Returns the limit of miter joins. | | public int | hashCode()
Returns the hashcode for this stroke. |
| CAP_BUTT | | final public static int CAP_BUTT(Code) | | Ends unclosed subpaths and dash segments with no added
decoration.
|
| CAP_ROUND | | final public static int CAP_ROUND(Code) | | Ends unclosed subpaths and dash segments with a round
decoration that has a radius equal to half of the width
of the pen.
|
| CAP_SQUARE | | final public static int CAP_SQUARE(Code) | | Ends 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.
|
| JOIN_BEVEL | | final public static int JOIN_BEVEL(Code) | | Joins path segments by connecting the outer corners of their
wide outlines with a straight segment.
|
| JOIN_MITER | | final public static int JOIN_MITER(Code) | | Joins path segments by extending their outside edges until
they meet.
|
| JOIN_ROUND | | final public static int JOIN_ROUND(Code) | | Joins path segments by rounding off the corner at a radius
of half the line width.
|
| dash_phase | | float dash_phase(Code) | | |
| miterlimit | | float miterlimit(Code) | | |
| BasicStroke | | public BasicStroke(float width, int cap, int join, float miterlimit, float dash, float dash_phase)(Code) | | Constructs a new BasicStroke with the specified
attributes.
Parameters:
width - the width of this BasicStroke. Thewidth must be greater than or equal to 0.0f. If width isset to 0.0f, the stroke is rendered as the thinnestpossible line for the target device and the antialiashint setting.
Parameters:
cap - the decoration of the ends of a BasicStroke
Parameters:
join - the decoration applied where path segments meet
Parameters:
miterlimit - the limit to trim the miter join. The miterlimitmust be greater than or equal to 1.0f.
Parameters:
dash - the array representing the dashing pattern
Parameters:
dash_phase - the offset to start the dashing pattern
throws:
IllegalArgumentException - if width is negative
throws:
IllegalArgumentException - if cap is not eitherCAP_BUTT, CAP_ROUND or CAP_SQUARE
throws:
IllegalArgumentException - if miterlimit is lessthan 1 and join is JOIN_MITER
throws:
IllegalArgumentException - if join is noteither JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
throws:
IllegalArgumentException - if dash_phaseis negative and dash is not null
throws:
IllegalArgumentException - if the length ofdash is zero
throws:
IllegalArgumentException - if dash lengths are all zero. |
| BasicStroke | | public BasicStroke(float width, int cap, int join, float miterlimit)(Code) | | Constructs a solid BasicStroke with the specified
attributes.
Parameters:
width - the width of the BasicStroke
Parameters:
cap - the decoration of the ends of a BasicStroke
Parameters:
join - the decoration applied where path segments meet
Parameters:
miterlimit - the limit to trim the miter join
throws:
IllegalArgumentException - if width is negative
throws:
IllegalArgumentException - if cap is not eitherCAP_BUTT, CAP_ROUND or CAP_SQUARE
throws:
IllegalArgumentException - if miterlimit is lessthan 1 and join is JOIN_MITER
throws:
IllegalArgumentException - if join is noteither JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER |
| BasicStroke | | public BasicStroke(float width, int cap, int join)(Code) | | Constructs a solid BasicStroke with the specified
attributes. The miterlimit 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 BasicStroke
Parameters:
cap - the decoration of the ends of a BasicStroke
Parameters:
join - the decoration applied where path segments meet
throws:
IllegalArgumentException - if width is negative
throws:
IllegalArgumentException - if cap is not eitherCAP_BUTT, CAP_ROUND or CAP_SQUARE
throws:
IllegalArgumentException - if join is noteither JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER |
| BasicStroke | | public BasicStroke(float width)(Code) | | Constructs a solid BasicStroke with the specified
line width and with default values for the cap and join
styles.
Parameters:
width - the width of the BasicStroke
throws:
IllegalArgumentException - if width is negative |
| BasicStroke | | public BasicStroke()(Code) | | Constructs a new BasicStroke with defaults for all
attributes.
The default attributes are a solid line of width 1.0, CAP_SQUARE,
JOIN_MITER, a miter limit of 10.0.
|
| createStrokedShape | | public Shape createStrokedShape(Shape s)(Code) | | Returns a Shape whose interior defines the
stroked outline of a specified Shape.
Parameters:
s - the Shape boundary be stroked the Shape of the stroked outline. |
| equals | | public boolean equals(Object obj)(Code) | | Tests if a specified object is equal to this BasicStroke
by first testing if it is a BasicStroke and then comparing
its width, join, cap, miter limit, dash, and dash phase attributes with
those of this BasicStroke.
Parameters:
obj - the specified object to compare to this BasicStroke true if the width, join, cap, miter limit, dash, anddash phase are the same for both objects;false otherwise. |
| getDashArray | | public float[] getDashArray()(Code) | | Returns 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 outline of the Shape
to be stroked, the user space
distance that the pen travels is accumulated. The distance
value is used to index into the dash array.
The pen is opaque when its current cumulative distance maps
to an even element of the dash array and transparent otherwise.
the dash array. |
| getDashPhase | | public float getDashPhase()(Code) | | Returns the current dash phase.
The dash phase is a distance specified in user coordinates that
represents an offset into the dashing pattern. In other words, the dash
phase defines the point in the dashing pattern that will correspond to
the beginning of the stroke.
the dash phase as a float value. |
| getEndCap | | public int getEndCap()(Code) | | Returns the end cap style.
the end cap style of this BasicStroke as oneof the static int values that define possible end capstyles. |
| getLineJoin | | public int getLineJoin()(Code) | | Returns the line join style.
the line join style of the BasicStroke as oneof the static int values that define possible linejoin styles. |
| getLineWidth | | public float getLineWidth()(Code) | | Returns the line width. Line width is represented in user space,
which is the default-coordinate space used by Java 2D. See the
Graphics2D class comments for more information on
the user space coordinate system.
the line width of this BasicStroke.
See Also: Graphics2D |
| getMiterLimit | | public float getMiterLimit()(Code) | | Returns the limit of miter joins.
the limit of miter joins of the BasicStroke. |
| hashCode | | public int hashCode()(Code) | | Returns the hashcode for this stroke.
a hash code for this stroke. |
|
|