java.lang.Object | |
↳ | java.awt.BasicStroke |
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:
SEG_CLOSE
for more information on the CLOSE segment.
The three different decorations are: CAP_BUTT
,
CAP_ROUND
, and CAP_SQUARE
.
SEG_CLOSE
.
The three different decorations are: JOIN_BEVEL
,
JOIN_MITER
, and JOIN_ROUND
.
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.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | CAP_BUTT | Ends unclosed subpaths and dash segments with no added decoration. | |||||||||
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. | |||||||||
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. | |||||||||
int | JOIN_BEVEL | Joins path segments by connecting the outer corners of their wide outlines with a straight segment. | |||||||||
int | JOIN_MITER | Joins path segments by extending their outside edges until they meet. | |||||||||
int | JOIN_ROUND | Joins path segments by rounding off the corner at a radius of half the line width. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new
BasicStroke with the specified
attributes. | |||||||||||
Constructs a solid
BasicStroke with the specified
attributes. | |||||||||||
Constructs a solid
BasicStroke with the specified
attributes. | |||||||||||
Constructs a solid
BasicStroke with the specified
line width and with default values for the cap and join
styles. | |||||||||||
Constructs a new
BasicStroke with defaults for all
attributes. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a
Shape whose interior defines the
stroked outline of a specified Shape . | |||||||||||
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 . | |||||||||||
Returns the array representing the lengths of the dash segments.
| |||||||||||
Returns the current dash phase.
| |||||||||||
Returns the end cap style.
| |||||||||||
Returns the line join style.
| |||||||||||
Returns the line width.
| |||||||||||
Returns the limit of miter joins.
| |||||||||||
Returns the hashcode for this stroke.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.awt.Stroke
|
Ends unclosed subpaths and dash segments with no added decoration.
Ends unclosed subpaths and dash segments with a round decoration that has a radius equal to half of the width of the pen.
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.
Joins path segments by connecting the outer corners of their wide outlines with a straight segment.
Joins path segments by extending their outside edges until they meet.
Joins path segments by rounding off the corner at a radius of half the line width.
Constructs a new BasicStroke
with the specified
attributes.
width | the width of this BasicStroke . The
width must be greater than or equal to 0.0f. If width is
set to 0.0f, the stroke is rendered as the thinnest
possible line for the target device and the antialias
hint setting. |
---|---|
cap | the decoration of the ends of a BasicStroke |
join | the decoration applied where path segments meet |
miterlimit | the limit to trim the miter join. The miterlimit must be greater than or equal to 1.0f. |
dash | the array representing the dashing pattern |
dash_phase | the offset to start the dashing pattern |
IllegalArgumentException | if width is negative |
---|---|
IllegalArgumentException | if cap is not either
CAP_BUTT, CAP_ROUND or CAP_SQUARE |
IllegalArgumentException | if miterlimit is less
than 1 and join is JOIN_MITER |
IllegalArgumentException | if join is not
either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER |
IllegalArgumentException | if dash_phase
is negative and dash is not null |
IllegalArgumentException | if the length of
dash is zero |
IllegalArgumentException | if dash lengths are all zero. |
Constructs a solid BasicStroke
with the specified
attributes.
width | the width of the BasicStroke |
---|---|
cap | the decoration of the ends of a BasicStroke |
join | the decoration applied where path segments meet |
miterlimit | the limit to trim the miter join |
IllegalArgumentException | if width is negative |
---|---|
IllegalArgumentException | if cap is not either
CAP_BUTT, CAP_ROUND or CAP_SQUARE |
IllegalArgumentException | if miterlimit is less
than 1 and join is JOIN_MITER |
IllegalArgumentException | if join is not
either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
|
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.
width | the width of the BasicStroke |
---|---|
cap | the decoration of the ends of a BasicStroke |
join | the decoration applied where path segments meet |
IllegalArgumentException | if width is negative |
---|---|
IllegalArgumentException | if cap is not either
CAP_BUTT, CAP_ROUND or CAP_SQUARE |
IllegalArgumentException | if join is not
either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
|
Constructs a solid BasicStroke
with the specified
line width and with default values for the cap and join
styles.
width | the width of the BasicStroke |
---|
IllegalArgumentException | if width is negative
|
---|
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.
Returns a Shape
whose interior defines the
stroked outline of a specified Shape
.
s | the Shape boundary be stroked |
---|
Shape
of the stroked outline.
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
.
obj | the specified object to compare to this
BasicStroke |
---|
true
if the width, join, cap, miter limit, dash, and
dash phase are the same for both objects;
false
otherwise.
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.
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.
float
value.
Returns the end cap style.
BasicStroke
as one
of the static int
values that define possible end cap
styles.
Returns the line join style.
BasicStroke
as one
of the static int
values that define possible line
join styles.
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.
BasicStroke
.Returns the limit of miter joins.
BasicStroke
.
Returns the hashcode for this stroke.