OfficeLineFormat
Inheritance: java.lang.Object
public final class OfficeLineFormat
Represents a shape line format.
Constructors
| Constructor | Description |
|---|---|
| OfficeLineFormat() | Initializes a new instance of the [OfficeLineFormat](../../com.groupdocs.watermark.contents/officelineformat) class. |
Methods
| Method | Description |
|---|---|
| getWeight() | Gets the brush thickness that strokes the path of a shape. |
| setWeight(double value) | Sets the brush thickness that strokes the path of a shape. |
| getColor() | Gets the color of the line. |
| setColor(Color value) | Sets the color of the line. |
| getOpacity() | Gets the line opacity. |
| setOpacity(double value) | Sets the line opacity. |
| getEnabled() | Gets a value indicating whether a shape will be stroked. |
| setEnabled(boolean value) | Sets a value indicating whether a shape will be stroked. |
| getDashStyle() | Gets the dot and dash pattern for a line. |
| setDashStyle(int value) | Sets the dot and dash pattern for a line. |
| getLineStyle() | Gets the line style. |
| setLineStyle(int value) | Sets the line style. |
| getTransparency() | |
| getColorConsideringOpacity() |
OfficeLineFormat()
public OfficeLineFormat()
Initializes a new instance of the [OfficeLineFormat](../../com.groupdocs.watermark.contents/officelineformat) class.
getWeight()
public final double getWeight()
Gets the brush thickness that strokes the path of a shape.
Returns: double - The line thickness in points. The default value is 0.75.
setWeight(double value)
public final void setWeight(double value)
Sets the brush thickness that strokes the path of a shape.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The line thickness in points. The default value is 0.75. |
getColor()
public final Color getColor()
Gets the color of the line.
The default value is [Color.getBlack()](../../com.groupdocs.watermark.watermarks/color#getBlack--).
Returns: Color - The color of the line.
setColor(Color value)
public final void setColor(Color value)
Sets the color of the line.
The default value is [Color.getBlack()](../../com.groupdocs.watermark.watermarks/color#getBlack--).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The color of the line. |
getOpacity()
public final double getOpacity()
Gets the line opacity.
Returns: double - The value should be between 0 and 1. Default value is 1.
setOpacity(double value)
public final void setOpacity(double value)
Sets the line opacity.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The value should be between 0 and 1. Default value is 1. |
getEnabled()
public final boolean getEnabled()
Gets a value indicating whether a shape will be stroked.
Returns: boolean - The default value is false.
setEnabled(boolean value)
public final void setEnabled(boolean value)
Sets a value indicating whether a shape will be stroked.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The default value is false. |
getDashStyle()
public final int getDashStyle()
Gets the dot and dash pattern for a line.
Returns: int
setDashStyle(int value)
public final void setDashStyle(int value)
Sets the dot and dash pattern for a line.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getLineStyle()
public final int getLineStyle()
Gets the line style.
The default value is [OfficeLineStyle.Single](../../com.groupdocs.watermark.contents/officelinestyle#Single).
Returns: int - The line style.
setLineStyle(int value)
public final void setLineStyle(int value)
Sets the line style.
The default value is [OfficeLineStyle.Single](../../com.groupdocs.watermark.contents/officelinestyle#Single).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The line style. |
getTransparency()
public final double getTransparency()
Returns: double
getColorConsideringOpacity()
public final Color getColorConsideringOpacity()
Returns: Color