|
JSR 217 (Maintenance Release) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
CAP_BUTT
,
CAP_ROUND
, and CAP_SQUARE
.
JOIN_BEVEL
,
JOIN_MITER
, and JOIN_ROUND
.
For more information on the user space coordinate system and the
rendering process, see the Graphics2D
class comments.
Graphics2D
Field Summary | |
static int |
CAP_BUTT
Ends unclosed subpaths with no added decoration. |
static int |
CAP_ROUND
Ends unclosed subpaths with a round decoration that has a radius equal to half of the width of the pen. |
static int |
CAP_SQUARE
Ends unclosed subpaths 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
Joins path segments by connecting the outer corners of their wide outlines with a straight segment. |
static int |
JOIN_MITER
Joins path segments by extending their outside edges until they meet. |
static int |
JOIN_ROUND
Joins path segments by rounding off the corner at a radius of half the line width. |
Constructor Summary | |
BasicStroke()
Constructs a new BasicStroke with defaults for all
attributes. |
|
BasicStroke(float width)
Constructs a solid BasicStroke with the specified
line width and with default values for the cap and join
styles. |
|
BasicStroke(float width,
int cap,
int join)
Constructs a solid BasicStroke with the specified
attributes. |
|
BasicStroke(float width,
int cap,
int join,
float miterlimit)
Constructs a solid BasicStroke with the specified
attributes. |
Method Summary | |
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, and miter limit attributes with
those of this BasicStroke . |
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. |
int |
hashCode()
Returns the hashcode for this stroke. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int JOIN_MITER
public static final int JOIN_ROUND
public static final int JOIN_BEVEL
public static final int CAP_BUTT
public static final int CAP_ROUND
public static final int CAP_SQUARE
Constructor Detail |
public BasicStroke(float width, int cap, int join, float miterlimit)
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 meetmiterlimit
- 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_MITERpublic BasicStroke(float width, int cap, int join)
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_MITERpublic BasicStroke(float width)
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 negativepublic BasicStroke()
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.
Method Detail |
public float getLineWidth()
Graphics2D
class comments for more information on
the user space coordinate system.
BasicStroke
.Graphics2D
public int getEndCap()
BasicStroke
as one
of the static int
values that define possible end cap
styles.public int getLineJoin()
BasicStroke
as one
of the static int
values that define possible line
join styles.public float getMiterLimit()
BasicStroke
.public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
Hashtable
public boolean equals(Object obj)
BasicStroke
by first testing if it is a BasicStroke
and then comparing
its width, join, cap, and miter limit attributes with
those of this BasicStroke
.
equals
in class Object
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.Object.hashCode()
,
Hashtable
|
JSR 217 (Maintenance Release) | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |