com.aspose.words
Class Stroke

java.lang.Object
    extended by com.aspose.words.Stroke

public class Stroke 
extends java.lang.Object

Defines a stroke for a shape.

Use the Shape.Stroke property to access stroke properties of a shape. You do not create instances of the Stroke class directly.

See Also:
Shape.Stroke

Property Getters/Setters Summary
java.awt.ColorgetColor()
voidsetColor(java.awt.Color value)
           Defines the color of a stroke.
java.awt.ColorgetColor2()
voidsetColor2(java.awt.Color value)
           Defines a second color for a stroke.
intgetDashStyle()
voidsetDashStyle(int value)
           Specifies the dot and dash pattern for a stroke. The value of the property is DashStyle integer constant.
intgetEndArrowLength()
voidsetEndArrowLength(int value)
           Defines the arrowhead length for the end of a stroke. The value of the property is ArrowLength integer constant.
intgetEndArrowType()
voidsetEndArrowType(int value)
           Defines the arrowhead for the end of a stroke. The value of the property is ArrowType integer constant.
intgetEndArrowWidth()
voidsetEndArrowWidth(int value)
           Defines the arrowhead width for the end of a stroke. The value of the property is ArrowWidth integer constant.
intgetEndCap()
voidsetEndCap(int value)
           Defines the cap style for the end of a stroke. The value of the property is EndCap integer constant.
byte[]getImageBytes()
           Defines the image for a stroke image or pattern fill.
intgetJoinStyle()
voidsetJoinStyle(int value)
           Defines the join style of a polyline. The value of the property is JoinStyle integer constant.
intgetLineStyle()
voidsetLineStyle(int value)
           Defines the line style of the stroke. The value of the property is ShapeLineStyle integer constant.
booleangetOn()
voidsetOn(boolean value)
           Defines whether the path will be stroked.
doublegetOpacity()
voidsetOpacity(double value)
           Defines the amount of transparency of a stroke. Valid range is from 0 to 1.
intgetStartArrowLength()
voidsetStartArrowLength(int value)
           Defines the arrowhead length for the start of a stroke. The value of the property is ArrowLength integer constant.
intgetStartArrowType()
voidsetStartArrowType(int value)
           Defines the arrowhead for the start of a stroke. The value of the property is ArrowType integer constant.
intgetStartArrowWidth()
voidsetStartArrowWidth(int value)
           Defines the arrowhead width for the start of a stroke. The value of the property is ArrowWidth integer constant.
doublegetWeight()
voidsetWeight(double value)
           Defines the brush thickness that strokes the path of a shape in points.
 

Property Getters/Setters Detail

getColor/setColor

public java.awt.Color getColor() / public void setColor(java.awt.Color value)
Defines the color of a stroke.

The default value is java.awt.Color.BLACK.


getColor2/setColor2

public java.awt.Color getColor2() / public void setColor2(java.awt.Color value)
Defines a second color for a stroke.

The default value is java.awt.Color.WHITE.


getDashStyle/setDashStyle

public int getDashStyle() / public void setDashStyle(int value)
Specifies the dot and dash pattern for a stroke. The value of the property is DashStyle integer constant.

The default value is DashStyle.SOLID.


getEndArrowLength/setEndArrowLength

public int getEndArrowLength() / public void setEndArrowLength(int value)
Defines the arrowhead length for the end of a stroke. The value of the property is ArrowLength integer constant.

The default value is ArrowLength.MEDIUM.


getEndArrowType/setEndArrowType

public int getEndArrowType() / public void setEndArrowType(int value)
Defines the arrowhead for the end of a stroke. The value of the property is ArrowType integer constant.

The default value is ArrowType.NONE.


getEndArrowWidth/setEndArrowWidth

public int getEndArrowWidth() / public void setEndArrowWidth(int value)
Defines the arrowhead width for the end of a stroke. The value of the property is ArrowWidth integer constant.

The default value is ArrowWidth.MEDIUM.


getEndCap/setEndCap

public int getEndCap() / public void setEndCap(int value)
Defines the cap style for the end of a stroke. The value of the property is EndCap integer constant.

The default value is EndCap.FLAT.


getImageBytes

public byte[] getImageBytes()
Defines the image for a stroke image or pattern fill.

getJoinStyle/setJoinStyle

public int getJoinStyle() / public void setJoinStyle(int value)
Defines the join style of a polyline. The value of the property is JoinStyle integer constant.

The default value is JoinStyle.ROUND.


getLineStyle/setLineStyle

public int getLineStyle() / public void setLineStyle(int value)
Defines the line style of the stroke. The value of the property is ShapeLineStyle integer constant.

The default value is ShapeLineStyle.SINGLE.


getOn/setOn

public boolean getOn() / public void setOn(boolean value)
Defines whether the path will be stroked.

The default value is true.


getOpacity/setOpacity

public double getOpacity() / public void setOpacity(double value)
Defines the amount of transparency of a stroke. Valid range is from 0 to 1.

The default value is 1.


getStartArrowLength/setStartArrowLength

public int getStartArrowLength() / public void setStartArrowLength(int value)
Defines the arrowhead length for the start of a stroke. The value of the property is ArrowLength integer constant.

The default value is ArrowLength.MEDIUM.


getStartArrowType/setStartArrowType

public int getStartArrowType() / public void setStartArrowType(int value)
Defines the arrowhead for the start of a stroke. The value of the property is ArrowType integer constant.

The default value is ArrowType.NONE.


getStartArrowWidth/setStartArrowWidth

public int getStartArrowWidth() / public void setStartArrowWidth(int value)
Defines the arrowhead width for the start of a stroke. The value of the property is ArrowWidth integer constant.

The default value is ArrowWidth.MEDIUM.


getWeight/setWeight

public double getWeight() / public void setWeight(double value)
Defines the brush thickness that strokes the path of a shape in points.

The default value is 0.75.


See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.