java.awt

Class BasicStroke

Implemented Interfaces:
Stroke

public class BasicStroke
extends Object
implements Stroke

STUB CLASS ONLY

Field Summary

static int
CAP_BUTT
static int
CAP_ROUND
static int
CAP_SQUARE
static int
JOIN_BEVEL
static int
JOIN_MITER
static int
JOIN_ROUND

Constructor Summary

BasicStroke()
Creates a basic stroke.
BasicStroke(float width)
Creates a basic stroke.
BasicStroke(float width, int cap, int join)
Creates a basic stroke.
BasicStroke(float width, int cap, int join, float miterlimit)
Creates a basic stroke.
BasicStroke(float width, int cap, int join, float miterlimit, float[] dash, float dashPhase)
Creates a basic stroke.

Method Summary

Shape
createStrokedShape(Shape s)
Returns a shape which outlines the boundary of the given shape, in effect converting the infinitely thin line into a new shape.
boolean
equals(Object o)
Returns true if the given Object is an instance of BasicStroke and the width, cap, join, limit, dash array and phase are all equal.
float[]
getDashArray()
float
getDashPhase()
int
getEndCap()
int
getLineJoin()
float
getLineWidth()
float
getMiterLimit()
int
hashCode()
Returns the hash code for this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CAP_BUTT

public static final int CAP_BUTT
Field Value:
0

CAP_ROUND

public static final int CAP_ROUND
Field Value:
1

CAP_SQUARE

public static final int CAP_SQUARE
Field Value:
2

JOIN_BEVEL

public static final int JOIN_BEVEL
Field Value:
2

JOIN_MITER

public static final int JOIN_MITER
Field Value:
0

JOIN_ROUND

public static final int JOIN_ROUND
Field Value:
1

Constructor Details

BasicStroke

public BasicStroke()
Creates a basic stroke.

BasicStroke

public BasicStroke(float width)
Creates a basic stroke.
Parameters:
width - The width of the BasicStroke.
Throws:
IllegalArgumentException - If width is negative.

BasicStroke

public BasicStroke(float width,
                   int cap,
                   int join)
Creates a basic stroke.
Parameters:
width - The width of the BasicStroke. May not be nehative.
cap - May be either CAP_BUTT, CAP_ROUND or CAP_SQUARE.
join - May be either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER.
Throws:
IllegalArgumentException - If one input parameter doesn't meet its needs.
IllegalArgumentException - FIXME

BasicStroke

public BasicStroke(float width,
                   int cap,
                   int join,
                   float miterlimit)
Creates a basic stroke.
Parameters:
width - The width of the BasicStroke. May not be negative .
cap - May be either CAP_BUTT, CAP_ROUND or CAP_SQUARE.
join - May be either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER.
miterlimit - the limit to trim the miter join. The miterlimit must be greater than or equal to 1.0f.
Throws:
IllegalArgumentException - If one input parameter doesn't meet its needs.

BasicStroke

public BasicStroke(float width,
                   int cap,
                   int join,
                   float miterlimit,
                   float[] dash,
                   float dashPhase)
Creates a basic stroke.
Parameters:
width - May not be negative .
cap - May be either CAP_BUTT, CAP_ROUND or CAP_SQUARE.
join - May be either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER.
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. There must be at least one non-zero entry.
dashPhase - is negative and dash is not null.
Throws:
IllegalArgumentException - If one input parameter doesn't meet its needs.

Method Details

createStrokedShape

public Shape createStrokedShape(Shape s)
Returns a shape which outlines the boundary of the given shape, in effect converting the infinitely thin line into a new shape.
Specified by:
createStrokedShape in interface Stroke
Parameters:
s - the shape to stroke
Returns:
the stroked outline shape

equals

public boolean equals(Object o)
Returns true if the given Object is an instance of BasicStroke and the width, cap, join, limit, dash array and phase are all equal.
Overrides:
equals in interface Object

getDashArray

public float[] getDashArray()

getDashPhase

public float getDashPhase()

getEndCap

public int getEndCap()

getLineJoin

public int getLineJoin()

getLineWidth

public float getLineWidth()

getMiterLimit

public float getMiterLimit()

hashCode

public int hashCode()
Returns the hash code for this object. The hash is calculated by xoring the hash, cap, join, limit, dash array and phase values (converted to int first with Float.floatToIntBits() if the value is a float).
Overrides:
hashCode in interface Object

BasicStroke.java -- Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.