Stroke (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Stroke

```
public class Stroke
extends java.lang.Object
```
Defines a stroke for a shape.
Use the Shape.getStroke() property to access stroke properties of a shape. You do not create instances of the Stroke class directly.

See Also:

Shape.getStroke()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.awt.Color`	`getBackColor()` Gets the background color of the stroke.
`java.awt.Color`	`getColor()` Defines the color of a stroke.
`java.awt.Color`	`getColor2()` Defines a second color for a stroke.
`int`	`getDashStyle()` Specifies the dot and dash pattern for a stroke.
`int`	`getEndArrowLength()` Defines the arrowhead length for the end of a stroke.
`int`	`getEndArrowType()` Defines the arrowhead for the end of a stroke.
`int`	`getEndArrowWidth()` Defines the arrowhead width for the end of a stroke.
`int`	`getEndCap()` Defines the cap style for the end of a stroke.
`java.awt.Color`	`getForeColor()` Gets the foreground color of the stroke.
`byte[]`	`getImageBytes()` Defines the image for a stroke image or pattern fill.
`int`	`getJoinStyle()` Defines the join style of a polyline.
`int`	`getLineStyle()` Defines the line style of the stroke.
`boolean`	`getOn()` Defines whether the path will be stroked.
`double`	`getOpacity()` Defines the amount of transparency of a stroke.
`int`	`getStartArrowLength()` Defines the arrowhead length for the start of a stroke.
`int`	`getStartArrowType()` Defines the arrowhead for the start of a stroke.
`int`	`getStartArrowWidth()` Defines the arrowhead width for the start of a stroke.
`double`	`getTransparency()` Gets a value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke.
`boolean`	`getVisible()` Gets a flag indicating whether the stroke is visible.
`double`	`getWeight()` Defines the brush thickness that strokes the path of a shape in points.
`void`	`setBackColor(java.awt.Color value)` Sets the background color of the stroke.
`void`	`setColor(java.awt.Color value)` Defines the color of a stroke.
`void`	`setColor2(java.awt.Color value)` Defines a second color for a stroke.
`void`	`setDashStyle(int value)` Specifies the dot and dash pattern for a stroke.
`void`	`setEndArrowLength(int value)` Defines the arrowhead length for the end of a stroke.
`void`	`setEndArrowType(int value)` Defines the arrowhead for the end of a stroke.
`void`	`setEndArrowWidth(int value)` Defines the arrowhead width for the end of a stroke.
`void`	`setEndCap(int value)` Defines the cap style for the end of a stroke.
`void`	`setForeColor(java.awt.Color value)` Sets the foreground color of the stroke.
`void`	`setJoinStyle(int value)` Defines the join style of a polyline.
`void`	`setLineStyle(int value)` Defines the line style of the stroke.
`void`	`setOn(boolean value)` Defines whether the path will be stroked.
`void`	`setOpacity(double value)` Defines the amount of transparency of a stroke.
`void`	`setStartArrowLength(int value)` Defines the arrowhead length for the start of a stroke.
`void`	`setStartArrowType(int value)` Defines the arrowhead for the start of a stroke.
`void`	`setStartArrowWidth(int value)` Defines the arrowhead width for the start of a stroke.
`void`	`setTransparency(double value)` Sets a value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke.
`void`	`setVisible(boolean value)` Sets a flag indicating whether the stroke is visible.
`void`	`setWeight(double value)` Defines the brush thickness that strokes the path of a shape in points.

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

- Method Detail
  - getOn
```
public boolean getOn()
```
    Defines whether the path will be stroked.
    The default value for a Shape is true.
    
    Returns:
    
    The corresponding boolean value.
  - setOn
```
public void setOn(boolean value)
```
    Defines whether the path will be stroked.
    The default value for a Shape is true.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getColor
```
public java.awt.Color getColor()
```
    Defines the color of a stroke.
    The default value for a Shape is .
    
    Returns:
    
    The corresponding Color value.
  - setColor
```
public void setColor(java.awt.Color value)
```
    Defines the color of a stroke.
    The default value for a Shape is .
    
    Parameters:
    
    value - The corresponding Color value.
  - getColor2
```
public java.awt.Color getColor2()
```
    Defines a second color for a stroke.
    The default value for a Shape is .
    
    Returns:
    
    The corresponding Color value.
  - setColor2
```
public void setColor2(java.awt.Color value)
```
    Defines a second color for a stroke.
    The default value for a Shape is .
    
    Parameters:
    
    value - The corresponding Color value.
  - getForeColor
```
public java.awt.Color getForeColor()
```
    Gets the foreground color of the stroke. The default value for a Shape is .
    
    Returns:
    
    The foreground color of the stroke.
  - setForeColor
```
public void setForeColor(java.awt.Color value)
```
    Sets the foreground color of the stroke. The default value for a Shape is .
    
    Parameters:
    
    value - The foreground color of the stroke.
  - getBackColor
```
public java.awt.Color getBackColor()
```
    Gets the background color of the stroke. The default value for a Shape is .
    
    Returns:
    
    The background color of the stroke.
  - setBackColor
```
public void setBackColor(java.awt.Color value)
```
    Sets the background color of the stroke. The default value for a Shape is .
    
    Parameters:
    
    value - The background color of the stroke.
  - getVisible
```
public boolean getVisible()
```
    Gets a flag indicating whether the stroke is visible. The default value for a Shape is true.
    
    Returns:
    
    A flag indicating whether the stroke is visible.
  - setVisible
```
public void setVisible(boolean value)
```
    Sets a flag indicating whether the stroke is visible. The default value for a Shape is true.
    
    Parameters:
    
    value - A flag indicating whether the stroke is visible.
  - getTransparency
```
public double getTransparency()
```
    Gets a value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke. The default value is 0.
    
    Returns:
    
    A value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke.
  - setTransparency
```
public void setTransparency(double value)
```
    Sets a value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke. The default value is 0.
    
    Parameters:
    
    value - A value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke.
  - getWeight
```
public double getWeight()
```
    Defines the brush thickness that strokes the path of a shape in points.
    The default value for a Shape is 0.75.
    
    Returns:
    
    The corresponding double value.
  - setWeight
```
public void setWeight(double value)
```
    Defines the brush thickness that strokes the path of a shape in points.
    The default value for a Shape is 0.75.
    
    Parameters:
    
    value - The corresponding double value.
  - getDashStyle
```
public int getDashStyle()
```
    Specifies the dot and dash pattern for a stroke.
    The default value is DashStyle.SOLID.
    
    Returns:
    
    The corresponding int value. The returned value is one of DashStyle constants.
  - setDashStyle
```
public void setDashStyle(int value)
```
    Specifies the dot and dash pattern for a stroke.
    The default value is DashStyle.SOLID.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of DashStyle constants.
  - getJoinStyle
```
public int getJoinStyle()
```
    Defines the join style of a polyline.
    The default value is JoinStyle.ROUND.
    
    Returns:
    
    The corresponding int value. The returned value is one of JoinStyle constants.
  - setJoinStyle
```
public void setJoinStyle(int value)
```
    Defines the join style of a polyline.
    The default value is JoinStyle.ROUND.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of JoinStyle constants.
  - getEndCap
```
public int getEndCap()
```
    Defines the cap style for the end of a stroke.
    The default value is EndCap.FLAT.
    
    Returns:
    
    The corresponding int value. The returned value is one of EndCap constants.
  - setEndCap
```
public void setEndCap(int value)
```
    Defines the cap style for the end of a stroke.
    The default value is EndCap.FLAT.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of EndCap constants.
  - getLineStyle
```
public int getLineStyle()
```
    Defines the line style of the stroke.
    The default value is ShapeLineStyle.SINGLE.
    
    Returns:
    
    The corresponding int value. The returned value is one of ShapeLineStyle constants.
  - setLineStyle
```
public void setLineStyle(int value)
```
    Defines the line style of the stroke.
    The default value is ShapeLineStyle.SINGLE.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ShapeLineStyle constants.
  - getStartArrowType
```
public int getStartArrowType()
```
    Defines the arrowhead for the start of a stroke.
    The default value is ArrowType.NONE.
    
    Returns:
    
    The corresponding int value. The returned value is one of ArrowType constants.
  - setStartArrowType
```
public void setStartArrowType(int value)
```
    Defines the arrowhead for the start of a stroke.
    The default value is ArrowType.NONE.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ArrowType constants.
  - getEndArrowType
```
public int getEndArrowType()
```
    Defines the arrowhead for the end of a stroke.
    The default value is ArrowType.NONE.
    
    Returns:
    
    The corresponding int value. The returned value is one of ArrowType constants.
  - setEndArrowType
```
public void setEndArrowType(int value)
```
    Defines the arrowhead for the end of a stroke.
    The default value is ArrowType.NONE.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ArrowType constants.
  - getStartArrowWidth
```
public int getStartArrowWidth()
```
    Defines the arrowhead width for the start of a stroke.
    The default value is ArrowWidth.MEDIUM.
    
    Returns:
    
    The corresponding int value. The returned value is one of ArrowWidth constants.
  - setStartArrowWidth
```
public void setStartArrowWidth(int value)
```
    Defines the arrowhead width for the start of a stroke.
    The default value is ArrowWidth.MEDIUM.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ArrowWidth constants.
  - getStartArrowLength
```
public int getStartArrowLength()
```
    Defines the arrowhead length for the start of a stroke.
    The default value is ArrowLength.MEDIUM.
    
    Returns:
    
    The corresponding int value. The returned value is one of ArrowLength constants.
  - setStartArrowLength
```
public void setStartArrowLength(int value)
```
    Defines the arrowhead length for the start of a stroke.
    The default value is ArrowLength.MEDIUM.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ArrowLength constants.
  - getEndArrowWidth
```
public int getEndArrowWidth()
```
    Defines the arrowhead width for the end of a stroke.
    The default value is ArrowWidth.MEDIUM.
    
    Returns:
    
    The corresponding int value. The returned value is one of ArrowWidth constants.
  - setEndArrowWidth
```
public void setEndArrowWidth(int value)
```
    Defines the arrowhead width for the end of a stroke.
    The default value is ArrowWidth.MEDIUM.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ArrowWidth constants.
  - getEndArrowLength
```
public int getEndArrowLength()
```
    Defines the arrowhead length for the end of a stroke.
    The default value is ArrowLength.MEDIUM.
    
    Returns:
    
    The corresponding int value. The returned value is one of ArrowLength constants.
  - setEndArrowLength
```
public void setEndArrowLength(int value)
```
    Defines the arrowhead length for the end of a stroke.
    The default value is ArrowLength.MEDIUM.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ArrowLength constants.
  - getOpacity
```
public double getOpacity()
```
    Defines the amount of transparency of a stroke. Valid range is from 0 to 1.
    The default value is 1.
    
    Returns:
    
    The corresponding double value.
  - setOpacity
```
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.
    
    Parameters:
    
    value - The corresponding double value.
  - getImageBytes
```
public byte[] getImageBytes()
                     throws java.lang.Exception
```
    Defines the image for a stroke image or pattern fill.
    
    Returns:
    
    The corresponding byte[] value.
    
    Throws:
    
    java.lang.Exception

Class Stroke

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOn

setOn

getColor

setColor

getColor2

setColor2

getForeColor

setForeColor

getBackColor

setBackColor

getVisible

setVisible

getTransparency

setTransparency

getWeight

setWeight

getDashStyle

setDashStyle

getJoinStyle

setJoinStyle

getEndCap

setEndCap

getLineStyle

setLineStyle

getStartArrowType

setStartArrowType

getEndArrowType

setEndArrowType

getStartArrowWidth

setStartArrowWidth

getStartArrowLength

setStartArrowLength

getEndArrowWidth

setEndArrowWidth

getEndArrowLength

setEndArrowLength

getOpacity

setOpacity

getImageBytes