DXPen Class

A pen.

Declaration

public class DXPen extends JavaObject implements IEquatable<DXPen>, IDisposable

Implements

com.devexpress.system.IEquatable<com.devexpress.drawing.DXPen>

com.devexpress.system.IDisposable

Inherited Members

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.JavaObject

DXPen

Constructors

DXPen(Color color, float thickness, DXLineCap lineCap) Constructor

Initializes a new instance of the DXPen class with specified settings.

Declaration

public DXPen(Color color, float thickness, DXLineCap lineCap)

Parameters

Name	Type	Description
color	Color	The pen color.
thickness	float	The pen thickness.
lineCap	DXLineCap	The line cap.

DXPen(Color color, float width) Constructor

Initializes a new instance of the DXPen class with specified settings.

Declaration

public DXPen(Color color, float width)

Parameters

Name	Type	Description
color	Color	The pen color.
width	float	The pen width.

DXPen(Color color) Constructor

Initializes a new instance of the DXPen class with specified settings.

Declaration

public DXPen(Color color)

Parameters

Name	Type	Description
color	Color	The pen color.

DXPen(DXBrush brush, float width) Constructor

Initializes a new instance of the DXPen class with specified settings.

Declaration

public DXPen(DXBrush brush, float width)

Parameters

Name	Type	Description
brush	DXBrush	The pen brush.
width	float	The pen width.

DXPen(DXBrush brush) Constructor

Initializes a new instance of the DXPen class with specified settings.

Declaration

public DXPen(DXBrush brush)

Parameters

Name	Type	Description
brush	DXBrush	The pen brush.

Methods

clone() Method

Creates a copy of this pen.

Declaration

public DXPen clone()

Returns

Type	Description
DXPen	The cloned DXPen object.

close() Method

Closes this pen.

Declaration

public void close()

equals(DXPen other) Method

Checks whether this pen equals the specified pen.

Declaration

public boolean equals(DXPen other)

Parameters

Name	Type	Description
other	DXPen	The pen to compare.

Returns

Type	Description
boolean	true if this pen equals the specified pen; otherwise, false.

equals(Object obj) Method

Checks whether this pen equals the specified pen.

Declaration

public boolean equals(Object obj)

Parameters

Name	Type	Description
obj	Object	The pen to compare.

Returns

Type	Description
boolean	true if this pen equals the specified pen; otherwise, false.

getBrush() Method

Returns the brush.

Declaration

public DXBrush getBrush()

Returns

Type	Description
DXBrush	The pen brush.

getColor() Method

Returns the color.

Declaration

public Color getColor()

Returns

Type	Description
Color	The pen color.

getCustomEndCap() Method

Returns the custom end cap.

Declaration

public DXCustomLineCapBase getCustomEndCap()

Returns

Type	Description
DXCustomLineCapBase	The custom end cap.

getCustomStartCap() Method

Returns the custom start cap.

Declaration

public DXCustomLineCapBase getCustomStartCap()

Returns

Type	Description
DXCustomLineCapBase	The custom start cap.

getDashCap() Method

Returns the dash cap.

Declaration

public DXDashCap getDashCap()

Returns

Type	Description
DXDashCap	The dash cap.

getDashOffset() Method

Returns the dash offset.

Declaration

public float getDashOffset()

Returns

Type	Description
float	The dash offset.

getDashPattern() Method

Returns the dash pattern.

Declaration

public float[] getDashPattern()

Returns

Type	Description
float[]	The dash pattern.

getDashStyle() Method

Returns the dash style.

Declaration

public DXDashStyle getDashStyle()

Returns

Type	Description
DXDashStyle	The dash style.

getEndCap() Method

Returns the end cap.

Declaration

public DXLineCap getEndCap()

Returns

Type	Description
DXLineCap	The end cap.

getLineJoin() Method

Returns the line join.

Declaration

public DXLineJoin getLineJoin()

Returns

Type	Description
DXLineJoin	The line join.

getMiterLimit() Method

Returns the miter limit.

Declaration

public float getMiterLimit()

Returns

Type	Description
float	The miter limit.

getPenType() Method

Returns the pen type.

Declaration

public DXPenType getPenType()

Returns

Type	Description
DXPenType	The pen type.

getStartCap() Method

Returns the start cap.

Declaration

public DXLineCap getStartCap()

Returns

Type	Description
DXLineCap	The start cap.

getWidth() Method

Returns the width.

Declaration

public float getWidth()

Returns

Type	Description
float	The pen width.

hashCode() Method

Returns a hash code value for this object.

Declaration

public int hashCode()

Returns

Type	Description
int	The hash code.

setBrush(DXBrush value) Method

Specifies the brush.

Declaration

public void setBrush(DXBrush value)

Parameters

Name	Type	Description
value	DXBrush	The pen brush.

setColor(Color value) Method

Specifies the color.

Declaration

public void setColor(Color value)

Parameters

Name	Type	Description
value	Color	The pen color.

setCustomEndCap(DXCustomLineCapBase value) Method

Specifies the custom end cap.

Declaration

public void setCustomEndCap(DXCustomLineCapBase value)

Parameters

Name	Type	Description
value	DXCustomLineCapBase	The custom end cap.

setCustomStartCap(DXCustomLineCapBase value) Method

Specifies the custom start cap.

Declaration

public void setCustomStartCap(DXCustomLineCapBase value)

Parameters

Name	Type	Description
value	DXCustomLineCapBase	The custom start cap.

setDashCap(DXDashCap value) Method

Specifies the dash cap.

Declaration

public void setDashCap(DXDashCap value)

Parameters

Name	Type	Description
value	DXDashCap	The dash cap.

setDashOffset(float value) Method

Specifies the dash offset.

Declaration

public void setDashOffset(float value)

Parameters

Name	Type	Description
value	float	The dash offset.

setDashPattern(float[] value) Method

Specifies the dash pattern.

Declaration

public void setDashPattern(float[] value)

Parameters

Name	Type	Description
value	float[]	The dash pattern.

setDashStyle(DXDashStyle value) Method

Specifies the dash style.

Declaration

public void setDashStyle(DXDashStyle value)

Parameters

Name	Type	Description
value	DXDashStyle	The dash style.

setEndCap(DXLineCap value) Method

Specifies the end cap.

Declaration

public void setEndCap(DXLineCap value)

Parameters

Name	Type	Description
value	DXLineCap	The end cap.

setLineJoin(DXLineJoin value) Method

Specifies the line join.

Declaration

public void setLineJoin(DXLineJoin value)

Parameters

Name	Type	Description
value	DXLineJoin	The line join.

setMiterLimit(float value) Method

Specifies the miter limit.

Declaration

public void setMiterLimit(float value)

Parameters

Name	Type	Description
value	float	The miter limit.

setStartCap(DXLineCap value) Method

Specifies the start cap.

Declaration

public void setStartCap(DXLineCap value)

Parameters

Name	Type	Description
value	DXLineCap	The start cap.

setWidth(float value) Method

Specifies the width.

Declaration

public void setWidth(float value)

Parameters

Name	Type	Description
value	float	The pen width.