com.aspose.words

Class Stroke

  • java.lang.Object
    • 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.

Example:

Shows how change stroke properties
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Create a new shape of type Rectangle
Shape rectangle = new Shape(doc, ShapeType.RECTANGLE);

//Change stroke properties
Stroke stroke = rectangle.getStroke();
stroke.setOn(true);
stroke.setWeight(5.0);
stroke.setColor(Color.RED);
stroke.setDashStyle(DashStyle.SHORT_DASH_DOT_DOT);
stroke.setJoinStyle(JoinStyle.MITER);
stroke.setEndCap(EndCap.SQUARE);
stroke.setLineStyle(ShapeLineStyle.TRIPLE);

//Insert shape object
builder.insertNode(rectangle);
See Also:
Shape.Stroke

Property Getters/Setters Summary
java.awt.ColorgetColor()
void
setColor(java.awt.Colorvalue)
           Defines the color of a stroke.
java.awt.ColorgetColor2()
void
setColor2(java.awt.Colorvalue)
           Defines a second color for a stroke.
intgetDashStyle()
void
setDashStyle(intvalue)
           Specifies the dot and dash pattern for a stroke. The value of the property is DashStyle integer constant.
intgetEndArrowLength()
void
           Defines the arrowhead length for the end of a stroke. The value of the property is ArrowLength integer constant.
intgetEndArrowType()
void
setEndArrowType(intvalue)
           Defines the arrowhead for the end of a stroke. The value of the property is ArrowType integer constant.
intgetEndArrowWidth()
void
           Defines the arrowhead width for the end of a stroke. The value of the property is ArrowWidth integer constant.
intgetEndCap()
void
setEndCap(intvalue)
           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()
void
setJoinStyle(intvalue)
           Defines the join style of a polyline. The value of the property is JoinStyle integer constant.
intgetLineStyle()
void
setLineStyle(intvalue)
           Defines the line style of the stroke. The value of the property is ShapeLineStyle integer constant.
booleangetOn()
void
setOn(booleanvalue)
           Defines whether the path will be stroked.
doublegetOpacity()
void
setOpacity(doublevalue)
           Defines the amount of transparency of a stroke. Valid range is from 0 to 1.
intgetStartArrowLength()
void
           Defines the arrowhead length for the start of a stroke. The value of the property is ArrowLength integer constant.
intgetStartArrowType()
void
           Defines the arrowhead for the start of a stroke. The value of the property is ArrowType integer constant.
intgetStartArrowWidth()
void
           Defines the arrowhead width for the start of a stroke. The value of the property is ArrowWidth integer constant.
doublegetWeight()
void
setWeight(doublevalue)
           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.