Package org.jpedal.annotation

Class Highlight

java.lang.Object

org.jpedal.annotation.Annotation

org.jpedal.annotation.Markup

org.jpedal.annotation.Highlight

public final class Highlight
extends org.jpedal.annotation.Markup

Defines a Highlight annotation.

Highlights in the text of a document.

Constructor Summary

Constructors

Constructor	Description
Highlight(float[] rect, float[] color, float[] quadPoints)	Create a new Highlight annotation.
Highlight(float[] rect, int flags, float[] color, float strokingAlpha, float nonStrokingAlpha, float[] quadPoints)	Create a new Highlight annotation.
Highlight(float[] rect, int flags, String contents, float[] color, float strokingAlpha, float nonStrokingAlpha, String title, float[] quadPoints)	Create a new Highlight annotation.

Method Summary

Modifier and Type	Method	Description
org.jpedal.io.annotation.utils.AnnotDict	getDict()	Creates the annotation dictionary.

Methods inherited from class org.jpedal.annotation.Annotation

getFlagsValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Highlight

public Highlight(float[] rect,
 float[] color,
 float[] quadPoints)

Create a new Highlight annotation.

Parameters:

rect - two diagonally opposite coordinate points that indicate the annotation's bounding box

color - the color of the annotation

quadPoints - An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order: x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order.

Highlight

public Highlight(float[] rect,
 int flags,
 float[] color,
 float strokingAlpha,
 float nonStrokingAlpha,
 float[] quadPoints)

Create a new Highlight annotation.

Parameters:

rect - two diagonally opposite coordinate points that indicate the annotation's bounding box

flags - the annotation's flags. See Annotation.getFlagsValue(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

color - the color of the annotation

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

quadPoints - An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order: x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order.

Highlight

public Highlight(float[] rect,
 int flags,
 String contents,
 float[] color,
 float strokingAlpha,
 float nonStrokingAlpha,
 String title,
 float[] quadPoints)

Create a new Highlight annotation.

Parameters:

rect - two diagonally opposite coordinate points that indicate the annotation's bounding box

flags - the annotation's flags. See Annotation.getFlagsValue(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

contents - text that shall be displayed or null

color - the color of the annotation

strokingAlpha - the line transparency value

nonStrokingAlpha - the fill transparency value

title - the text for the title bar

quadPoints - An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order: x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four vertices in counterclockwise order.

Method Details

getDict

public org.jpedal.io.annotation.utils.AnnotDict getDict()

Creates the annotation dictionary.

This method is considered as not part of the public API.

Overrides:

getDict in class org.jpedal.annotation.Markup

Returns:

a dictionary containing the relevant entries.