Package com.pdf_tools.fourheights.pdftoolbox.pdf.annotations

Class RectangleAnnotation

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Annotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupAnnotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.DrawingAnnotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.RectangleAnnotation

public class RectangleAnnotation
extends DrawingAnnotation

A rectangle drawing annotation

Method Summary

Modifier and Type	Method	Description
static RectangleAnnotation	create(Document targetDocument, Rectangle boundingBox, Stroke stroke, Paint fill)	Create a rectangle annotation.
Paint	getFill()	The filling paint (Getter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.DrawingAnnotation

getPaint, getPopup

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupAnnotation

getInfo, getLocked, getReplies

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Annotation

copy, getBoundingBox, getHidden, getId, getNoPrint, getNoRotate, getNoZoom

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static RectangleAnnotation create(Document targetDocument,
                                         Rectangle boundingBox,
                                         Stroke stroke,
                                         Paint fill)

Create a rectangle annotation.

The returned rectangle annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters:

targetDocument - The output document with which the returned object is associated.

boundingBox - The location on the page.

stroke - The stroking parameters used for stroking the rectangle. The stroking paint is used as the annotation's main paint. If null then the rectangle is not stroked.

fill - The paint used for filling the rectangle. If null then the rectangle is not filled.

Returns:

The newly created rectangle annotation.

Throws:

java.lang.IllegalArgumentException - if the targetDocument is null

java.lang.IllegalArgumentException - if the targetDocument is read-only

java.lang.IllegalArgumentException - if the stroke and fill arguments are both null

java.lang.IllegalArgumentException - if the stroke argument is not associated with the targetDocument

java.lang.IllegalArgumentException - if the stroke's pdftoolbox.pdf.content.Stroke.getPaint has a pdftoolbox.pdf.content.Paint.getColorSpace other than a device color space

java.lang.IllegalArgumentException - if the stroke's pdftoolbox.pdf.content.Stroke.getPaint has a non-nullpdftoolbox.pdf.content.Paint.getTransparency with pdftoolbox.pdf.content.Transparency.getBlendMode other than pdftoolbox.pdf.content.BlendMode.NORMAL

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getLineCapStyle is other than pdftoolbox.pdf.content.LineCapStyle.BUTT

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getLineJoinStyle is other than pdftoolbox.pdf.content.LineJoinStyle.MITER

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getMiterLimit is other than 10

java.lang.IllegalArgumentException - if the stroke argument's pdftoolbox.pdf.content.Stroke.getDashPhase is other than 0

java.lang.IllegalArgumentException - if the fill has a pdftoolbox.pdf.content.Paint.getColorSpace other than a device color space

java.lang.IllegalArgumentException - if the fill has a non-nullpdftoolbox.pdf.content.Paint.getTransparency with pdftoolbox.pdf.content.Transparency.getBlendMode other than pdftoolbox.pdf.content.BlendMode.NORMAL

java.lang.IllegalArgumentException - if the fill argument is not associated with the targetDocument

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if boundingBox is null

getFill

public Paint getFill()

The filling paint (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed