Package org.jpedal.annotation

Class Caret

java.lang.Object

org.jpedal.annotation.Annotation

org.jpedal.annotation.Markup

org.jpedal.annotation.Caret

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

Defines a Caret annotation.

A caret annotation is a visual symbol that indicates the presence of text edits.

Constructor Summary

Constructors

Constructor	Description
Caret(float[] rect, float[] color)	Create a new Caret annotation.
Caret(float[] rect, int flags, float[] color, float strokingAlpha, float nonStrokingAlpha)	Create a new Caret annotation.
Caret(float[] rect, int flags, String contents, float[] color, float strokingAlpha, float nonStrokingAlpha, String title)	Create a new Caret 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

Caret

public Caret(float[] rect,
 float[] color)

Create a new Caret annotation.

Parameters:

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

color - the color of the annotation

Caret

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

Create a new Caret 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

Caret

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

Create a new Caret 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

title - the text for the title bar

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.