< prev index next >
src/java.desktop/share/classes/java/awt/BasicStroke.java
Print this page
*** 28,45 ****
import java.beans.ConstructorProperties;
import java.lang.annotation.Native;
/**
! * The <code>BasicStroke</code> class defines a basic set of rendering
* attributes for the outlines of graphics primitives, which are rendered
* with a {@link Graphics2D} object that has its Stroke attribute set to
! * this <code>BasicStroke</code>.
! * The rendering attributes defined by <code>BasicStroke</code> describe
* the shape of the mark made by a pen drawn along the outline of a
* {@link Shape} and the decorations applied at the ends and joins of
! * path segments of the <code>Shape</code>.
* These rendering attributes include:
* <dl>
* <dt><i>width</i>
* <dd>The pen width, measured perpendicularly to the pen trajectory.
* <dt><i>end caps</i>
--- 28,45 ----
import java.beans.ConstructorProperties;
import java.lang.annotation.Native;
/**
! * The {@code BasicStroke} class defines a basic set of rendering
* attributes for the outlines of graphics primitives, which are rendered
* with a {@link Graphics2D} object that has its Stroke attribute set to
! * this {@code BasicStroke}.
! * The rendering attributes defined by {@code BasicStroke} describe
* the shape of the mark made by a pen drawn along the outline of a
* {@link Shape} and the decorations applied at the ends and joins of
! * path segments of the {@code Shape}.
* These rendering attributes include:
* <dl>
* <dt><i>width</i>
* <dd>The pen width, measured perpendicularly to the pen trajectory.
* <dt><i>end caps</i>
*** 71,115 ****
* <dd>The definition of how to make a dash pattern by alternating
* between opaque and transparent sections.
* </dl>
* 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 <code>Shape</code>
! * argument. When a <code>Graphics2D</code> object uses a
! * <code>Stroke</code> object to redefine a path during the execution
! * of one of its <code>draw</code> methods, the geometry is supplied
! * in its original form before the <code>Graphics2D</code> transform
* attribute is applied. Therefore, attributes such as the pen width
* are interpreted in the user space coordinate system of the
! * <code>Graphics2D</code> object and are subject to the scaling and
* shearing effects of the user-space-to-device-space transform in that
! * particular <code>Graphics2D</code>.
* For example, the width of a rendered shape's outline is determined
! * not only by the width attribute of this <code>BasicStroke</code>,
* but also by the transform attribute of the
! * <code>Graphics2D</code> object. Consider this code:
! * <blockquote><tt>
* // sets the Graphics2D object's Transform attribute
* g2d.scale(10, 10);
* // sets the Graphics2D object's Stroke attribute
* g2d.setStroke(new BasicStroke(1.5f));
! * </tt></blockquote>
* Assuming there are no other scaling transforms added to the
! * <code>Graphics2D</code> 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 <code>Graphics2D</code> 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.
* <p>
* For more information on the user space coordinate system and the
! * rendering process, see the <code>Graphics2D</code> class comments.
* @see Graphics2D
* @author Jim Graham
*/
public class BasicStroke implements Stroke {
--- 71,115 ----
* <dd>The definition of how to make a dash pattern by alternating
* between opaque and transparent sections.
* </dl>
* 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 {@code Shape}
! * argument. When a {@code Graphics2D} object uses a
! * {@code Stroke} object to redefine a path during the execution
! * of one of its {@code draw} methods, the geometry is supplied
! * in its original form before the {@code Graphics2D} transform
* attribute is applied. Therefore, attributes such as the pen width
* are interpreted in the user space coordinate system of the
! * {@code Graphics2D} object and are subject to the scaling and
* shearing effects of the user-space-to-device-space transform in that
! * particular {@code Graphics2D}.
* For example, the width of a rendered shape's outline is determined
! * not only by the width attribute of this {@code BasicStroke},
* but also by the transform attribute of the
! * {@code Graphics2D} object. Consider this code:
! * <blockquote><pre>{@code
* // sets the Graphics2D object's Transform attribute
* g2d.scale(10, 10);
* // sets the Graphics2D object's Stroke attribute
* g2d.setStroke(new BasicStroke(1.5f));
! * }</pre></blockquote>
* Assuming there are no other scaling transforms added to the
! * {@code 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 {@code 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.
* <p>
* For more information on the user space coordinate system and the
! * rendering process, see the {@code Graphics2D} class comments.
* @see Graphics2D
* @author Jim Graham
*/
public class BasicStroke implements Stroke {
*** 159,192 ****
float dash[];
float dash_phase;
/**
! * Constructs a new <code>BasicStroke</code> with the specified
* attributes.
! * @param width the width of this <code>BasicStroke</code>. 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.
! * @param cap the decoration of the ends of a <code>BasicStroke</code>
* @param join the decoration applied where path segments meet
* @param miterlimit the limit to trim the miter join. The miterlimit
* must be greater than or equal to 1.0f.
* @param dash the array representing the dashing pattern
* @param dash_phase the offset to start the dashing pattern
! * @throws IllegalArgumentException if <code>width</code> is negative
! * @throws IllegalArgumentException if <code>cap</code> is not either
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
! * @throws IllegalArgumentException if <code>miterlimit</code> is less
! * than 1 and <code>join</code> is JOIN_MITER
! * @throws IllegalArgumentException if <code>join</code> is not
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
! * @throws IllegalArgumentException if <code>dash_phase</code>
! * is negative and <code>dash</code> is not <code>null</code>
* @throws IllegalArgumentException if the length of
! * <code>dash</code> is zero
* @throws IllegalArgumentException if dash lengths are all zero.
*/
@ConstructorProperties({ "lineWidth", "endCap", "lineJoin", "miterLimit", "dashArray", "dashPhase" })
public BasicStroke(float width, int cap, int join, float miterlimit,
float dash[], float dash_phase) {
--- 159,192 ----
float dash[];
float dash_phase;
/**
! * Constructs a new {@code BasicStroke} with the specified
* attributes.
! * @param width the width of this {@code 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.
! * @param cap the decoration of the ends of a {@code BasicStroke}
* @param join the decoration applied where path segments meet
* @param miterlimit the limit to trim the miter join. The miterlimit
* must be greater than or equal to 1.0f.
* @param dash the array representing the dashing pattern
* @param dash_phase the offset to start the dashing pattern
! * @throws IllegalArgumentException if {@code width} is negative
! * @throws IllegalArgumentException if {@code cap} is not either
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
! * @throws IllegalArgumentException if {@code miterlimit} is less
! * than 1 and {@code join} is JOIN_MITER
! * @throws IllegalArgumentException if {@code join} is not
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
! * @throws IllegalArgumentException if {@code dash_phase}
! * is negative and {@code dash} is not {@code null}
* @throws IllegalArgumentException if the length of
! * {@code dash} is zero
* @throws IllegalArgumentException if dash lengths are all zero.
*/
@ConstructorProperties({ "lineWidth", "endCap", "lineJoin", "miterLimit", "dashArray", "dashPhase" })
public BasicStroke(float width, int cap, int join, float miterlimit,
float dash[], float dash_phase) {
*** 229,301 ****
}
this.dash_phase = dash_phase;
}
/**
! * Constructs a solid <code>BasicStroke</code> with the specified
* attributes.
! * @param width the width of the <code>BasicStroke</code>
! * @param cap the decoration of the ends of a <code>BasicStroke</code>
* @param join the decoration applied where path segments meet
* @param miterlimit the limit to trim the miter join
! * @throws IllegalArgumentException if <code>width</code> is negative
! * @throws IllegalArgumentException if <code>cap</code> is not either
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
! * @throws IllegalArgumentException if <code>miterlimit</code> is less
! * than 1 and <code>join</code> is JOIN_MITER
! * @throws IllegalArgumentException if <code>join</code> is not
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
*/
public BasicStroke(float width, int cap, int join, float miterlimit) {
this(width, cap, join, miterlimit, null, 0.0f);
}
/**
! * Constructs a solid <code>BasicStroke</code> with the specified
! * attributes. The <code>miterlimit</code> parameter is
* unnecessary in cases where the default is allowable or the
* line joins are not specified as JOIN_MITER.
! * @param width the width of the <code>BasicStroke</code>
! * @param cap the decoration of the ends of a <code>BasicStroke</code>
* @param join the decoration applied where path segments meet
! * @throws IllegalArgumentException if <code>width</code> is negative
! * @throws IllegalArgumentException if <code>cap</code> is not either
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
! * @throws IllegalArgumentException if <code>join</code> is not
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
*/
public BasicStroke(float width, int cap, int join) {
this(width, cap, join, 10.0f, null, 0.0f);
}
/**
! * Constructs a solid <code>BasicStroke</code> with the specified
* line width and with default values for the cap and join
* styles.
! * @param width the width of the <code>BasicStroke</code>
! * @throws IllegalArgumentException if <code>width</code> is negative
*/
public BasicStroke(float width) {
this(width, CAP_SQUARE, JOIN_MITER, 10.0f, null, 0.0f);
}
/**
! * Constructs a new <code>BasicStroke</code> 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.
*/
public BasicStroke() {
this(1.0f, CAP_SQUARE, JOIN_MITER, 10.0f, null, 0.0f);
}
/**
! * Returns a <code>Shape</code> whose interior defines the
! * stroked outline of a specified <code>Shape</code>.
! * @param s the <code>Shape</code> boundary be stroked
! * @return the <code>Shape</code> of the stroked outline.
*/
public Shape createStrokedShape(Shape s) {
sun.java2d.pipe.RenderingEngine re =
sun.java2d.pipe.RenderingEngine.getInstance();
return re.createStrokedShape(s, width, cap, join, miterlimit,
--- 229,301 ----
}
this.dash_phase = dash_phase;
}
/**
! * Constructs a solid {@code BasicStroke} with the specified
* attributes.
! * @param width the width of the {@code BasicStroke}
! * @param cap the decoration of the ends of a {@code BasicStroke}
* @param join the decoration applied where path segments meet
* @param miterlimit the limit to trim the miter join
! * @throws IllegalArgumentException if {@code width} is negative
! * @throws IllegalArgumentException if {@code cap} is not either
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
! * @throws IllegalArgumentException if {@code miterlimit} is less
! * than 1 and {@code join} is JOIN_MITER
! * @throws IllegalArgumentException if {@code join} is not
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
*/
public BasicStroke(float width, int cap, int join, float miterlimit) {
this(width, cap, join, miterlimit, null, 0.0f);
}
/**
! * Constructs a solid {@code BasicStroke} with the specified
! * attributes. The {@code miterlimit} parameter is
* unnecessary in cases where the default is allowable or the
* line joins are not specified as JOIN_MITER.
! * @param width the width of the {@code BasicStroke}
! * @param cap the decoration of the ends of a {@code BasicStroke}
* @param join the decoration applied where path segments meet
! * @throws IllegalArgumentException if {@code width} is negative
! * @throws IllegalArgumentException if {@code cap} is not either
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
! * @throws IllegalArgumentException if {@code join} is not
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
*/
public BasicStroke(float width, int cap, int join) {
this(width, cap, join, 10.0f, null, 0.0f);
}
/**
! * Constructs a solid {@code BasicStroke} with the specified
* line width and with default values for the cap and join
* styles.
! * @param width the width of the {@code BasicStroke}
! * @throws IllegalArgumentException if {@code width} is negative
*/
public BasicStroke(float width) {
this(width, CAP_SQUARE, JOIN_MITER, 10.0f, null, 0.0f);
}
/**
! * Constructs a new {@code 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.
*/
public BasicStroke() {
this(1.0f, CAP_SQUARE, JOIN_MITER, 10.0f, null, 0.0f);
}
/**
! * Returns a {@code Shape} whose interior defines the
! * stroked outline of a specified {@code Shape}.
! * @param s the {@code Shape} boundary be stroked
! * @return the {@code Shape} of the stroked outline.
*/
public Shape createStrokedShape(Shape s) {
sun.java2d.pipe.RenderingEngine re =
sun.java2d.pipe.RenderingEngine.getInstance();
return re.createStrokedShape(s, width, cap, join, miterlimit,
*** 303,354 ****
}
/**
* Returns the line width. Line width is represented in user space,
* which is the default-coordinate space used by Java 2D. See the
! * <code>Graphics2D</code> class comments for more information on
* the user space coordinate system.
! * @return the line width of this <code>BasicStroke</code>.
* @see Graphics2D
*/
public float getLineWidth() {
return width;
}
/**
* Returns the end cap style.
! * @return the end cap style of this <code>BasicStroke</code> as one
! * of the static <code>int</code> values that define possible end cap
* styles.
*/
public int getEndCap() {
return cap;
}
/**
* Returns the line join style.
! * @return the line join style of the <code>BasicStroke</code> as one
! * of the static <code>int</code> values that define possible line
* join styles.
*/
public int getLineJoin() {
return join;
}
/**
* Returns the limit of miter joins.
! * @return the limit of miter joins of the <code>BasicStroke</code>.
*/
public float getMiterLimit() {
return miterlimit;
}
/**
* 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 <code>Shape</code>
* 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.
--- 303,354 ----
}
/**
* Returns the line width. Line width is represented in user space,
* which is the default-coordinate space used by Java 2D. See the
! * {@code Graphics2D} class comments for more information on
* the user space coordinate system.
! * @return the line width of this {@code BasicStroke}.
* @see Graphics2D
*/
public float getLineWidth() {
return width;
}
/**
* Returns the end cap style.
! * @return the end cap style of this {@code BasicStroke} as one
! * of the static {@code int} values that define possible end cap
* styles.
*/
public int getEndCap() {
return cap;
}
/**
* Returns the line join style.
! * @return the line join style of the {@code BasicStroke} as one
! * of the static {@code int} values that define possible line
* join styles.
*/
public int getLineJoin() {
return join;
}
/**
* Returns the limit of miter joins.
! * @return the limit of miter joins of the {@code BasicStroke}.
*/
public float getMiterLimit() {
return miterlimit;
}
/**
* 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 {@code 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.
*** 366,376 ****
* 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.
! * @return the dash phase as a <code>float</code> value.
*/
public float getDashPhase() {
return dash_phase;
}
--- 366,376 ----
* 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.
! * @return the dash phase as a {@code float} value.
*/
public float getDashPhase() {
return dash_phase;
}
*** 395,413 ****
/**
* Returns true if this BasicStroke represents the same
* stroking operation as the given argument.
*/
/**
! * Tests if a specified object is equal to this <code>BasicStroke</code>
! * by first testing if it is a <code>BasicStroke</code> and then comparing
* its width, join, cap, miter limit, dash, and dash phase attributes with
! * those of this <code>BasicStroke</code>.
* @param obj the specified object to compare to this
! * <code>BasicStroke</code>
! * @return <code>true</code> if the width, join, cap, miter limit, dash, and
* dash phase are the same for both objects;
! * <code>false</code> otherwise.
*/
public boolean equals(Object obj) {
if (!(obj instanceof BasicStroke)) {
return false;
}
--- 395,413 ----
/**
* Returns true if this BasicStroke represents the same
* stroking operation as the given argument.
*/
/**
! * Tests if a specified object is equal to this {@code BasicStroke}
! * by first testing if it is a {@code BasicStroke} and then comparing
* its width, join, cap, miter limit, dash, and dash phase attributes with
! * those of this {@code BasicStroke}.
* @param obj the specified object to compare to this
! * {@code BasicStroke}
! * @return {@code true} if the width, join, cap, miter limit, dash, and
* dash phase are the same for both objects;
! * {@code false} otherwise.
*/
public boolean equals(Object obj) {
if (!(obj instanceof BasicStroke)) {
return false;
}
< prev index next >