Module imagingbook.common

Package imagingbook.common.ij.overlay

Class ColoredStroke

java.lang.Object

imagingbook.common.ij.overlay.ColoredStroke

All Implemented Interfaces:

Cloneable

public class ColoredStroke
extends Object
implements Cloneable

This is basically a mirror class of BasicStroke adding line and fill colors. Instances of this class are cloneable and mutable, setters for all fields are provided, i.e., strokes can be easily customized. Use getBasicStroke() to convert to an AWT BasicStroke instance.

Version:

2021/10/26

Field Summary

Fields

Modifier and Type	Field	Description
static final Color	DefaultFillColor
static final Color	DefaultStrokeColor

Constructor Summary

Constructors

Constructor	Description
ColoredStroke()
ColoredStroke(double lineWidth, int endCap, int lineJoin, double miterLimit, float[] dashArray, double dashPhase, Color strokeColor, Color fillColor)
ColoredStroke(double lineWidth, Color strokeColor)
ColoredStroke(double lineWidth, Color strokeColor, double dashLength)
ColoredStroke(double lineWidth, Color strokeColor, Color fillColor)
ColoredStroke(BasicStroke bs)

Method Summary

Modifier and Type	Method	Description
ColoredStroke	clone()
BasicStroke	getBasicStroke()	Returns a AWT BasicStroke instance for the current state of this stroke (with no color information).
Color	getFillColor()
Color	getStrokeColor()
void	setDash(double... dashes)	Convenience method to set (unset) the dash pattern Usage examples:
void	setDashArray(float[] dashArray)
void	setDashPhase(double dashPhase)
void	setEndCap(int endCap)
void	setFillColor(Color fillColor)
void	setLineJoin(int lineJoin)
void	setLineWidth(double lineWidth)
void	setMiterLimit(double miterLimit)
void	setStrokeColor(Color strokeColor)

Methods inherited from class java.lang.Object

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

Field Details

DefaultStrokeColor

public static final Color DefaultStrokeColor

DefaultFillColor

public static final Color DefaultFillColor

Constructor Details

ColoredStroke

public ColoredStroke()

ColoredStroke

public ColoredStroke(BasicStroke bs)

ColoredStroke

public ColoredStroke(double lineWidth,
 int endCap,
 int lineJoin,
 double miterLimit,
 float[] dashArray,
 double dashPhase,
 Color strokeColor,
 Color fillColor)

ColoredStroke

public ColoredStroke(double lineWidth,
 Color strokeColor,
 double dashLength)

ColoredStroke

public ColoredStroke(double lineWidth,
 Color strokeColor)

ColoredStroke

public ColoredStroke(double lineWidth,
 Color strokeColor,
 Color fillColor)

Method Details

clone

public ColoredStroke clone()

Overrides:

clone in class Object

setLineWidth

public void setLineWidth(double lineWidth)

setEndCap

public void setEndCap(int endCap)

setLineJoin

public void setLineJoin(int lineJoin)

setMiterLimit

public void setMiterLimit(double miterLimit)

setDashArray

public void setDashArray(float[] dashArray)

setDashPhase

public void setDashPhase(double dashPhase)

setStrokeColor

public void setStrokeColor(Color strokeColor)

setFillColor

public void setFillColor(Color fillColor)

setDash

public void setDash(double... dashes)

Convenience method to set (unset) the dash pattern Usage examples:

 setDash(6);      // = setDashArray(new float[] {6})
 setDash(6, 4);   // = setDashArray(new float[] {6, 4})
 setDash();       // = setDashArray(null)
 

Parameters:

dashes - a (possibly empty) sequence of dash lengths

See Also:

• BasicStroke
• BasicStroke.getDashArray()

getStrokeColor

public Color getStrokeColor()

getFillColor

public Color getFillColor()

getBasicStroke

public BasicStroke getBasicStroke()

Returns a AWT BasicStroke instance for the current state of this stroke (with no color information).

Returns:

a AWT BasicStroke