gnu.apdf

Class PDFBorder

java.lang.Object

gnu.apdf.PDFObject

gnu.apdf.PDFBorder

All Implemented Interfaces:

Serializable

public class PDFBorder
extends PDFObject

A border around an annotation

Author:

Peter T Mount, http://www.retep.org.uk/pdf/, Eric Z. Beard, ericzbeard@hotmail.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
void	write(OutputStream os) Writes the object to the output stream.

Methods inherited from class gnu.apdf.PDFObject

getGeneration, getName, getPDFDocument, getSerialID, getType, setName, toArray, toString, writeEnd, writeStart

Methods inherited from class java.lang.Object

equals, 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(OutputStream os)
           throws 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:

IOException - on error