CustomLineCap

Inheritance: java.lang.Object

public class CustomLineCap

Encapsulates a custom user-defined line cap.

Constructors

Constructor	Description
CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath)	Initializes a new instance of the CustomLineCap class with the specified outline and fill.
CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath, int baseCap)	Initializes a new instance of the CustomLineCap class from the specified existing LineCap enumeration with the specified outline and fill.
CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath, int baseCap, float baseInset)	Initializes a new instance of the CustomLineCap class from the specified existing LineCap enumeration with the specified outline, fill, and inset.

Methods

Method	Description
getFillPath()	Gets the object that defines the fill for the custom cap.
setFillPath(GraphicsPath value)	Sets the object that defines the fill for the custom cap.
getStrokePath()	Gets the object that defines the outline of the custom cap.
setStrokePath(GraphicsPath value)	Sets the object that defines the outline of the custom cap.
getStrokeJoin()	Gets the LineJoin enumeration that determines how lines that compose this CustomLineCap object are joined.
setStrokeJoin(int value)	Sets the LineJoin enumeration that determines how lines that compose this CustomLineCap object are joined.
getBaseCap()	Gets the LineCap enumeration on which this CustomLineCap is based.
setBaseCap(int value)	Sets the LineCap enumeration on which this CustomLineCap is based.
getBaseInset()	Gets the distance between the cap and the line.
setBaseInset(float value)	Sets the distance between the cap and the line.
getWidthScale()	Gets the amount by which to scale this CustomLineCap Class object with respect to the width of the System.Drawing.Pen object.
setWidthScale(float value)	Sets the amount by which to scale this CustomLineCap Class object with respect to the width of the System.Drawing.Pen object.
setStrokeCaps(int startCap, int endCap)	Sets the caps used to start and end lines that make up this custom cap.
getStrokeCaps(int[] startCap, int[] endCap)	Gets the caps used to start and end lines that make up this custom cap.
equals(Object o)	Check if objects are equal.
hashCode()	Get hash code of the current object.

CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath)

public CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath)

Initializes a new instance of the CustomLineCap class with the specified outline and fill.

Parameters:

Parameter	Type	Description
fillPath	GraphicsPath	A GraphicsPath object that defines the fill for the custom cap.
strokePath	GraphicsPath	A GraphicsPath object that defines the outline of the custom cap.

CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath, int baseCap)

public CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath, int baseCap)

Initializes a new instance of the CustomLineCap class from the specified existing LineCap enumeration with the specified outline and fill.

Parameters:

Parameter	Type	Description
fillPath	GraphicsPath	A GraphicsPath object that defines the fill for the custom cap.
strokePath	GraphicsPath	A GraphicsPath object that defines the outline of the custom cap.
baseCap	int	The line cap from which to create the custom cap.

CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath, int baseCap, float baseInset)

public CustomLineCap(GraphicsPath fillPath, GraphicsPath strokePath, int baseCap, float baseInset)

Initializes a new instance of the CustomLineCap class from the specified existing LineCap enumeration with the specified outline, fill, and inset.

Parameters:

Parameter	Type	Description
fillPath	GraphicsPath	A GraphicsPath object that defines the fill for the custom cap.
strokePath	GraphicsPath	A GraphicsPath object that defines the outline of the custom cap.
baseCap	int	The line cap from which to create the custom cap.
baseInset	float	The distance between the cap and the line.

getFillPath()

public GraphicsPath getFillPath()

Gets the object that defines the fill for the custom cap.

Returns: GraphicsPath - The object that defines the fill for the custom cap.

setFillPath(GraphicsPath value)

public void setFillPath(GraphicsPath value)

Sets the object that defines the fill for the custom cap.

Parameters:

Parameter	Type	Description
value	GraphicsPath	The object that defines the fill for the custom cap.

getStrokePath()

public GraphicsPath getStrokePath()

Gets the object that defines the outline of the custom cap.

Returns: GraphicsPath - The object that defines the outline of the custom cap.

setStrokePath(GraphicsPath value)

public void setStrokePath(GraphicsPath value)

Sets the object that defines the outline of the custom cap.

Parameters:

Parameter	Type	Description
value	GraphicsPath	The object that defines the outline of the custom cap.

getStrokeJoin()

public int getStrokeJoin()

Gets the LineJoin enumeration that determines how lines that compose this CustomLineCap object are joined.

Returns: int - The LineJoin enumeration this CustomLineCap object uses to join lines.

setStrokeJoin(int value)

public void setStrokeJoin(int value)

Sets the LineJoin enumeration that determines how lines that compose this CustomLineCap object are joined.

Parameters:

Parameter	Type	Description
value	int	The LineJoin enumeration this CustomLineCap object uses to join lines.

getBaseCap()

public int getBaseCap()

Gets the LineCap enumeration on which this CustomLineCap is based.

Returns: int - The LineCap enumeration on which this CustomLineCap is based.

setBaseCap(int value)

public void setBaseCap(int value)

Sets the LineCap enumeration on which this CustomLineCap is based.

Parameters:

Parameter	Type	Description
value	int	The LineCap enumeration on which this CustomLineCap is based.

getBaseInset()

public float getBaseInset()

Gets the distance between the cap and the line.

Returns: float - The distance between the beginning of the cap and the end of the line.

setBaseInset(float value)

public void setBaseInset(float value)

Sets the distance between the cap and the line.

Parameters:

Parameter	Type	Description
value	float	The distance between the beginning of the cap and the end of the line.

getWidthScale()

public float getWidthScale()

Gets the amount by which to scale this CustomLineCap Class object with respect to the width of the System.Drawing.Pen object.

Returns: float - The amount by which to scale the cap.

setWidthScale(float value)

public void setWidthScale(float value)

Sets the amount by which to scale this CustomLineCap Class object with respect to the width of the System.Drawing.Pen object.

Parameters:

Parameter	Type	Description
value	float	The amount by which to scale the cap.

setStrokeCaps(int startCap, int endCap)

public void setStrokeCaps(int startCap, int endCap)

Sets the caps used to start and end lines that make up this custom cap.

Parameters:

Parameter	Type	Description
startCap	int	The LineCap enumeration used at the beginning of a line within this cap.
endCap	int	The LineCap enumeration used at the end of a line within this cap.

getStrokeCaps(int[] startCap, int[] endCap)

public void getStrokeCaps(int[] startCap, int[] endCap)

Gets the caps used to start and end lines that make up this custom cap.

Parameters:

Parameter	Type	Description
startCap	int[]	The LineCap enumeration used at the beginning of a line within this cap.
endCap	int[]	The LineCap enumeration used at the end of a line within this cap.

equals(Object o)

public boolean equals(Object o)

Check if objects are equal.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The other object.

Returns: boolean - The equality comparison result.

hashCode()

public int hashCode()

Get hash code of the current object.

Returns: int - The hash code.