rst.pdfbox.layout.shape

Class Stroke

java.lang.Object

rst.pdfbox.layout.shape.Stroke

public class Stroke
extends Object

This is a container for all information needed to perform a stroke.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stroke.CapStyle Enum for the PDF cap styles.
static class	Stroke.DashPattern Describes a PDF dash pattern.
static class	Stroke.JoinStyle Enum for the PDF join styles.
static class	Stroke.StrokeBuilder A builder providing a fluent interface for creating a stroke.

Constructor Summary

Constructors

Constructor and Description
Stroke() Creates a Stroke with line width 1, cap style Stroke.CapStyle.Cap, join style Stroke.JoinStyle.Miter, and no dash pattern.
Stroke(float lineWidth) Creates a Stroke with the given line width, cap style Stroke.CapStyle.Cap, join style Stroke.JoinStyle.Miter, and no dash pattern.
Stroke(Stroke.CapStyle capStyle, Stroke.JoinStyle joinStyle, Stroke.DashPattern dashPattern, float lineWidth) Creates a stroke with the given attributes.

Method Summary

Modifier and Type	Method and Description
void	applyTo(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream) Applies this stroke to the given content stream.
static Stroke.StrokeBuilder	builder() Creates a stroke builder providing a fluent interface for creating a stroke.
Stroke.CapStyle	getCapStyle()
Stroke.DashPattern	getDashPattern()
Stroke.JoinStyle	getJoinStyle()
float	getLineWidth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Stroke

public Stroke()

Creates a Stroke with line width 1, cap style Stroke.CapStyle.Cap, join style Stroke.JoinStyle.Miter, and no dash pattern.

Stroke

public Stroke(float lineWidth)

Creates a Stroke with the given line width, cap style Stroke.CapStyle.Cap, join style Stroke.JoinStyle.Miter, and no dash pattern.

Parameters:

lineWidth - the line width.

Stroke

public Stroke(Stroke.CapStyle capStyle,
              Stroke.JoinStyle joinStyle,
              Stroke.DashPattern dashPattern,
              float lineWidth)

Creates a stroke with the given attributes.

Parameters:

capStyle - the cap style.

joinStyle - the join style.

dashPattern - the dash pattern.

lineWidth - the line width.

Method Detail

getCapStyle

public Stroke.CapStyle getCapStyle()

getJoinStyle

public Stroke.JoinStyle getJoinStyle()

getDashPattern

public Stroke.DashPattern getDashPattern()

getLineWidth

public float getLineWidth()

applyTo

public void applyTo(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)
             throws IOException

Applies this stroke to the given content stream.

Parameters:

contentStream - the content stream to apply this stroke to.

Throws:

IOException - by PDFBox.

builder

public static Stroke.StrokeBuilder builder()

Creates a stroke builder providing a fluent interface for creating a stroke.

Returns:

a stroke builder.