Pen (Aspose.Drawing for Java 25.10 API Documentation)

java.lang.Object
- com.aspose.drawing.Pen

All Implemented Interfaces:

com.aspose.ms.System.IDisposable
```
public class Pen
extends Object
implements com.aspose.ms.System.IDisposable
```
Defines an object used to draw lines and curves.

Constructor Summary

Constructors
Constructor and Description
`Pen(Brush brush)` Initializes a new instance of the `Pen` class with the specified `Brush`(`Pen.getBrush()`/`Pen.setBrush(Brush)`).
`Pen(Brush brush, float width)` Initializes a new instance of the Pen class with the specified Brush and Width.
`Pen(Color color)` Initializes a new instance of the `Pen` class with the specified `Color`(`Pen.getColor()`/`Pen.setColor(Color)`).
`Pen(Color color, float width)` Initializes a new instance of the Pen class with the specified Color and Width properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`deepClone()` Creates an exact copy of this `Pen`.
`void`	`dispose()` Releases all resources used by this Pen.
`int`	`getAlignment()` Gets or sets the alignment for this `Pen`.
`Brush`	`getBrush()` Gets or sets the Brush that determines attributes of this `Pen`.
`Color`	`getColor()` Gets or sets the color of this `Pen`.
`float[]`	`getCompoundArray()` Gets or sets an array of values that specifies a compound pen.
`CustomLineCap`	`getCustomEndCap()` Gets or sets a custom cap to use at the end of lines drawn with this `Pen`.
`CustomLineCap`	`getCustomStartCap()` Gets or sets a custom cap to use at the beginning of lines drawn with this `Pen`.
`int`	`getDashCap()` Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this `Pen`.
`float`	`getDashOffset()` Gets or sets the distance from the start of a line to the beginning of a dash pattern.
`float[]`	`getDashPattern()` Gets or sets an array of custom dashes and spaces.
`int`	`getDashStyle()` Gets or sets the style used for dashed lines drawn with this `Pen`.
`int`	`getEndCap()` Gets or sets the cap style used at the end of lines drawn with this Pen.
`int`	`getLineJoin()` Gets or sets the join style for the ends of two consecutive lines drawn with this Pen.
`float`	`getMiterLimit()` Gets or sets the limit of the thickness of the join on a mitered corner.
`int`	`getPenType()` Gets the style of lines drawn with this Pen.
`int`	`getStartCap()` Gets or sets the cap style used at the beginning of lines drawn with this Pen.
`Matrix`	`getTransform()` Gets or sets a copy of the geometric transformation for this `Pen`.
`float`	`getWidth()` Gets or sets the width of this Pen, in units of the Graphics object used for drawing.
`void`	`multiplyTransform(Matrix matrix)` Multiplies the transformation matrix for this `Pen` by the specified `Matrix`.
`void`	`multiplyTransform(Matrix matrix, int order)` Multiplies the transformation matrix for this `Pen` by the specified `Matrix` in the specified order.
`void`	`resetTransform()` Resets the geometric transformation matrix for this `Pen` to identity.
`void`	`rotateTransform(float angle)` Rotates the local geometric transformation by the specified angle.
`void`	`rotateTransform(float angle, int order)` Rotates the local geometric transformation by the specified angle in the specified order.
`void`	`scaleTransform(float sx, float sy)` Scales the local geometric transformation by the specified factors.
`void`	`scaleTransform(float sx, float sy, int order)` Scales the local geometric transformation by the specified factors in the specified order.
`void`	`setAlignment(int value)` Gets or sets the alignment for this `Pen`.
`void`	`setBrush(Brush value)` Gets or sets the Brush that determines attributes of this `Pen`.
`void`	`setColor(Color value)` Gets or sets the color of this `Pen`.
`void`	`setCompoundArray(float[] value)` Gets or sets an array of values that specifies a compound pen.
`void`	`setCustomEndCap(CustomLineCap value)` Gets or sets a custom cap to use at the end of lines drawn with this `Pen`.
`void`	`setCustomStartCap(CustomLineCap value)` Gets or sets a custom cap to use at the beginning of lines drawn with this `Pen`.
`void`	`setDashCap(int value)` Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this `Pen`.
`void`	`setDashOffset(float value)` Gets or sets the distance from the start of a line to the beginning of a dash pattern.
`void`	`setDashPattern(float[] value)` Gets or sets an array of custom dashes and spaces.
`void`	`setDashStyle(int value)` Gets or sets the style used for dashed lines drawn with this `Pen`.
`void`	`setEndCap(int value)` Gets or sets the cap style used at the end of lines drawn with this Pen.
`void`	`setLineCap(int startCap, int endCap, int dashCap)` Sets the values that determine the style of cap used to end lines drawn by this `Pen`.
`void`	`setLineJoin(int value)` Gets or sets the join style for the ends of two consecutive lines drawn with this Pen.
`void`	`setMiterLimit(float value)` Gets or sets the limit of the thickness of the join on a mitered corner.
`void`	`setStartCap(int value)` Gets or sets the cap style used at the beginning of lines drawn with this Pen.
`void`	`setTransform(Matrix value)` Gets or sets a copy of the geometric transformation for this `Pen`.
`void`	`setWidth(float value)` Gets or sets the width of this Pen, in units of the Graphics object used for drawing.
`void`	`translateTransform(float dx, float dy)` Translates the local geometric transformation by the specified dimensions.
`void`	`translateTransform(float dx, float dy, int order)` Translates the local geometric transformation by the specified dimensions in the specified order.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Pen
```
public Pen(Color color)
```
    Initializes a new instance of the Pen class with the specified Color(Pen.getColor()/Pen.setColor(Color)).
    
    Parameters:
    
    color - A Color(Pen.getColor()/Pen.setColor(Color)) that determines the fill properties of this Pen.
  - Pen
