com.qoppa.pdf.annotations

Interface Link

All Superinterfaces:

Annotation

public interface Link
extends Annotation

Interface representing a Link annotation in a PDF document. Link annotations are displayed as a rectangle on the PDF document and when clicked, may jump to a different location on the document or open a URL in a browser window. Use setBounds() to set the location and size of the link on the page. Use setActions() to set the actions when the link is activated.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIGHTLIGHT_MODE_INVERT Invert the contents of the annotation rectangle.
static String	HIGHTLIGHT_MODE_NONE No highlighting.
static String	HIGHTLIGHT_MODE_OUTLINE Invert the annotation's border.
static String	HIGHTLIGHT_MODE_PUSH Display the annotation as if it were being pushed below the sur- face of the page.

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Modifier and Type	Method and Description
String	getHighlightMode() Returns the annotation's highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
void	setHighlightMode(String mode) Sets the annotation's highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getContents, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

Field Detail

HIGHTLIGHT_MODE_NONE

static final String HIGHTLIGHT_MODE_NONE

No highlighting.

See Also:

Constant Field Values

HIGHTLIGHT_MODE_INVERT

static final String HIGHTLIGHT_MODE_INVERT

Invert the contents of the annotation rectangle.

See Also:

Constant Field Values

HIGHTLIGHT_MODE_OUTLINE

static final String HIGHTLIGHT_MODE_OUTLINE

Invert the annotation's border.

See Also:

Constant Field Values

HIGHTLIGHT_MODE_PUSH

static final String HIGHTLIGHT_MODE_PUSH

Display the annotation as if it were being pushed below the sur- face of the page.

See Also:

Constant Field Values

Method Detail

setHighlightMode

void setHighlightMode(String mode)

Sets the annotation's highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area. Possible values are:

• Link.HIGHTLIGHT_MODE_NONE
• Link.HIGHTLIGHT_MODE_INVERT (default value)
• Link.HIGHTLIGHT_MODE_OUTLINE
• Link.HIGHTLIGHT_MODE_PUSH

Parameters:

mode - The annotation's highlighting mode.

getHighlightMode

String getHighlightMode()

Returns the annotation's highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area. Possible values are:

• Link.HIGHTLIGHT_MODE_NONE
• Link.HIGHTLIGHT_MODE_INVERT (default value)
• Link.HIGHTLIGHT_MODE_OUTLINE
• Link.HIGHTLIGHT_MODE_PUSH

Returns:

The annotation's highlighting mode.