gnu.jpdf
Class PDFBorder

java.lang.Object
  extended by gnu.jpdf.PDFObject
      extended by gnu.jpdf.PDFBorder
All Implemented Interfaces:
java.io.Serializable

public class PDFBorder
extends PDFObject

A border around an annotation

See Also:
Serialized Form

Field Summary
 
Fields inherited from class gnu.jpdf.PDFObject
objser, pdfDocument
 
Constructor Summary
PDFBorder(double width, double[] dash)
          Creates a border of style PDFAnnot.DASHED
PDFBorder(short style, double width)
          Creates a border using the predefined styles in PDFAnnot.
 
Method Summary
 void write(java.io.OutputStream os)
          Writes the object to the output stream.
 
Methods inherited from class gnu.jpdf.PDFObject
getPDFDocument, getSerialID, getType, toArray, toString, writeEnd, writeStart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PDFBorder

public PDFBorder(short style,
                 double width)
Creates a border using the predefined styles in PDFAnnot.

Note: Do not use PDFAnnot.DASHED with this method. Use the other constructor.

Parameters:
style - The style of the border
width - The width of the border
See Also:
PDFAnnot

PDFBorder

public PDFBorder(double width,
                 double[] dash)
Creates a border of style PDFAnnot.DASHED

Parameters:
width - The width of the border
dash - The line pattern definition
Method Detail

write

public void write(java.io.OutputStream os)
           throws java.io.IOException
Description copied from class: PDFObject

Writes the object to the output stream. This method must be overidden.

Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine.

Specified by:
write in class PDFObject
Parameters:
os - OutputStream to send the object to
Throws:
java.io.IOException - on error