```
public Pen(Brush brush,
           float width)
```
    Initializes a new instance of the Pen class with the specified Brush and Width.
    
    Parameters:
    
    brush - A Brush that determines the characteristics of this Pen.
    
    width - The width of the new Pen.
  - Pen
```
public Pen(Brush brush)
```
    Initializes a new instance of the Pen class with the specified Brush(Pen.getBrush()/Pen.setBrush(Brush)).
    
    Parameters:
    
    brush - A Brush(Pen.getBrush()/Pen.setBrush(Brush)) that determines the fill properties of this Pen.
  - Pen
```
public Pen(Color color,
           float width)
```
    Initializes a new instance of the Pen class with the specified Color and Width properties.
    
    Parameters:
    
    color - A Color structure that indicates the color of this Pen.
    
    width - A value indicating the width of this Pen.
- Method Detail
  - getColor
```
public final Color getColor()
```
    Gets or sets the color of this Pen.
    Value: A Color(Pen.getColor()/Pen.setColor(Color)) structure that represents the color of this Pen.
  - setColor
```
public final void setColor(Color value)
```
    Gets or sets the color of this Pen.
    Value: A Color(Pen.getColor()/Pen.setColor(Color)) structure that represents the color of this Pen.
  - getBrush
```
public final Brush getBrush()
```
    Gets or sets the Brush that determines attributes of this Pen.
  - setBrush
```
public final void setBrush(Brush value)
```
    Gets or sets the Brush that determines attributes of this Pen.
  - getCompoundArray
```
public final float[] getCompoundArray()
```
    Gets or sets an array of values that specifies a compound pen. A compound pen draws a compound line made up of parallel lines and spaces.
    
    Returns:
    
    An array of real numbers that specifies the compound array. The elements in the array must be in increasing order, not less than 0, and not greater than 1.
  - setCompoundArray
```
public final void setCompoundArray(float[] value)
```
    Gets or sets an array of values that specifies a compound pen. A compound pen draws a compound line made up of parallel lines and spaces.
  - getWidth
```
public final float getWidth()
```
    Gets or sets the width of this Pen, in units of the Graphics object used for drawing.
  - setWidth
```
public final void setWidth(float value)
```
    Gets or sets the width of this Pen, in units of the Graphics object used for drawing.
  - getStartCap
```
public final int getStartCap()
```
    Gets or sets the cap style used at the beginning of lines drawn with this Pen.
  - setStartCap
```
public final void setStartCap(int value)
```
    Gets or sets the cap style used at the beginning of lines drawn with this Pen.
  - getEndCap
```
public final int getEndCap()
```
    Gets or sets the cap style used at the end of lines drawn with this Pen.
  - setEndCap
