org.foray.pdf.object
Class PDFBorderStyle

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFBorderStyle

public class PDFBorderStyle
extends PDFObject

A PDF Border Style Dictionary. See PDF Reference, 3rd Edition, Section 8.4.3.

Nested Class Summary

static class

PDFBorderStyle.Style Enumeration of the possible BorderStyle style values.

Field Summary

Fields inherited from class org.foray.pdf.object.PDFObject

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFBorderStyle(PDFDocument doc, float width, PDFBorderStyle.Style style)
Create a PDFBorderStyle object.

Method Summary

String

toPDF() Produce the PDF representation of the object.

Methods inherited from class org.foray.pdf.object.PDFObject

bufferToByteArray, byteArrayToStream, getCharsPerLine, getGeneration, getLogger, getNumber, getPDFDocument, output, pdfID, pdfReference, setNumber, stringToByteArray

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFBorderStyle

public PDFBorderStyle(PDFDocument doc,
                      float width,
                      PDFBorderStyle.Style style)

Create a PDFBorderStyle object.

Parameters:

doc - The PDF document being built.

width - The width, in points, of the border to be drawn. A width of 0 disables border drawing.

style - The border style to be applied.

Method Detail

toPDF

public String toPDF()

Produce the PDF representation of the object.

Returns:

The text that should be placed in the PDF for this object.