org.axsl.pdf
Enum PdfLineCapStyle

java.lang.Object
  java.lang.Enum<PdfLineCapStyle>
      org.axsl.pdf.PdfLineCapStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PdfLineCapStyle>

public enum PdfLineCapStyle
extends java.lang.Enum<PdfLineCapStyle>

Enumeration of the possible line cap styles in PDF. The line cap specified the shape to be used at the ends of open subpaths (and dashes) when they are stroked. See PDF Reference, 3rd Edition, Section 4.3.2, Subsection "Line Cap Style".

Enum Constant Summary

BUTT_CAP
The stroke is squared off at the endpoint of the path.

PROJECTING_SQUARE_CAP
The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is then squared off.

ROUND_CAP
A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in.

Method Summary

int	getPdfValue() Returns the value written into a PDF document to designate this style.
static PdfLineCapStyle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PdfLineCapStyle[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BUTT_CAP

public static final PdfLineCapStyle BUTT_CAP

The stroke is squared off at the endpoint of the path.

ROUND_CAP

public static final PdfLineCapStyle ROUND_CAP

A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in.

PROJECTING_SQUARE_CAP

public static final PdfLineCapStyle PROJECTING_SQUARE_CAP

The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is then squared off.

Method Detail

values

public static final PdfLineCapStyle[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PdfLineCapStyle c : PdfLineCapStyle.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static PdfLineCapStyle valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getPdfValue

public int getPdfValue()

Returns the value written into a PDF document to designate this style.

Returns:

the value written into a PDF document to designate this style.