```
public final void setEndCap(int value)
```
    Gets or sets the cap style used at the end of lines drawn with this Pen.
  - getLineJoin
```
public final int getLineJoin()
```
    Gets or sets the join style for the ends of two consecutive lines drawn with this Pen.
    At the moment Miter join actually works as MiterClipped.
  - setLineJoin
```
public final void setLineJoin(int value)
```
    Gets or sets the join style for the ends of two consecutive lines drawn with this Pen.
    At the moment Miter join actually works as MiterClipped.
  - getMiterLimit
```
public final float getMiterLimit()
```
    Gets or sets the limit of the thickness of the join on a mitered corner.
  - setMiterLimit
```
public final void setMiterLimit(float value)
```
    Gets or sets the limit of the thickness of the join on a mitered corner.
  - getAlignment
```
public final int getAlignment()
```
    Gets or sets the alignment for this Pen.
    
    Returns:
    
    A PenAlignment that represents the alignment for this Pen.
  - setAlignment
```
public final void setAlignment(int value)
```
    Gets or sets the alignment for this Pen.
  - getTransform
```
public final Matrix getTransform()
```
    Gets or sets a copy of the geometric transformation for this Pen.
    Value: A copy of the Matrix that represents the geometric transformation for this Pen.
  - setTransform
```
public final void setTransform(Matrix value)
```
    Gets or sets a copy of the geometric transformation for this Pen.
    Value: A copy of the Matrix that represents the geometric transformation for this Pen.
  - getCustomStartCap
```
public final CustomLineCap getCustomStartCap()
```
    Gets or sets a custom cap to use at the beginning of lines drawn with this Pen.
    
    Returns:
    
    A CustomLineCap that represents the cap used at the beginning of lines drawn with this Pen.
  - setCustomStartCap
```
public final void setCustomStartCap(CustomLineCap value)
```
    Gets or sets a custom cap to use at the beginning of lines drawn with this Pen.
  - getCustomEndCap
```
public final CustomLineCap getCustomEndCap()
```
    Gets or sets a custom cap to use at the end of lines drawn with this Pen.
    
    Returns:
    
    A CustomLineCap that represents the cap used at the end of lines drawn with this Pen.
  - setCustomEndCap
```
public final void setCustomEndCap(CustomLineCap value)
```
    Gets or sets a custom cap to use at the end of lines drawn with this Pen.
  - getDashCap
```
public final int getDashCap()
```
    Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this Pen.
    
    Returns:
    
    One of the DashCap(Pen.getDashCap()/Pen.setDashCap(int)) values that represents the cap style used at the beginning and end of the dashes that make up dashed lines drawn with this Pen.
  - setDashCap
```
public final void setDashCap(int value)
```
    Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this Pen.
  - getDashOffset
```
public final float getDashOffset()
```
    Gets or sets the distance from the start of a line to the beginning of a dash pattern.
    
    Returns:
    
    The distance from the start of a line to the beginning of a dash pattern.
  - setDashOffset
```
public final void setDashOffset(float value)
```
    Gets or sets the distance from the start of a line to the beginning of a dash pattern.
  - getDashPattern
```
public final float[] getDashPattern()
```
    Gets or sets an array of custom dashes and spaces.
    
    Returns:
    
    An array of real numbers that specifies the lengths of alternating dashes and spaces in dashed lines.
  - setDashPattern
```
public final void setDashPattern(float[] value)
```
    Gets or sets an array of custom dashes and spaces.
  - getDashStyle
```
public final int getDashStyle()
```
    Gets or sets the style used for dashed lines drawn with this Pen.
    
    Returns:
    
    A DashStyle(Pen.getDashStyle()/Pen.setDashStyle(int)) that represents the style used for dashed lines drawn with this Pen.
  - setDashStyle
```
public final void setDashStyle(int value)
```
    Gets or sets the style used for dashed lines drawn with this Pen.
  - getPenType
```
public final int getPenType()
```
    Gets the style of lines drawn with this Pen.
    Value: A PenType(Pen.getPenType()) enumeration that specifies the style of lines drawn with this Pen.
  - dispose
```
public final void dispose()
```
    Releases all resources used by this Pen.
    This method actually does nothing. It's just for compatibility with System.Drawing API.
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
  - deepClone
