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

Class Underline

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.TextMarkup

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Underline

public class Underline
extends TextMarkup

An text underlining annotation

Method Summary

Modifier and Type	Method	Description
static Underline	createFromQuadrilaterals(Document targetDocument, QuadrilateralList markupArea, Paint paint)	Create a new underline with defined area

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

getMarkupArea, 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

createFromQuadrilaterals

public static Underline createFromQuadrilaterals(Document targetDocument,
                                                 QuadrilateralList markupArea,
                                                 Paint paint)

Create a new underline with defined area

The area to be underlined is defined by the given markupArea. The returned object is associated with the targetDocument but not yet part of any page. It can be added to a page's list of annotations.

Parameters:

targetDocument - The document in which the links is used

markupArea - The area on the page to be underlined.

paint - The paint used for drawing the underline

Returns:

The newly created object

Throws:

java.lang.IllegalArgumentException - if the targetDocument has already been closed

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

java.lang.IllegalArgumentException - if the markupArea is empty

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

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

java.lang.IllegalArgumentException - if the paint argument 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 targetDocument is null

java.lang.IllegalArgumentException - if markupArea is null

java.lang.IllegalArgumentException - if paint is null