com.aspose.imaging
Class Pen

java.lang.Object
  extended by com.aspose.imaging.TransparencySupporter
      extended by com.aspose.imaging.Pen

public class Pen
extends TransparencySupporter

Defines an object used to draw lines, curves and figures.


Constructor Summary
Pen(Brush brush)
           Initializes a new instance of the Pen class with the specified Brush.
Pen(Brush brush, float width)
           Initializes a new instance of the Pen class with the specified Brush and Pen.Width.
Pen(Color color)
           Initializes a new instance of the Pen class with the specified color.
Pen(Color color, float width)
           Initializes a new instance of the Pen class with the specified Color and Pen.Width properties.
 
Method Summary
 int getAlignment()
           Gets the alignment for this Pen.
 Brush getBrush()
           Gets the Brush that determines attributes of this Pen.
 Color getColor()
           Gets the color of this Pen.
 float[] getCompoundArray()
           Gets an array of values that specifies a compound pen.
 CustomLineCap getCustomEndCap()
           Gets a custom cap to use at the end of lines drawn with this Pen.
 CustomLineCap getCustomStartCap()
           Gets a custom cap to use at the beginning of lines drawn with this Pen.
 int getDashCap()
           Gets the cap style used at the end of the dashes that make up dashed lines drawn with this Pen.
 float getDashOffset()
           Gets the distance from the start of a line to the beginning of a dash pattern.
 float[] getDashPattern()
           Gets an array of custom dashes and spaces.
 int getDashStyle()
           Gets the style used for dashed lines drawn with this Pen.
 int getEndCap()
           Gets the cap style used at the end of lines drawn with this Pen.
 int getLineJoin()
           Gets the join style for the ends of two consecutive lines drawn with this Pen.
 float getMiterLimit()
           Gets 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 the cap style used at the beginning of lines drawn with this Pen.
 Matrix getTransform()
           Gets a copy of the geometric transformation for this Pen.
 float getWidth()
           Gets 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)
           Sets the alignment for this Pen.
 void setBrush(Brush value)
           Sets the Brush that determines attributes of this Pen.
 void setColor(Color value)
           Sets the color of this Pen.
 void setCompoundArray(float[] value)
           Sets an array of values that specifies a compound pen.
 void setCustomEndCap(CustomLineCap value)
           Setsa custom cap to use at the end of lines drawn with this Pen.
 void setCustomStartCap(CustomLineCap value)
           Setsa custom cap to use at the beginning of lines drawn with this Pen.
 void setDashCap(int value)
           Setsthe cap style used at the end of the dashes that make up dashed lines drawn with this Pen.
 void setDashOffset(float value)
           Sets the distance from the start of a line to the beginning of a dash pattern.
 void setDashPattern(float[] value)
           Sets an array of custom dashes and spaces.
 void setDashStyle(int value)
           Sets the style used for dashed lines drawn with this Pen.
 void setEndCap(int value)
           Setsthe 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)
           Setsthe join style for the ends of two consecutive lines drawn with this Pen.
 void setMiterLimit(float value)
           Setsthe limit of the thickness of the join on a mitered corner.
 void setStartCap(int value)
           Setsthe cap style used at the beginning of lines drawn with this Pen.
 void setTransform(Matrix value)
           Sets a copy of the geometric transformation for this Pen.
 void setWidth(float value)
           Setsthe 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 com.aspose.imaging.TransparencySupporter
getOpacity, setOpacity
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Pen

public Pen(Brush brush)

Initializes a new instance of the Pen class with the specified Brush.

Parameters:
brush - A Brush that determines the fill properties of this Pen.
Throws:
java.lang.IllegalArgumentException - brush is null.

Pen

public Pen(Brush brush,
           float width)

Initializes a new instance of the Pen class with the specified Brush and Pen.Width.

Parameters:
brush - A Brush that determines the characteristics of this Pen.
width - The width of the new Pen.
Throws:
java.lang.IllegalArgumentException - brush is null.

Pen

public Pen(Color color)

Initializes a new instance of the Pen class with the specified color.

Parameters:
color - A Color structure that indicates the color of this Pen.

Pen

public Pen(Color color,
           float width)

Initializes a new instance of the Pen class with the specified Color and Pen.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

getAlignment

public int getAlignment()

Gets the alignment for this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Alignment property is set on an immutable Pen, such as those returned by the Pens class. Value: A PenAlignment that represents the alignment for this Pen.

getBrush

public Brush getBrush()

Gets the Brush that determines attributes of this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Brush property is set on an immutable Pen, such as those returned by the Pens class. Value: A Brush that determines attributes of this Pen.

getColor

public Color getColor()

Gets the color of this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Color property is set on an immutable Pen, such as those returned by the Pens class. Value: A Color structure that represents the color of this Pen.

getCompoundArray

public float[] getCompoundArray()

Gets an array of values that specifies a compound pen. A compound pen draws a compound line made up of parallel lines and spaces.

Throws:
java.lang.IllegalArgumentException - The Pen.CompoundArray property is set on an immutable Pen, such as those returned by the Pens class. Value: 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.

getCustomEndCap

public CustomLineCap getCustomEndCap()

Gets a custom cap to use at the end of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.CustomEndCap property is set on an immutable Pen, such as those returned by the Pens class. Value: A CustomLineCap that represents the cap used at the end of lines drawn with this Pen.

getCustomStartCap

public CustomLineCap getCustomStartCap()

Gets a custom cap to use at the beginning of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.CustomStartCap property is set on an immutable Pen, such as those returned by the Pens class. Value: A CustomLineCap that represents the cap used at the beginning of lines drawn with this Pen.

getDashCap

public int getDashCap()

Gets the cap style used at the end of the dashes that make up dashed lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.DashCap property is set on an immutable Pen, such as those returned by the Pens class. Value: One of the DashCap values that represents the cap style used at the beginning and end of the dashes that make up dashed lines drawn with this Pen.

getDashOffset

public float getDashOffset()

Gets the distance from the start of a line to the beginning of a dash pattern.

Throws:
java.lang.IllegalArgumentException - The Pen.DashOffset property is set on an immutable Pen, such as those returned by the Pens class. Value: The distance from the start of a line to the beginning of a dash pattern.

getDashPattern

public float[] getDashPattern()

Gets an array of custom dashes and spaces.

Throws:
java.lang.IllegalArgumentException - The Pen.DashPattern property is set on an immutable Pen, such as those returned by the Pens class. Value: An array of real numbers that specifies the lengths of alternating dashes and spaces in dashed lines.

getDashStyle

public int getDashStyle()

Gets the style used for dashed lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.DashStyle property is set on an immutable Pen, such as those returned by the Pens class. Value: A DashStyle that represents the style used for dashed lines drawn with this Pen.

getEndCap

public int getEndCap()

Gets the cap style used at the end of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.EndCap property is set on an immutable Pen, such as those returned by the Pens class. Value: One of the LineCap values that represents the cap style used at the end of lines drawn with this Pen.

getLineJoin

public int getLineJoin()

Gets the join style for the ends of two consecutive lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.LineJoin property is set on an immutable Pen, such as those returned by the Pens class. Value: A LineJoin that represents the join style for the ends of two consecutive lines drawn with this Pen.

getMiterLimit

public float getMiterLimit()

Gets the limit of the thickness of the join on a mitered corner.

Throws:
java.lang.IllegalArgumentException - The Pen.MiterLimit property is set on an immutable Pen, such as those returned by the Pens class. Value: The limit of the thickness of the join on a mitered corner.

getPenType

public int getPenType()

Gets the style of lines drawn with this Pen.

Value: A PenType enumeration that specifies the style of lines drawn with this Pen.


getStartCap

public int getStartCap()

Gets the cap style used at the beginning of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.StartCap property is set on an immutable Pen, such as those returned by the Pens class. Value: One of the LineCap values that represents the cap style used at the beginning of lines drawn with this Pen.

getTransform

public Matrix getTransform()

Gets a copy of the geometric transformation for this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Transform property is set on an immutable Pen, such as those returned by the Pens class. Value: A copy of the Matrix that represents the geometric transformation for this Pen.

getWidth

public float getWidth()

Gets the width of this Pen, in units of the Graphics object used for drawing.

Throws:
java.lang.IllegalArgumentException - The Pen.Width property is set on an immutable Pen, such as those returned by the Pens class. Value: The width of this Pen.

multiplyTransform

public 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 void multiplyTransform(Matrix matrix,
                              int order)

Multiplies the transformation matrix for this Pen by the specified Matrix in the specified order.

Parameters:
matrix - The Matrix by which to multiply the transformation matrix.
order - The order in which to perform the multiplication operation.

resetTransform

public void resetTransform()

Resets the geometric transformation matrix for this Pen to identity.


rotateTransform