```
public final Object deepClone()
```
    Creates an exact copy of this Pen.
    
    Returns:
    
    An Object that can be cast to a Pen.
    
    Throws:
    
    com.aspose.ms.System.NotImplementedException - Method not implemented.
  - setLineCap
```
public final void setLineCap(int startCap,
                             int endCap,
                             int dashCap)
```
    Sets the values that determine the style of cap used to end lines drawn by this Pen.
    
    Parameters:
    
    startCap - A LineCap that represents the cap style to use at the beginning of lines drawn with this Pen.
    
    endCap - A LineCap that represents the cap style to use at the end of lines drawn with this Pen.
    
    dashCap - A LineCap that represents the cap style to use at the beginning or end of dashed lines drawn with this Pen.
  - scaleTransform
```
public final void scaleTransform(float sx,
                                 float sy)
```
    Scales the local geometric transformation by the specified factors. This method prepends the scaling matrix to the transformation.
    
    Parameters:
    
    sx - The factor by which to scale the transformation in the x-axis direction.
    
    sy - The factor by which to scale the transformation in the y-axis direction.
  - scaleTransform
```
public final void scaleTransform(float sx,
                                 float sy,
                                 int order)
```
    Scales the local geometric transformation by the specified factors in the specified order.
    
    Parameters:
    
    sx - The factor by which to scale the transformation in the x-axis direction.
    
    sy - The factor by which to scale the transformation in the y-axis direction.
    
    order - A MatrixOrder that specifies whether to append or prepend the scaling matrix.
  - translateTransform
```
public final void translateTransform(float dx,
                                     float dy)
```
    Translates the local geometric transformation by the specified dimensions. This method prepends the translation to the transformation.
    
    Parameters:
    
    dx - The value of the translation in x.
    
    dy - The value of the translation in y.
  - translateTransform
```
public final void translateTransform(float dx,
                                     float dy,
                                     int order)
```
    Translates the local geometric transformation by the specified dimensions in the specified order.
    
    Parameters:
    
    dx - The value of the translation in x.
    
    dy - The value of the translation in y.
    
    order - The order (prepend or append) in which to apply the translation.
  - rotateTransform
```
public final void rotateTransform(float angle)
```
    Rotates the local geometric transformation by the specified angle. This method prepends the rotation to the transformation.
    
    Parameters:
    
    angle - The angle of rotation.
  - rotateTransform
```
public final void rotateTransform(float angle,
                                  int order)
```
    Rotates the local geometric transformation by the specified angle in the specified order.
    
    Parameters:
    
    angle - The angle of rotation.
    
    order - A MatrixOrder that specifies whether to append or prepend the rotation matrix.
  - resetTransform
```
public final void resetTransform()
```
    Resets the geometric transformation matrix for this Pen to identity.
  - multiplyTransform
```
public final void multiplyTransform(Matrix matrix)
```
    Multiplies the transformation matrix for this Pen by the specified Matrix.
    
    Parameters:
    
    matrix - The Matrix object by which to multiply the transformation matrix.
  - multiplyTransform
```
public final void multiplyTransform(Matrix matrix,
                                    int order)
```
    Multiplies the transformation matrix for this Pen by the specified Matrix in the specified order.
    
    Parameters:
    
    matrix - The AffineTransform by which to multiply the transformation matrix.
    
    order - The order in which to perform the multiplication operation.

Class Pen

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Pen

Pen

Pen

Pen

Method Detail

getColor

setColor

getBrush

setBrush

getCompoundArray

setCompoundArray

getWidth

setWidth

getStartCap

setStartCap

getEndCap

setEndCap

getLineJoin

setLineJoin

getMiterLimit

setMiterLimit

getAlignment

setAlignment

getTransform

setTransform

getCustomStartCap

setCustomStartCap

getCustomEndCap

setCustomEndCap

getDashCap

setDashCap

getDashOffset

setDashOffset

getDashPattern

setDashPattern

getDashStyle

setDashStyle

getPenType

dispose

deepClone

setLineCap

scaleTransform

scaleTransform

translateTransform

translateTransform

rotateTransform

rotateTransform

resetTransform

multiplyTransform

multiplyTransform