Package com.pdftools.toolbox.pdf.navigation

Class Link

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.navigation.Link

Direct Known Subclasses:

EmbeddedPdfLink, InternalLink, WebLink

public abstract class Link
extends NativeObject

A link

Method Summary

Modifier and Type	Method	Description
static Link	copy(Document targetDocument, Link link)	Copy a link from an input document to a output document.
QuadrilateralList	getActiveArea()	The link area (Getter)
Rectangle	getBoundingBox()	The location on the page (Getter)
boolean	getHidden()	The link's visibility (Getter)
boolean	getNoPrint()	The link's visibility when printing (Getter)
void	setBorderStyle(Stroke value)	The link's border (Setter)

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

copy

public static Link copy(Document targetDocument,
                        Link link)
                 throws java.io.IOException,
                        ConformanceException

Copy a link from an input document to a output document.

Parameters:

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

link - the link to be copied to the targetDocument

Returns:

the copied link, associated with the targetDocument

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 link is not associated with an input document

java.lang.IllegalArgumentException - if the document associated with the link object has already been closed

ConformanceException - The conformance level of the input document is not compatible with the conformance level of the targetDocument.

java.io.IOException - Error reading from the input document or writing to the output document

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if link is null

getActiveArea

public QuadrilateralList getActiveArea()
                                throws CorruptException

The link area (Getter)

The link is activated when a mouse click falls within the area defined by this list of toolbox.geometry.real.Quadrilaterals.

Throws:

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

CorruptException - if the PDF is corrupt

getBoundingBox

public Rectangle getBoundingBox()
                         throws CorruptException

The location on the page (Getter)

Throws:

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

CorruptException - if the PDF is corrupt

getHidden

public boolean getHidden()

The link's visibility (Getter)

If true then the link is present, but is invisible and not available for user interaction. Depending on the getNoPrint() property it will, however, still be visible when printing.

Throws:

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

getNoPrint

public boolean getNoPrint()

The link's visibility when printing (Getter)

If true then the link is not present in a print output of the document.

Throws:

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

setBorderStyle

public void setBorderStyle(Stroke value)
                    throws UnsupportedFeatureException

The link's border (Setter)

This property defines if and how a rectangular border is drawn for the link.

Throws:

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

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalArgumentException - the given toolbox.pdf.content.Stroke object is associated with a different document

java.lang.IllegalArgumentException - the given toolbox.pdf.content.Stroke object has a toolbox.pdf.content.Stroke.getDashPhase differing from 0

java.lang.IllegalArgumentException - the given toolbox.pdf.content.Stroke object has a toolbox.pdf.content.Stroke.getMiterLimit differing from 10

java.lang.IllegalArgumentException - the given toolbox.pdf.content.Stroke object has a toolbox.pdf.content.Stroke.getLineCapStyle other than toolbox.pdf.content.LineCapStyle.BUTT

java.lang.IllegalArgumentException - the given toolbox.pdf.content.Stroke object has a toolbox.pdf.content.Stroke.getLineJoinStyle other than toolbox.pdf.content.LineJoinStyle.MITER

java.lang.IllegalArgumentException - the given toolbox.pdf.content.Stroke object's toolbox.pdf.content.Stroke.getPaint has a color space other than a device color space, or a calibrated color space.

UnsupportedFeatureException - the given toolbox.pdf.content.Stroke object's toolbox.pdf.content.Stroke.getPaint has a DeviceGray, DeviceCMYK, or CalGray color space.