public 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 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.

scaleTransform

public 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 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.

setAlignment

public void setAlignment(int value)

Sets the alignment for this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Alignment property is set on an immutable Pen, such as those returned by the Pens class. Value: A PenAlignment that represents the alignment for this Pen.

setBrush

public void setBrush(Brush value)

Sets the Brush that determines attributes of this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Brush property is set on an immutable Pen, such as those returned by the Pens class. Value: A Brush that determines attributes of this Pen.

setColor

public void setColor(Color value)

Sets the color of this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Color property is set on an immutable Pen, such as those returned by the Pens class. Value: A Color structure that represents the color of this Pen.

setCompoundArray

public void setCompoundArray(float[] value)

Sets an array of values that specifies a compound pen. A compound pen draws a compound line made up of parallel lines and spaces.

Throws:
java.lang.IllegalArgumentException - The Pen.CompoundArray property is set on an immutable Pen, such as those returned by the Pens class. Value: 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.

setCustomEndCap

public void setCustomEndCap(CustomLineCap value)

Setsa custom cap to use at the end of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.CustomEndCap property is set on an immutable Pen, such as those returned by the Pens class. Value: A CustomLineCap that represents the cap used at the end of lines drawn with this Pen.

setCustomStartCap

public void setCustomStartCap(CustomLineCap value)

Setsa custom cap to use at the beginning of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.CustomStartCap property is set on an immutable Pen, such as those returned by the Pens class. Value: A CustomLineCap that represents the cap used at the beginning of lines drawn with this Pen.

setDashCap

public void setDashCap(int value)

Setsthe cap style used at the end of the dashes that make up dashed lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.DashCap property is set on an immutable Pen, such as those returned by the Pens class. Value: One of the DashCap values that represents the cap style used at the beginning and end of the dashes that make up dashed lines drawn with this Pen.

setDashOffset

public void setDashOffset(float value)

Sets the distance from the start of a line to the beginning of a dash pattern.

Throws:
java.lang.IllegalArgumentException - The Pen.DashOffset property is set on an immutable Pen, such as those returned by the Pens class. Value: The distance from the start of a line to the beginning of a dash pattern.

setDashPattern

public void setDashPattern(float[] value)

Sets an array of custom dashes and spaces.

Throws:
java.lang.IllegalArgumentException - The Pen.DashPattern property is set on an immutable Pen, such as those returned by the Pens class. Value: An array of real numbers that specifies the lengths of alternating dashes and spaces in dashed lines.

setDashStyle

public void setDashStyle(int value)

Sets the style used for dashed lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.DashStyle property is set on an immutable Pen, such as those returned by the Pens class. Value: A DashStyle that represents the style used for dashed lines drawn with this Pen.

setEndCap

public void setEndCap(int value)

Setsthe cap style used at the end of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.EndCap property is set on an immutable Pen, such as those returned by the Pens class. Value: One of the LineCap values that represents the cap style used at the end of lines drawn with this Pen.

setLineCap

public 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.

setLineJoin

public void setLineJoin(int value)

Setsthe join style for the ends of two consecutive lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.LineJoin property is set on an immutable Pen, such as those returned by the Pens class. Value: A LineJoin that represents the join style for the ends of two consecutive lines drawn with this Pen.

setMiterLimit

public void setMiterLimit(float value)

Setsthe limit of the thickness of the join on a mitered corner.

Throws:
java.lang.IllegalArgumentException - The Pen.MiterLimit property is set on an immutable Pen, such as those returned by the Pens class. Value: The limit of the thickness of the join on a mitered corner.

setStartCap

public void setStartCap(int value)

Setsthe cap style used at the beginning of lines drawn with this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.StartCap property is set on an immutable Pen, such as those returned by the Pens class. Value: One of the LineCap values that represents the cap style used at the beginning of lines drawn with this Pen.

setTransform

public void setTransform(Matrix value)

Sets a copy of the geometric transformation for this Pen.

Throws:
java.lang.IllegalArgumentException - The Pen.Transform property is set on an immutable Pen, such as those returned by the Pens class. Value: A copy of the Matrix that represents the geometric transformation for this Pen.

setWidth

public void setWidth(float value)

Setsthe width of this Pen, in units of the Graphics object used for drawing.

Throws:
java.lang.IllegalArgumentException - The Pen.Width property is set on an immutable Pen, such as those returned by the Pens class. Value: The width of this Pen.

translateTransform

public 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 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.